@zenstackhq/cli 3.0.0-beta.24 → 3.0.0-beta.26

package/src/actions/seed.ts

@@ -0,0 +1,38 @@
+import colors from 'colors';
+import { execaCommand } from 'execa';
+import { CliError } from '../cli-error';
+import { getPkgJsonConfig } from './action-utils';
+
+type Options = {
+    noWarnings?: boolean;
+    printStatus?: boolean;
+};
+
+/**
+ * CLI action for seeding the database.
+ */
+export async function run(options: Options, args: string[]) {
+    const pkgJsonConfig = getPkgJsonConfig(process.cwd());
+    if (!pkgJsonConfig.seed) {
+        if (!options.noWarnings) {
+            console.warn(colors.yellow('No seed script defined in package.json. Skipping seeding.'));
+        }
+        return;
+    }
+
+    const command = `${pkgJsonConfig.seed}${args.length > 0 ? ' ' + args.join(' ') : ''}`;
+
+    if (options.printStatus) {
+        console.log(colors.gray(`Running seed script "${command}"...`));
+    }
+
+    try {
+        await execaCommand(command, {
+            stdout: 'inherit',
+            stderr: 'inherit',
+        });
+    } catch (err) {
+        console.error(colors.red(err instanceof Error ? err.message : String(err)));
+        throw new CliError('Failed to seed the database. Please check the error message above for details.');
+    }
+}

package/src/index.ts

@@ -34,6 +34,10 @@ const formatAction = async (options: Parameters<typeof actions.format>[0]): Prom
     await telemetry.trackCommand('format', () => actions.format(options));
 };
 
+const seedAction = async (options: Parameters<typeof actions.seed>[0], args: string[]): Promise<void> => {
+    await telemetry.trackCommand('db seed', () => actions.seed(options, args));
+};
+
 function createProgram() {
     const program = new Command('zen')
         .alias('zenstack')
@@ -87,8 +91,13 @@ function createProgram() {
         .addOption(schemaOption)
         .addOption(new Option('--force', 'skip the confirmation prompt'))
         .addOption(migrationsOption)
+        .addOption(new Option('--skip-seed', 'skip seeding the database after reset'))
         .addOption(noVersionCheckOption)
         .description('Reset your database and apply all migrations, all data will be lost')
+        .addHelpText(
+            'after',
+            '\nIf there is a seed script defined in package.json, it will be run after the reset. Use --skip-seed to skip it.',
+        )
         .action((options) => migrateAction('reset', options));
 
     migrateCommand
@@ -128,6 +137,26 @@ function createProgram() {
         .addOption(new Option('--force-reset', 'force a reset of the database before push'))
         .action((options) => dbAction('push', options));
 
+    dbCommand
+        .command('seed')
+        .description('Seed the database')
+        .allowExcessArguments(true)
+        .addHelpText(
+            'after',
+            `
+Seed script is configured under the "zenstack.seed" field in package.json.
+E.g.:
+{
+    "zenstack": {
+        "seed": "ts-node ./zenstack/seed.ts"
+    }
+}
+
+Arguments following -- are passed to the seed script. E.g.: "zen db seed -- --users 10"`,
+        )
+        .addOption(noVersionCheckOption)
+        .action((options, command) => seedAction(options, command.args));
+
     program
         .command('info')
         .description('Get information of installed ZenStack packages')

package/test/db.test.ts

@@ -15,4 +15,47 @@ describe('CLI db commands test', () => {
         runCli('db push', workDir);
         expect(fs.existsSync(path.join(workDir, 'zenstack/dev.db'))).toBe(true);
     });
+
+    it('should seed the database with db seed with seed script', () => {
+        const workDir = createProject(model);
+        const pkgJson = JSON.parse(fs.readFileSync(path.join(workDir, 'package.json'), 'utf8'));
+        pkgJson.zenstack = {
+            seed: 'node seed.js',
+        };
+        fs.writeFileSync(path.join(workDir, 'package.json'), JSON.stringify(pkgJson, null, 2));
+        fs.writeFileSync(
+            path.join(workDir, 'seed.js'),
+            `
+import fs from 'node:fs';
+fs.writeFileSync('seed.txt', 'success');
+        `,
+        );
+
+        runCli('db seed', workDir);
+        expect(fs.readFileSync(path.join(workDir, 'seed.txt'), 'utf8')).toBe('success');
+    });
+
+    it('should seed the database after migrate reset', () => {
+        const workDir = createProject(model);
+        const pkgJson = JSON.parse(fs.readFileSync(path.join(workDir, 'package.json'), 'utf8'));
+        pkgJson.zenstack = {
+            seed: 'node seed.js',
+        };
+        fs.writeFileSync(path.join(workDir, 'package.json'), JSON.stringify(pkgJson, null, 2));
+        fs.writeFileSync(
+            path.join(workDir, 'seed.js'),
+            `
+import fs from 'node:fs';
+fs.writeFileSync('seed.txt', 'success');
+        `,
+        );
+
+        runCli('migrate reset --force', workDir);
+        expect(fs.readFileSync(path.join(workDir, 'seed.txt'), 'utf8')).toBe('success');
+    });
+
+    it('should skip seeding the database without seed script', () => {
+        const workDir = createProject(model);
+        runCli('db seed', workDir);
+    });
 });