chore(core): streamline object helpers (#685)

* bring ensureNestedProperty

* rmv `addProperties`

* expose less & align more

* update lucia

* playwrite

* adapter

* refacto to use overrideProperty & path

* discard one change that is not part

* linting friend

* changeset

* rmv leading comment

* have a way to transform property

* fix naming

* remove unused `removeProperty`

* thx types!

* use `object.create` like syntax

* add transformProperty <3

* pos

* reduce types

* focus object test of object

* check

* playwrite using the latest syntax

* adding another test case

* adding tests for auto adapter

* let's confirm that only the value is changed. YES

* adapter okay

* add propertyNode

* simplify api by removing transformProperty! You want to go raw, use object.properyNode().

* Check import & comments

* ;)

* Opti tests, no need preview when page not requested.

* Revert "Opti tests, no need preview when page not requested."

This reverts commit 52961f0.

---------

Co-authored-by: Manuel Serret <[email protected]>

Author: jycouet

.changeset/eighty-deer-bake.md

@@ -0,0 +1,5 @@
+---
+'sv': patch
+---
+
+chore(core): streamline object helpers

packages/addons/_tests/sveltekit-adapter/test.ts

@@ -16,4 +16,20 @@ test.concurrent.for(kitOnly)('core - %s', async (variant, { page, ...ctx }) => {
 	ctx.onTestFinished(async () => await close());
 
 	expect(await readFile(join(cwd, 'svelte.config.js'), 'utf8')).not.toMatch('adapter-auto');
+	expect(await readFile(join(cwd, 'svelte.config.js'), 'utf8')).not.toMatch(
+		'adapter-auto only supports some environments'
+	);
+});
+
+test.concurrent.for(kitOnly)('core - %s', async (variant, { page, ...ctx }) => {
+	const cwd = await ctx.run(variant, { [addonId]: { adapter: 'auto' } });
+
+	const { close } = await prepareServer({ cwd, page });
+	// kill server process when we're done
+	ctx.onTestFinished(async () => await close());
+
+	expect(await readFile(join(cwd, 'svelte.config.js'), 'utf8')).toMatch('adapter-auto');
+	expect(await readFile(join(cwd, 'svelte.config.js'), 'utf8')).toMatch(
+		'adapter-auto only supports some environments'
+	);
 });

packages/addons/lucia/index.ts

@@ -145,28 +145,20 @@ export default defineAddon({
 					imports: ['sqliteTable', 'text', 'integer']
 				});
 				js.object.overrideProperties(userAttributes, {
-					properties: {
-						id: js.common.parseExpression("text('id').primaryKey()")
-					}
+					id: js.common.parseExpression("text('id').primaryKey()")
 				});
 				if (options.demo) {
 					js.object.overrideProperties(userAttributes, {
-						properties: {
-							username: js.common.parseExpression("text('username').notNull().unique()"),
-							passwordHash: js.common.parseExpression("text('password_hash').notNull()")
-						}
+						username: js.common.parseExpression("text('username').notNull().unique()"),
+						passwordHash: js.common.parseExpression("text('password_hash').notNull()")
 					});
 				}
 				js.object.overrideProperties(sessionAttributes, {
-					properties: {
-						id: js.common.parseExpression("text('id').primaryKey()"),
-						userId: js.common.parseExpression(
-							"text('user_id').notNull().references(() => user.id)"
-						),
-						expiresAt: js.common.parseExpression(
-							"integer('expires_at', { mode: 'timestamp' }).notNull()"
-						)
-					}
+					id: js.common.parseExpression("text('id').primaryKey()"),
+					userId: js.common.parseExpression("text('user_id').notNull().references(() => user.id)"),
+					expiresAt: js.common.parseExpression(
+						"integer('expires_at', { mode: 'timestamp' }).notNull()"
+					)
 				});
 			}
 			if (drizzleDialect === 'mysql') {
@@ -175,30 +167,24 @@ export default defineAddon({
 					imports: ['mysqlTable', 'varchar', 'datetime']
 				});
 				js.object.overrideProperties(userAttributes, {
-					properties: {
-						id: js.common.parseExpression("varchar('id', { length: 255 }).primaryKey()")
-					}
+					id: js.common.parseExpression("varchar('id', { length: 255 }).primaryKey()")
 				});
 				if (options.demo) {
 					js.object.overrideProperties(userAttributes, {
-						properties: {
-							username: js.common.parseExpression(
-								"varchar('username', { length: 32 }).notNull().unique()"
-							),
-							passwordHash: js.common.parseExpression(
-								"varchar('password_hash', { length: 255 }).notNull()"
-							)
-						}
+						username: js.common.parseExpression(
+							"varchar('username', { length: 32 }).notNull().unique()"
+						),
+						passwordHash: js.common.parseExpression(
+							"varchar('password_hash', { length: 255 }).notNull()"
+						)
 					});
 				}
 				js.object.overrideProperties(sessionAttributes, {
-					properties: {
-						id: js.common.parseExpression("varchar('id', { length: 255 }).primaryKey()"),
-						userId: js.common.parseExpression(
-							"varchar('user_id', { length: 255 }).notNull().references(() => user.id)"
-						),
-						expiresAt: js.common.parseExpression("datetime('expires_at').notNull()")
-					}
+					id: js.common.parseExpression("varchar('id', { length: 255 }).primaryKey()"),
+					userId: js.common.parseExpression(
+						"varchar('user_id', { length: 255 }).notNull().references(() => user.id)"
+					),
+					expiresAt: js.common.parseExpression("datetime('expires_at').notNull()")
 				});
 			}
 			if (drizzleDialect === 'postgresql') {
@@ -207,28 +193,20 @@ export default defineAddon({
 					imports: ['pgTable', 'text', 'timestamp']
 				});
 				js.object.overrideProperties(userAttributes, {
-					properties: {
-						id: js.common.parseExpression("text('id').primaryKey()")
-					}
+					id: js.common.parseExpression("text('id').primaryKey()")
 				});
 				if (options.demo) {
 					js.object.overrideProperties(userAttributes, {
-						properties: {
-							username: js.common.parseExpression("text('username').notNull().unique()"),
-							passwordHash: js.common.parseExpression("text('password_hash').notNull()")
-						}
+						username: js.common.parseExpression("text('username').notNull().unique()"),
+						passwordHash: js.common.parseExpression("text('password_hash').notNull()")
 					});
 				}
 				js.object.overrideProperties(sessionAttributes, {
-					properties: {
-						id: js.common.parseExpression("text('id').primaryKey()"),
-						userId: js.common.parseExpression(
-							"text('user_id').notNull().references(() => user.id)"
-						),
-						expiresAt: js.common.parseExpression(
-							"timestamp('expires_at', { withTimezone: true, mode: 'date' }).notNull()"
-						)
-					}
+					id: js.common.parseExpression("text('id').primaryKey()"),
+					userId: js.common.parseExpression("text('user_id').notNull().references(() => user.id)"),
+					expiresAt: js.common.parseExpression(
+						"timestamp('expires_at', { withTimezone: true, mode: 'date' }).notNull()"
+					)
 				});
 			}
 

packages/addons/mdsvex/index.ts

