Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: generate drivers meta #136

Merged
merged 5 commits into from
Jan 24, 2025
Merged

Conversation

sandros94
Copy link
Contributor

Following the concept from unjs/unstorage#526

This PR introduces a Auto-generate meta data for builtinConnectors, BuiltinConnectorName and BuiltinConnectorOptions with consistent kebab-case + camelCase variants to all exports.

Another change in this PR is that it fixes a missing type export for mysql2 and planetscale

Details
// Auto-generated using scripts/gen-connectors.
// Do not manually edit!

import type { ConnectorOptions as BetterSqlite3Options } from "db0/connectors/better-sqlite3";
import type { ConnectorOptions as BunOptions } from "db0/connectors/bun-sqlite";
import type { ConnectorOptions as CloudflareD1Options } from "db0/connectors/cloudflare-d1";
import type { ConnectorOptions as LibsqlCoreOptions } from "db0/connectors/libsql/core";
import type { ConnectorOptions as LibsqlHttpOptions } from "db0/connectors/libsql/http";
import type { ConnectorOptions as LibsqlOptions } from "db0/connectors/libsql/node";
import type { ConnectorOptions as LibsqlWebOptions } from "db0/connectors/libsql/web";
import type { ConnectorOptions as Mysql2Options } from "db0/connectors/mysql2";
import type { ConnectorOptions as PgliteOptions } from "db0/connectors/pglite";
import type { ConnectorOptions as PlanetscaleOptions } from "db0/connectors/planetscale";
import type { ConnectorOptions as PostgresqlOptions } from "db0/connectors/postgresql";

export type BuiltinConnectorName = "better-sqlite3" | "betterSqlite3" | "bun-sqlite" | "bun" | "cloudflare-d1" | "cloudflareD1" | "libsql-core" | "libsqlCore" | "libsql-http" | "libsqlHttp" | "libsql-node" | "libsql" | "libsql-web" | "libsqlWeb" | "mysql2" | "pglite" | "planetscale" | "postgresql";

export type BuiltinConnectorOptions = {
  "better-sqlite3": BetterSqlite3Options;
  "betterSqlite3": BetterSqlite3Options;
  "bun-sqlite": BunOptions;
  "bun": BunOptions;
  "cloudflare-d1": CloudflareD1Options;
  "cloudflareD1": CloudflareD1Options;
  "libsql-core": LibsqlCoreOptions;
  "libsqlCore": LibsqlCoreOptions;
  "libsql-http": LibsqlHttpOptions;
  "libsqlHttp": LibsqlHttpOptions;
  "libsql-node": LibsqlOptions;
  "libsql": LibsqlOptions;
  "libsql-web": LibsqlWebOptions;
  "libsqlWeb": LibsqlWebOptions;
  "mysql2": Mysql2Options;
  "pglite": PgliteOptions;
  "planetscale": PlanetscaleOptions;
  "postgresql": PostgresqlOptions;
};

export const builtinConnectors = {
  "better-sqlite3": "db0/connectors/better-sqlite3",
  "betterSqlite3": "db0/connectors/better-sqlite3",
  "bun-sqlite": "db0/connectors/bun-sqlite",
  "bun": "db0/connectors/bun-sqlite",
  "cloudflare-d1": "db0/connectors/cloudflare-d1",
  "cloudflareD1": "db0/connectors/cloudflare-d1",
  "libsql-core": "db0/connectors/libsql/core",
  "libsqlCore": "db0/connectors/libsql/core",
  "libsql-http": "db0/connectors/libsql/http",
  "libsqlHttp": "db0/connectors/libsql/http",
  "libsql-node": "db0/connectors/libsql/node",
  "libsql": "db0/connectors/libsql/node",
  "libsql-web": "db0/connectors/libsql/web",
  "libsqlWeb": "db0/connectors/libsql/web",
  "mysql2": "db0/connectors/mysql2",
  "pglite": "db0/connectors/pglite",
  "planetscale": "db0/connectors/planetscale",
  "postgresql": "db0/connectors/postgresql",
} as const;

Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks ❤️

@pi0 pi0 merged commit 5e555fb into unjs:main Jan 24, 2025
2 checks passed
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

Attention: Patch coverage is 3.09278% with 94 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@37d2d3c). Learn more about missing BASE report.

Files with missing lines Patch % Lines
scripts/gen-connectors.ts 0.00% 77 Missing and 1 partial ⚠️
src/_connectors.ts 5.88% 16 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #136   +/-   ##
=======================================
  Coverage        ?   39.14%           
=======================================
  Files           ?       21           
  Lines           ?      751           
  Branches        ?       68           
=======================================
  Hits            ?      294           
  Misses          ?      451           
  Partials        ?        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sandros94 sandros94 deleted the build-generate-drivers-meta branch January 24, 2025 21:11
pi0 added a commit that referenced this pull request Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants