Merge branch 'main' into feat/addons-as-args

Author: AdrianGonz97

CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# SV Contributing Guide
+
+## Workflow
+
+We follow the standard fork-based workflow:
+
+1. **Fork** this repository to your GitHub account.
+2. **Clone** your fork locally.
+3. **Create a new branch** for your change:  
+   `git checkout -b your-feature-name`
+4. **Commit and push** your changes to your branch.
+5. **Open a pull request** from your branch to the `main` branch of this repository.
+
+Please keep your pull requests focused to feature or issue. Focused smaller changes are easier to review and faster to merge.
+
+## Preparing
+This is a monorepo, meaning the repo holds multiple packages. It requires the use of [pnpm](https://pnpm.io/). You can [install pnpm](https://pnpm.io/installation) with:
+
+```bash
+npm i -g pnpm
+```
+
+For running certain packages and tests locally you will need to install [docker](https://docs.docker.com/get-started/get-docker).
+Linux users, you will have to ensure 'sudo' is not required. See [docker post install](https://docs.docker.com/engine/install/linux-postinstall/)
+
+`pnpm` commands run in the project's root directory will run on all sub-projects. You can checkout the code and install the dependencies with:
+
+```bash
+cd cli
+pnpm install
+```
+
+## Build and run
+To build the project and all packages. Run the 'build' script:
+
+```bash
+# from root of project
+pnpm build
+```
+This outputs into /packages/PACKAGE/dist/.
+
+Run the 'cli' package:
+```bash
+pnpm sv
+```
+
+Run build with watch mode:
+```bash
+pnpm dev
+```
+
+## Testing
+
+For each add-on we have integration tests setup. These install the deps, build the app, run the dev server and then run a few small snippets against the add-on to see if the changes introduced by the add-on are working as expected.
+
+Run all tests:
+```bash
+# from root of project
+pnpm test
+```
+
+Run tests with vitest ui:
+```bash
+# from root of project
+pnpm test:ui
+```
+
+Run package specific tests by specifying a project flag to the package and running the test command. Eg:
+```bash
+pnpm test --project core # addons / create / migrate / etc.
+```
+
+To run a individual test. `cd` into the package. Run the local `test` script to that package, with a path arg to the individual peice you want tested. Eg:
+```bash
+pnpm test [path-to-test]
+```
+
+To debug a failing test. A good starting point is to `cd` into the failing tests dir. Proceed to `build` it. Then `preview` it. From here you will have increased information to help in the debug process. Eg:
+```bash
+# Each test is a standalone app
+cd .test-output/addons/[addon-test]/[test-id]
+pnpm build
+pnpm preview
+```
+
+## Style Guide
+
+### Coding style
+
+There are a few guidelines we follow:
+
+- Ensure `pnpm lint` and `pnpm check` pass. You can run `pnpm format` to format the code
+- linting
+```bash
+# from root of project
+pnpm lint
+```
+- formatting
+```bash
+# from root of project
+pnpm format
+```
+- type checking
+```bash
+# from root of project
+pnpm check
+```
+
+## svelte-migrate
+To run svelte-migrate locally:
+```bash
+# from root of project
+node ./packages/migrate/bin.js 
+```
+
+## Generating changelogs
+Only publish a change set if it is in 'sv' or 'svelte-migrate' as all other packages are bundled. 
+For changes to be reflected in package changelogs:
+```bash
+# from root of project
+pnpm changeset:publish
+```

packages/addons/_tests/drizzle/test.ts

@@ -43,7 +43,7 @@ test.concurrent.for(testCases)(
 
 		const ts = variant === 'kit-ts';
 		const drizzleConfig = path.resolve(cwd, `drizzle.config.${ts ? 'ts' : 'js'}`);
-		const content = fs.readFileSync(drizzleConfig, 'utf8').replace('strict: true,', '');
+		const content = fs.readFileSync(drizzleConfig, 'utf8').replace(/strict: true[,\s]/, '');
 		fs.writeFileSync(drizzleConfig, content, 'utf8');
 
 		const routes = path.resolve(cwd, 'src', 'routes');

packages/addons/drizzle/index.ts

@@ -1,3 +1,5 @@
+import fs from 'node:fs';
+import path from 'node:path';
 import { common, exports, functions, imports, object, variables } from '@sveltejs/cli-core/js';
 import { defineAddon, defineAddonOptions, dedent, type OptionValues } from '@sveltejs/cli-core';
 import { parseJson, parseScript } from '@sveltejs/cli-core/parsers';
@@ -69,8 +71,21 @@ export default defineAddon({
 	shortDescription: 'database orm',
 	homepage: 'https://orm.drizzle.team',
 	options,
-	setup: ({ kit, unsupported }) => {
+	setup: ({ kit, unsupported, cwd, typescript }) => {
+		const ext = typescript ? 'ts' : 'js';
 		if (!kit) unsupported('Requires SvelteKit');
+
+		const baseDBPath = path.resolve(kit!.libDirectory, 'server', 'db');
+		const paths = {
+			'drizzle config': path.relative(cwd, path.resolve(cwd, `drizzle.config.${ext}`)),
+			'database schema': path.relative(cwd, path.resolve(baseDBPath, `schema.${ext}`)),
+			database: path.relative(cwd, path.resolve(baseDBPath, `index.${ext}`))
+		};
+		for (const [fileType, filePath] of Object.entries(paths)) {
+			if (fs.existsSync(filePath)) {
+				unsupported(`Preexisting ${fileType} file at '${filePath}'`);
+			}
+		}
 	},
 	run: ({ sv, typescript, options, kit }) => {
 		const ext = typescript ? 'ts' : 'js';
@@ -178,41 +193,27 @@ export default defineAddon({
 
 			imports.addNamed(ast, 'drizzle-kit', { defineConfig: 'defineConfig' });
 
-			const envCheckStatement = common.statementFromString(
-				"if (!process.env.DATABASE_URL) throw new Error('DATABASE_URL is not set');"
+			common.addStatement(
+				ast,
+				common.statementFromString(
+					"if (!process.env.DATABASE_URL) throw new Error('DATABASE_URL is not set');"
+				)
 			);
-			common.addStatement(ast, envCheckStatement);
-
-			const fallback = common.expressionFromString('defineConfig({})');
-			const { value: exportDefault } = exports.defaultExport(ast, fallback);
-			if (exportDefault.type !== 'CallExpression') return content;
-
-			const objExpression = exportDefault.arguments?.[0];
-			if (!objExpression || objExpression.type !== 'ObjectExpression') return content;
-
-			const authToken =
-				options.sqlite === 'turso'
-					? common.expressionFromString('process.env.DATABASE_AUTH_TOKEN')
-					: undefined;
-
-			object.properties(objExpression, {
-				schema: common.createLiteral(`./src/lib/server/db/schema.${typescript ? 'ts' : 'js'}`),
-				dbCredentials: object.create({
-					url: common.expressionFromString('process.env.DATABASE_URL'),
-					authToken
-				}),
-				verbose: { type: 'Literal', value: true },
-				strict: { type: 'Literal', value: true }
-			});
-
-			const dialect = options.sqlite === 'turso' ? 'turso' : options.database;
-			object.overrideProperties(objExpression, {
-				dialect: common.createLiteral(dialect)
-			});
 
-			// The `driver` property is only required for _some_ sqlite DBs.
-			// We'll need to remove it if it's anything but sqlite
-			if (options.database !== 'sqlite') object.removeProperty(objExpression, 'driver');
+			exports.defaultExport(
+				ast,
+				common.expressionFromString(`
+					defineConfig({
+						schema: "./src/lib/server/db/schema.${typescript ? 'ts' : 'js'}",
+						dialect: "${options.sqlite === 'turso' ? 'turso' : options.database}",
+						dbCredentials: {
+							${options.sqlite === 'turso' ? 'authToken: process.env.DATABASE_AUTH_TOKEN,' : ''}
+							url: process.env.DATABASE_URL
+						},
+						verbose: true,
+						strict: true
+					})`)
+			);
 
 			return generateCode();
 		});