Skip to content

chore: allow passing an array of import names to imports.addNamed #639

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/rare-snakes-tickle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'sv': patch
---

chore: allow passing an array of import names to imports.addNamed
35 changes: 12 additions & 23 deletions packages/addons/drizzle/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -239,10 +239,7 @@ export default defineAddon({
if (options.database === 'sqlite') {
imports.addNamed(ast, {
from: 'drizzle-orm/sqlite-core',
imports: {
sqliteTable: 'sqliteTable',
integer: 'integer'
}
imports: ['sqliteTable', 'integer']
});

userSchemaExpression = common.parseExpression(`sqliteTable('user', {
Expand All @@ -253,11 +250,7 @@ export default defineAddon({
if (options.database === 'mysql') {
imports.addNamed(ast, {
from: 'drizzle-orm/mysql-core',
imports: {
mysqlTable: 'mysqlTable',
serial: 'serial',
int: 'int'
}
imports: ['mysqlTable', 'serial', 'int']
});

userSchemaExpression = common.parseExpression(`mysqlTable('user', {
Expand All @@ -268,11 +261,7 @@ export default defineAddon({
if (options.database === 'postgresql') {
imports.addNamed(ast, {
from: 'drizzle-orm/pg-core',
imports: {
pgTable: 'pgTable',
serial: 'serial',
integer: 'integer'
}
imports: ['pgTable', 'serial', 'integer']
});

userSchemaExpression = common.parseExpression(`pgTable('user', {
Expand Down Expand Up @@ -300,7 +289,7 @@ export default defineAddon({

imports.addNamed(ast, {
from: '$env/dynamic/private',
imports: { env: 'env' }
imports: ['env']
});
imports.addNamespace(ast, { from: './schema', as: 'schema' });

Expand All @@ -316,25 +305,25 @@ export default defineAddon({
imports.addDefault(ast, { from: 'better-sqlite3', as: 'Database' });
imports.addNamed(ast, {
from: 'drizzle-orm/better-sqlite3',
imports: { drizzle: 'drizzle' }
imports: ['drizzle']
});

clientExpression = common.parseExpression('new Database(env.DATABASE_URL)');
}
if (options.sqlite === 'libsql' || options.sqlite === 'turso') {
imports.addNamed(ast, {
from: '@libsql/client',
imports: { createClient: 'createClient' }
imports: ['createClient']
});
imports.addNamed(ast, {
from: 'drizzle-orm/libsql',
imports: { drizzle: 'drizzle' }
imports: ['drizzle']
});

if (options.sqlite === 'turso') {
imports.addNamed(ast, {
from: '$app/environment',
imports: { dev: 'dev' }
imports: ['dev']
});
// auth token check in prod
const authTokenCheck = common.parseStatement(
Expand All @@ -354,7 +343,7 @@ export default defineAddon({
imports.addDefault(ast, { from: 'mysql2/promise', as: 'mysql' });
imports.addNamed(ast, {
from: 'drizzle-orm/mysql2',
imports: { drizzle: 'drizzle' }
imports: ['drizzle']
});

clientExpression = common.parseExpression('mysql.createPool(env.DATABASE_URL)');
Expand All @@ -363,11 +352,11 @@ export default defineAddon({
if (options.postgresql === 'neon') {
imports.addNamed(ast, {
from: '@neondatabase/serverless',
imports: { neon: 'neon' }
imports: ['neon']
});
imports.addNamed(ast, {
from: 'drizzle-orm/neon-http',
imports: { drizzle: 'drizzle' }
imports: ['drizzle']
});

clientExpression = common.parseExpression('neon(env.DATABASE_URL)');
Expand All @@ -376,7 +365,7 @@ export default defineAddon({
imports.addDefault(ast, { from: 'postgres', as: 'postgres' });
imports.addNamed(ast, {
from: 'drizzle-orm/postgres-js',
imports: { drizzle: 'drizzle' }
imports: ['drizzle']
});

clientExpression = common.parseExpression('postgres(env.DATABASE_URL)');
Expand Down
4 changes: 2 additions & 2 deletions packages/addons/eslint/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,13 @@ export default defineAddon({
common.addJsDocTypeComment(astNode, { type: "import('eslint').Linter.Config[]" });

if (typescript) imports.addDefault(ast, { from: 'typescript-eslint', as: 'ts' });
imports.addNamed(ast, { from: 'node:url', imports: { fileURLToPath: 'fileURLToPath' } });
imports.addNamed(ast, { from: 'node:url', imports: ['fileURLToPath'] });
imports.addDefault(ast, { from: 'globals', as: 'globals' });
imports.addDefault(ast, { from: 'eslint-plugin-svelte', as: 'svelte' });
imports.addDefault(ast, { from: '@eslint/js', as: 'js' });
imports.addNamed(ast, {
from: '@eslint/compat',
imports: { includeIgnoreFile: 'includeIgnoreFile' }
imports: ['includeIgnoreFile']
});

return generateCode();
Expand Down
31 changes: 8 additions & 23 deletions packages/addons/lucia/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,7 @@ export default defineAddon({
if (drizzleDialect === 'sqlite' || drizzleDialect === 'turso') {
js.imports.addNamed(ast, {
from: 'drizzle-orm/sqlite-core',
imports: {
sqliteTable: 'sqliteTable',
text: 'text',
integer: 'integer'
}
imports: ['sqliteTable', 'text', 'integer']
});
js.object.overrideProperties(userAttributes, {
properties: {
Expand Down Expand Up @@ -176,11 +172,7 @@ export default defineAddon({
if (drizzleDialect === 'mysql') {
js.imports.addNamed(ast, {
from: 'drizzle-orm/mysql-core',
imports: {
mysqlTable: 'mysqlTable',
varchar: 'varchar',
datetime: 'datetime'
}
imports: ['mysqlTable', 'varchar', 'datetime']
});
js.object.overrideProperties(userAttributes, {
properties: {
Expand Down Expand Up @@ -212,11 +204,7 @@ export default defineAddon({
if (drizzleDialect === 'postgresql') {
js.imports.addNamed(ast, {
from: 'drizzle-orm/pg-core',
imports: {
pgTable: 'pgTable',
text: 'text',
timestamp: 'timestamp'
}
imports: ['pgTable', 'text', 'timestamp']
});
js.object.overrideProperties(userAttributes, {
properties: {
Expand Down Expand Up @@ -260,20 +248,17 @@ export default defineAddon({
const { ast, generateCode } = parseScript(content);

js.imports.addNamespace(ast, { from: '$lib/server/db/schema', as: 'table' });
js.imports.addNamed(ast, { from: '$lib/server/db', imports: { db: 'db' } });
js.imports.addNamed(ast, { from: '$lib/server/db', imports: ['db'] });
js.imports.addNamed(ast, {
from: '@oslojs/encoding',
imports: {
encodeBase64url: 'encodeBase64url',
encodeHexLowerCase: 'encodeHexLowerCase'
}
imports: ['encodeBase64url', 'encodeHexLowerCase']
});
js.imports.addNamed(ast, { from: '@oslojs/crypto/sha2', imports: { sha256: 'sha256' } });
js.imports.addNamed(ast, { from: 'drizzle-orm', imports: { eq: 'eq' } });
js.imports.addNamed(ast, { from: '@oslojs/crypto/sha2', imports: ['sha256'] });
js.imports.addNamed(ast, { from: 'drizzle-orm', imports: ['eq'] });
if (typescript) {
js.imports.addNamed(ast, {
from: '@sveltejs/kit',
imports: { RequestEvent: 'RequestEvent' },
imports: ['RequestEvent'],
isType: true
});
}
Expand Down
2 changes: 1 addition & 1 deletion packages/addons/mdsvex/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default defineAddon({
sv.file('svelte.config.js', (content) => {
const { ast, generateCode } = parseScript(content);

imports.addNamed(ast, { from: 'mdsvex', imports: { mdsvex: 'mdsvex' } });
imports.addNamed(ast, { from: 'mdsvex', imports: ['mdsvex'] });

const { value: exportDefault } = exports.createDefault(ast, {
fallback: object.create({})
Expand Down
17 changes: 7 additions & 10 deletions packages/addons/paraglide/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export default defineAddon({
const vitePluginName = 'paraglideVitePlugin';
imports.addNamed(ast, {
from: '@inlang/paraglide-js',
imports: { paraglideVitePlugin: vitePluginName }
imports: [vitePluginName]
});
const { value: rootObject } = exports.createDefault(ast, {
fallback: functions.createCall({ name: 'defineConfig', args: [] })
Expand All @@ -123,7 +123,7 @@ export default defineAddon({
const { ast, generateCode } = parseScript(content);
imports.addNamed(ast, {
from: '$lib/paraglide/runtime',
imports: { deLocalizeUrl: 'deLocalizeUrl' }
imports: ['deLocalizeUrl']
});

const expression = common.parseExpression('(request) => deLocalizeUrl(request.url).pathname');
Expand All @@ -149,7 +149,7 @@ export default defineAddon({
const { ast, generateCode } = parseScript(content);
imports.addNamed(ast, {
from: '$lib/paraglide/server',
imports: { paraglideMiddleware: 'paraglideMiddleware' }
imports: ['paraglideMiddleware']
});

const hookHandleContent = `({ event, resolve }) => paraglideMiddleware(event.request, ({ request, locale }) => {
Expand Down Expand Up @@ -206,13 +206,10 @@ export default defineAddon({
// add usage example
sv.file(`${kit.routesDirectory}/demo/paraglide/+page.svelte`, (content) => {
const { script, template, generateCode } = parseSvelte(content, { typescript });
imports.addNamed(script.ast, { from: '$lib/paraglide/messages.js', imports: { m: 'm' } });
imports.addNamed(script.ast, { from: '$app/navigation', imports: { goto: 'goto' } });
imports.addNamed(script.ast, { from: '$app/state', imports: { page: 'page' } });
imports.addNamed(script.ast, {
from: '$lib/paraglide/runtime',
imports: { setLocale: 'setLocale' }
});
imports.addNamed(script.ast, { from: '$lib/paraglide/messages.js', imports: ['m'] });
imports.addNamed(script.ast, { from: '$app/navigation', imports: ['goto'] });
imports.addNamed(script.ast, { from: '$app/state', imports: ['page'] });
imports.addNamed(script.ast, { from: '$lib/paraglide/runtime', imports: ['setLocale'] });

const scriptCode = new MagicString(script.generateCode());

Expand Down
2 changes: 1 addition & 1 deletion packages/addons/playwright/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export default defineAddon({
// uses the `defineConfig` helper
imports.addNamed(ast, {
from: '@playwright/test',
imports: { defineConfig: 'defineConfig' }
imports: ['defineConfig']
});
object.addProperties(defaultExport.arguments[0], { properties: config });
} else if (defaultExport.type === 'ObjectExpression') {
Expand Down
2 changes: 2 additions & 0 deletions packages/core/tests/js/imports/named-import-array/output.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import { Handle } from '@sveltejs/kit';
import { namedOne } from 'package';
9 changes: 9 additions & 0 deletions packages/core/tests/js/imports/named-import-array/run.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { imports, type AstTypes } from '@sveltejs/cli-core/js';

export function run(ast: AstTypes.Program): void {
imports.addNamed(ast, { from: 'package', imports: ['namedOne'], isType: false });

imports.addNamed(ast, { from: '@sveltejs/kit', imports: ['Handle'], isType: false });
// adding the same import twice should not produce two imports
imports.addNamed(ast, { from: '@sveltejs/kit', imports: ['Handle'], isType: false });
}
1 change: 1 addition & 0 deletions packages/core/tests/js/imports/named-import/output.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
import { foo as bar, baz } from 'xyz';
import { Handle } from '@sveltejs/kit';
import { namedOne } from 'package';
2 changes: 2 additions & 0 deletions packages/core/tests/js/imports/named-import/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ export function run(ast: AstTypes.Program): void {
imports.addNamed(ast, { from: '@sveltejs/kit', imports: { Handle: 'Handle' }, isType: false });
// adding the same import twice should not produce two imports
imports.addNamed(ast, { from: '@sveltejs/kit', imports: { Handle: 'Handle' }, isType: false });

imports.addNamed(ast, { from: 'xyz', imports: { foo: 'bar', baz: 'baz' } });
}
8 changes: 6 additions & 2 deletions packages/core/tooling/js/imports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,15 @@ export function addNamed(
node: AstTypes.Program,
options: {
from: string;
imports: Record<string, string>;
imports: Record<string, string> | string[];
isType?: boolean;
}
): void {
const specifiers = Object.entries(options.imports).map(([key, value]) => {
const o_imports = Array.isArray(options.imports)
? Object.fromEntries(options.imports.map((n) => [n, n]))
: options.imports;

const specifiers = Object.entries(o_imports).map(([key, value]) => {
const specifier: AstTypes.ImportSpecifier = {
type: 'ImportSpecifier',
imported: {
Expand Down
Loading