@@ -30,9 +30,8 @@ export default defineAddon({
 				const previousElement = preprocessorArray;
 				preprocessorArray = array.create();
 				array.append(preprocessorArray, previousElement);
-				object.overrideProperty(exportDefault, {
-					name: 'preprocess',
-					value: preprocessorArray
+				object.overrideProperties(exportDefault, {
+					preprocess: preprocessorArray
 				});
 			}
 

packages/addons/playwright/index.ts

@@ -49,26 +49,23 @@ export default defineAddon({
 			const { value: defaultExport } = exports.createDefault(ast, { fallback: defineConfig });
 
 			const config = {
-				webServer: object.create({
+				webServer: {
 					command: 'npm run build && npm run preview',
 					port: 4173
-				}),
-				testDir: common.createLiteral('e2e')
+				},
+				testDir: 'e2e'
 			};
 
 			if (
 				defaultExport.type === 'CallExpression' &&
 				defaultExport.arguments[0]?.type === 'ObjectExpression'
 			) {
 				// uses the `defineConfig` helper
-				imports.addNamed(ast, {
-					from: '@playwright/test',
-					imports: ['defineConfig']
-				});
-				object.addProperties(defaultExport.arguments[0], { properties: config });
+				imports.addNamed(ast, { imports: ['defineConfig'], from: '@playwright/test' });
+				object.overrideProperties(defaultExport.arguments[0], config);
 			} else if (defaultExport.type === 'ObjectExpression') {
-				// if the config is just an object expression, just add the property
-				object.addProperties(defaultExport, { properties: config });
+				// if the config is just an object expression, just add the properties
+				object.overrideProperties(defaultExport, config);
 			} else {
 				// unexpected config shape
 				log.warn('Unexpected playwright config for playwright add-on. Could not update.');

packages/addons/sveltekit-adapter/index.ts

@@ -1,5 +1,5 @@
 import { defineAddon, defineAddonOptions } from '@sveltejs/cli-core';
-import { exports, functions, imports, object, type AstTypes } from '@sveltejs/cli-core/js';
+import { exports, functions, imports, object } from '@sveltejs/cli-core/js';
 import { parseJson, parseScript } from '@sveltejs/cli-core/parsers';
 
 const adapters = [
@@ -74,33 +74,20 @@ export default defineAddon({
 			}
 
 			const { value: config } = exports.createDefault(ast, { fallback: object.create({}) });
-			const kitConfig = config.properties.find(
-				(p) => p.type === 'Property' && p.key.type === 'Identifier' && p.key.name === 'kit'
-			) as AstTypes.Property | undefined;
 
-			if (kitConfig && kitConfig.value.type === 'ObjectExpression') {
-				const adapterProp = kitConfig.value.properties.find(
-					(p) => p.type === 'Property' && p.key.type === 'Identifier' && p.key.name === 'adapter'
-				);
-				if (adapterProp) {
-					adapterProp.leadingComments = [];
+			// override the adapter property
+			object.overrideProperties(config, {
+				kit: {
+					adapter: functions.createCall({ name: adapterName, args: [], useIdentifiers: true })
 				}
+			});
 
-				// only overrides the `adapter` property so we can reset it's args
-				object.overrideProperties(kitConfig.value, {
-					properties: {
-						adapter: functions.createCall({ name: adapterName, args: [], useIdentifiers: true })
-					}
-				});
-			} else {
-				// creates the `kit` property when absent
-				object.addProperties(config, {
-					properties: {
-						kit: object.create({
-							adapter: functions.createCall({ name: adapterName, args: [], useIdentifiers: true })
-						})
-					}
-				});
+			// reset the comment for non-auto adapters
+			if (adapter.package !== '@sveltejs/adapter-auto') {
+				const fallback = object.create({});
+				const cfgKitValue = object.property(config, { name: 'kit', fallback });
+				const cfgAdapter = object.propertyNode(cfgKitValue, { name: 'adapter', fallback });
+				cfgAdapter.leadingComments = [];
 			}
 
 			return generateCode();

packages/core/tests/js/object/ensure-nested-property/input.ts

@@ -0,0 +1,6 @@
+const test = {
+	a: {
+		/** a comment */
+		keep: 'me'
+	}
+};

packages/core/tests/js/object/ensure-nested-property/output.ts

@@ -0,0 +1 @@
+const test = { a: { /** a comment */ keep: 'you', b: { c: '007' } } };

packages/core/tests/js/object/ensure-nested-property/run.ts

@@ -0,0 +1,14 @@
+import { object, type AstTypes } from '@sveltejs/cli-core/js';
+import { getTestObjectExpression } from '../objectTestHelper.ts';
+
+export function run(ast: AstTypes.Program): void {
+	const obj = getTestObjectExpression(ast);
+
+	object.overrideProperties(obj, {
+		a: { b: { c: '007' } }
+	});
+
+	object.overrideProperties(obj, {
+		a: { keep: 'you' }
+	});
+}

packages/core/tests/js/object/remove-property/run.ts renamed to packages/core/tests/js/object/objectTestHelper.ts

@@ -1,13 +1,14 @@
 import { variables, object, type AstTypes } from '@sveltejs/cli-core/js';
 
-export function run(ast: AstTypes.Program): void {
+export const getTestObjectExpression = (ast: AstTypes.Program): AstTypes.ObjectExpression => {
 	const variable = variables.declaration(ast, {
 		kind: 'const',
 		name: 'test',
 		value: object.create({})
 	});
+
 	const objectDeclarator = variable.declarations[0] as AstTypes.VariableDeclarator;
 	const objectExpression = objectDeclarator.init as AstTypes.ObjectExpression;
-	object.removeProperty(objectExpression, { name: 'foo' });
-	object.removeProperty(objectExpression, { name: 'bar' });
-}
+
+	return objectExpression;
+};