@nexical/cli 0.10.0 → 0.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/.github/workflows/deploy.yml +1 -1
  2. package/.husky/pre-commit +1 -0
  3. package/.prettierignore +8 -0
  4. package/.prettierrc +7 -0
  5. package/GEMINI.md +199 -0
  6. package/README.md +85 -56
  7. package/dist/chunk-AC4B3HPJ.js +93 -0
  8. package/dist/chunk-AC4B3HPJ.js.map +1 -0
  9. package/dist/{chunk-JYASTIIW.js → chunk-PJIOCW2A.js} +1 -1
  10. package/dist/chunk-PJIOCW2A.js.map +1 -0
  11. package/dist/{chunk-WKERTCM6.js → chunk-Q7YLW5HJ.js} +5 -2
  12. package/dist/chunk-Q7YLW5HJ.js.map +1 -0
  13. package/dist/index.js +41 -12
  14. package/dist/index.js.map +1 -1
  15. package/dist/src/commands/init.d.ts +4 -1
  16. package/dist/src/commands/init.js +15 -10
  17. package/dist/src/commands/init.js.map +1 -1
  18. package/dist/src/commands/module/add.d.ts +3 -1
  19. package/dist/src/commands/module/add.js +27 -16
  20. package/dist/src/commands/module/add.js.map +1 -1
  21. package/dist/src/commands/module/list.js +9 -5
  22. package/dist/src/commands/module/list.js.map +1 -1
  23. package/dist/src/commands/module/remove.d.ts +3 -1
  24. package/dist/src/commands/module/remove.js +13 -7
  25. package/dist/src/commands/module/remove.js.map +1 -1
  26. package/dist/src/commands/module/update.d.ts +3 -1
  27. package/dist/src/commands/module/update.js +7 -5
  28. package/dist/src/commands/module/update.js.map +1 -1
  29. package/dist/src/commands/run.d.ts +4 -1
  30. package/dist/src/commands/run.js +10 -2
  31. package/dist/src/commands/run.js.map +1 -1
  32. package/dist/src/commands/setup.d.ts +8 -0
  33. package/dist/src/commands/setup.js +75 -0
  34. package/dist/src/commands/setup.js.map +1 -0
  35. package/dist/src/utils/discovery.js +1 -1
  36. package/dist/src/utils/git.js +1 -1
  37. package/dist/src/utils/url-resolver.js +1 -1
  38. package/eslint.config.mjs +67 -0
  39. package/index.ts +34 -20
  40. package/package.json +57 -33
  41. package/src/commands/init.ts +79 -75
  42. package/src/commands/module/add.ts +158 -148
  43. package/src/commands/module/list.ts +61 -50
  44. package/src/commands/module/remove.ts +59 -54
  45. package/src/commands/module/update.ts +44 -42
  46. package/src/commands/run.ts +89 -81
  47. package/src/commands/setup.ts +92 -0
  48. package/src/utils/discovery.ts +98 -113
  49. package/src/utils/git.ts +35 -28
  50. package/src/utils/url-resolver.ts +50 -45
  51. package/test/e2e/lifecycle.e2e.test.ts +139 -130
  52. package/test/integration/commands/init.integration.test.ts +64 -61
  53. package/test/integration/commands/module.integration.test.ts +122 -122
  54. package/test/integration/commands/run.integration.test.ts +70 -63
  55. package/test/integration/utils/command-loading.integration.test.ts +40 -53
  56. package/test/unit/commands/init.test.ts +163 -128
  57. package/test/unit/commands/module/add.test.ts +312 -245
  58. package/test/unit/commands/module/list.test.ts +108 -91
  59. package/test/unit/commands/module/remove.test.ts +74 -67
  60. package/test/unit/commands/module/update.test.ts +74 -70
  61. package/test/unit/commands/run.test.ts +253 -201
  62. package/test/unit/commands/setup.test.ts +187 -0
  63. package/test/unit/utils/command-discovery.test.ts +138 -125
  64. package/test/unit/utils/git.test.ts +135 -117
  65. package/test/unit/utils/integration-helpers.test.ts +59 -49
  66. package/test/unit/utils/url-resolver.test.ts +46 -34
  67. package/test/utils/integration-helpers.ts +36 -29
  68. package/tsconfig.json +15 -25
  69. package/tsup.config.ts +14 -14
  70. package/vitest.config.ts +10 -10
  71. package/vitest.e2e.config.ts +6 -6
  72. package/vitest.integration.config.ts +17 -17
  73. package/dist/chunk-JYASTIIW.js.map +0 -1
  74. package/dist/chunk-OKXOCNXP.js +0 -105
  75. package/dist/chunk-OKXOCNXP.js.map +0 -1
  76. package/dist/chunk-WKERTCM6.js.map +0 -1
@@ -4,71 +4,76 @@ import path from 'path';
4
4
  import YAML from 'yaml';
5
5
 
6
6
  export default class ModuleRemoveCommand extends BaseCommand {
7
- static usage = 'module remove <name>';
8
- static description = 'Remove an installed module.';
9
- static requiresProject = true;
7
+ static usage = 'module remove <name>';
8
+ static description = 'Remove an installed module.';
9
+ static requiresProject = true;
10
10
 
11
- static args: CommandDefinition = {
12
- args: [
13
- { name: 'name', required: true, description: 'Name of the module to remove' }
14
- ]
15
- };
11
+ static args: CommandDefinition = {
12
+ args: [{ name: 'name', required: true, description: 'Name of the module to remove' }],
13
+ };
16
14
 
17
- async run(options: any) {
18
- const projectRoot = this.projectRoot as string;
19
- let { name } = options;
15
+ async run(options: { name: string }) {
16
+ const projectRoot = this.projectRoot as string;
17
+ const { name } = options;
20
18
 
21
- const relativePath = `modules/${name}`;
22
- const fullPath = path.resolve(projectRoot, relativePath);
19
+ const relativePath = `modules/${name}`;
20
+ const fullPath = path.resolve(projectRoot, relativePath);
23
21
 
24
- logger.debug('Removing module at:', fullPath);
22
+ logger.debug('Removing module at:', fullPath);
25
23
 
26
- if (!(await fs.pathExists(fullPath))) {
27
- this.error(`Module ${name} not found at ${relativePath}.`);
28
- return;
29
- }
30
-
31
- this.info(`Removing module ${name}...`);
24
+ if (!(await fs.pathExists(fullPath))) {
25
+ this.error(`Module ${name} not found at ${relativePath}.`);
26
+ return;
27
+ }
32
28
 
33
- try {
34
- await runCommand(`git submodule deinit -f ${relativePath}`, projectRoot);
35
- await runCommand(`git rm -f ${relativePath}`, projectRoot);
29
+ this.info(`Removing module ${name}...`);
36
30
 
37
- // Clean up .git/modules
38
- const gitModulesDir = path.resolve(projectRoot, '.git', 'modules', 'modules', name);
39
- if (await fs.pathExists(gitModulesDir)) {
40
- await fs.remove(gitModulesDir);
41
- }
31
+ try {
32
+ await runCommand(`git submodule deinit -f ${relativePath}`, projectRoot);
33
+ await runCommand(`git rm -f ${relativePath}`, projectRoot);
42
34
 
43
- this.info('Syncing workspace dependencies...');
44
- await runCommand('npm install', projectRoot);
35
+ // Clean up .git/modules
36
+ const gitModulesDir = path.resolve(projectRoot, '.git', 'modules', 'modules', name);
37
+ if (await fs.pathExists(gitModulesDir)) {
38
+ await fs.remove(gitModulesDir);
39
+ }
45
40
 
41
+ this.info('Syncing workspace dependencies...');
42
+ await runCommand('npm install', projectRoot);
46
43
 
47
- await this.removeFromConfig(name);
44
+ await this.removeFromConfig(name);
48
45
 
49
- this.success(`Module ${name} removed successfully.`);
50
- } catch (e: any) {
51
- this.error(`Failed to remove module: ${e.message}`);
52
- }
46
+ this.success(`Module ${name} removed successfully.`);
47
+ } catch (e: unknown) {
48
+ if (e instanceof Error) {
49
+ this.error(`Failed to remove module: ${e.message}`);
50
+ } else {
51
+ this.error(`Failed to remove module: ${String(e)}`);
52
+ }
53
53
  }
54
-
55
- private async removeFromConfig(moduleName: string) {
56
- const projectRoot = this.projectRoot as string;
57
- const configPath = path.join(projectRoot, 'nexical.yaml');
58
-
59
- if (!await fs.pathExists(configPath)) return;
60
-
61
- try {
62
- const content = await fs.readFile(configPath, 'utf8');
63
- let config = YAML.parse(content) || {};
64
-
65
- if (config.modules && config.modules.includes(moduleName)) {
66
- config.modules = config.modules.filter((m: string) => m !== moduleName);
67
- await fs.writeFile(configPath, YAML.stringify(config));
68
- logger.debug(`Removed ${moduleName} from nexical.yaml modules list.`);
69
- }
70
- } catch (e: any) {
71
- logger.warn(`Failed to update nexical.yaml: ${e.message}`);
72
- }
54
+ }
55
+
56
+ private async removeFromConfig(moduleName: string) {
57
+ const projectRoot = this.projectRoot as string;
58
+ const configPath = path.join(projectRoot, 'nexical.yaml');
59
+
60
+ if (!(await fs.pathExists(configPath))) return;
61
+
62
+ try {
63
+ const content = await fs.readFile(configPath, 'utf8');
64
+ const config = YAML.parse(content) || {};
65
+
66
+ if (config.modules && config.modules.includes(moduleName)) {
67
+ config.modules = config.modules.filter((m: string) => m !== moduleName);
68
+ await fs.writeFile(configPath, YAML.stringify(config));
69
+ logger.debug(`Removed ${moduleName} from nexical.yaml modules list.`);
70
+ }
71
+ } catch (e: unknown) {
72
+ if (e instanceof Error) {
73
+ logger.warn(`Failed to update nexical.yaml: ${e.message}`);
74
+ } else {
75
+ logger.warn(`Failed to update nexical.yaml: ${String(e)}`);
76
+ }
73
77
  }
78
+ }
74
79
  }
@@ -3,48 +3,50 @@ import fs from 'fs-extra';
3
3
  import path from 'path';
4
4
 
5
5
  export default class ModuleUpdateCommand extends BaseCommand {
6
- static usage = 'module update [name]';
7
- static description = 'Update a specific module or all modules.';
8
- static requiresProject = true;
9
-
10
- static args: CommandDefinition = {
11
- args: [
12
- { name: 'name', required: false, description: 'Name of the module to update' }
13
- ]
14
- };
15
-
16
- async run(options: any) {
17
- const projectRoot = this.projectRoot as string;
18
- let { name } = options;
19
-
20
- this.info(name ? `Updating module ${name}...` : 'Updating all modules...');
21
- logger.debug('Update context:', { name, projectRoot: projectRoot });
22
-
23
- try {
24
- if (name) {
25
- const relativePath = `modules/${name}`;
26
- const fullPath = path.resolve(projectRoot, relativePath);
27
-
28
- if (!(await fs.pathExists(fullPath))) {
29
- this.error(`Module ${name} not found.`);
30
- return;
31
- }
32
-
33
- // Update specific module
34
- // We enter the directory and pull? Or generic submodule update?
35
- // Generic submodule update --remote src/modules/name
36
- await runCommand(`git submodule update --remote --merge ${relativePath}`, projectRoot);
37
- } else {
38
- // Update all
39
- await runCommand('git submodule update --remote --merge', projectRoot);
40
- }
41
-
42
- this.info('Syncing workspace dependencies...');
43
- await runCommand('npm install', projectRoot);
44
-
45
- this.success('Modules updated successfully.');
46
- } catch (e: any) {
47
- this.error(`Failed to update modules: ${e.message}`);
6
+ static usage = 'module update [name]';
7
+ static description = 'Update a specific module or all modules.';
8
+ static requiresProject = true;
9
+
10
+ static args: CommandDefinition = {
11
+ args: [{ name: 'name', required: false, description: 'Name of the module to update' }],
12
+ };
13
+
14
+ async run(options: { name?: string }) {
15
+ const projectRoot = this.projectRoot as string;
16
+ const { name } = options;
17
+
18
+ this.info(name ? `Updating module ${name}...` : 'Updating all modules...');
19
+ logger.debug('Update context:', { name, projectRoot: projectRoot });
20
+
21
+ try {
22
+ if (name) {
23
+ const relativePath = `modules/${name}`;
24
+ const fullPath = path.resolve(projectRoot, relativePath);
25
+
26
+ if (!(await fs.pathExists(fullPath))) {
27
+ this.error(`Module ${name} not found.`);
28
+ return;
48
29
  }
30
+
31
+ // Update specific module
32
+ // We enter the directory and pull? Or generic submodule update?
33
+ // Generic submodule update --remote src/modules/name
34
+ await runCommand(`git submodule update --remote --merge ${relativePath}`, projectRoot);
35
+ } else {
36
+ // Update all
37
+ await runCommand('git submodule update --remote --merge', projectRoot);
38
+ }
39
+
40
+ this.info('Syncing workspace dependencies...');
41
+ await runCommand('npm install', projectRoot);
42
+
43
+ this.success('Modules updated successfully.');
44
+ } catch (e: unknown) {
45
+ if (e instanceof Error) {
46
+ this.error(`Failed to update modules: ${e.message}`);
47
+ } else {
48
+ this.error(`Failed to update modules: ${String(e)}`);
49
+ }
49
50
  }
51
+ }
50
52
  }
@@ -5,94 +5,102 @@ import { spawn } from 'child_process';
5
5
  import process from 'node:process';
6
6
 
7
7
  export default class RunCommand extends BaseCommand {
8
- static usage = 'run <script> [args...]';
9
- static description = 'Run a script inside the Nexical environment.';
10
- static requiresProject = true;
11
-
12
- static args: CommandDefinition = {
13
- args: [
14
- { name: 'script', required: true, description: 'The script to run (script-name OR module:script-name)' },
15
- { name: 'args...', required: false, description: 'Arguments for the script' }
16
- ]
17
- };
8
+ static usage = 'run <script> [args...]';
9
+ static description = 'Run a script inside the Nexical environment.';
10
+ static requiresProject = true;
11
+
12
+ static args: CommandDefinition = {
13
+ args: [
14
+ {
15
+ name: 'script',
16
+ required: true,
17
+ description: 'The script to run (script-name OR module:script-name)',
18
+ },
19
+ { name: 'args...', required: false, description: 'Arguments for the script' },
20
+ ],
21
+ };
22
+
23
+ async run(options: { script: string; args?: string[] }) {
24
+ const projectRoot = this.projectRoot as string;
25
+ const script = options.script;
26
+ const scriptArgs = options.args || [];
27
+
28
+ if (!script) {
29
+ this.error('Please specify a script to run.');
30
+ return;
31
+ }
18
32
 
19
- async run(options: any) {
20
- const projectRoot = this.projectRoot as string;
21
- const script = options.script;
22
- const scriptArgs = options.args || [];
33
+ logger.debug('Run command context:', { script, args: scriptArgs, projectRoot });
23
34
 
24
- if (!script) {
25
- this.error('Please specify a script to run.');
26
- return;
27
- }
35
+ let execPath = projectRoot;
36
+ let scriptName = script;
28
37
 
29
- logger.debug('Run command context:', { script, args: scriptArgs, projectRoot });
38
+ // Handle module:script syntax
39
+ if (script.includes(':')) {
40
+ const [moduleName, name] = script.split(':');
41
+ execPath = path.resolve(projectRoot, 'modules', moduleName);
42
+ scriptName = name;
30
43
 
31
- let execPath = projectRoot;
32
- let scriptName = script;
44
+ logger.debug(`Resolving module script: ${moduleName}:${scriptName} at ${execPath}`);
45
+ } else {
46
+ logger.debug(`Resolving core script: ${scriptName} at ${execPath}`);
47
+ }
33
48
 
34
- // Handle module:script syntax
35
- if (script.includes(':')) {
36
- const [moduleName, name] = script.split(':');
37
- execPath = path.resolve(projectRoot, 'modules', moduleName);
38
- scriptName = name;
49
+ // Validate script existence
50
+ const pkgJsonPath = path.join(execPath, 'package.json');
51
+ if (!(await fs.pathExists(pkgJsonPath))) {
52
+ this.error(`Failed to find package.json at ${execPath}`);
53
+ return;
54
+ }
39
55
 
40
- logger.debug(`Resolving module script: ${moduleName}:${scriptName} at ${execPath}`);
41
- } else {
42
- logger.debug(`Resolving core script: ${scriptName} at ${execPath}`);
43
- }
56
+ try {
57
+ const pkg = await fs.readJson(pkgJsonPath);
58
+ if (!pkg.scripts || !pkg.scripts[scriptName]) {
59
+ const type = script.includes(':') ? `module ${script.split(':')[0]}` : 'Nexical core';
60
+ this.error(`Script "${scriptName}" does not exist in ${type}`);
61
+ return;
62
+ }
63
+ } catch (e: unknown) {
64
+ if (e instanceof Error) {
65
+ this.error(`Failed to read package.json at ${execPath}: ${e.message}`);
66
+ } else {
67
+ this.error(`Failed to read package.json at ${execPath}: ${String(e)}`);
68
+ }
69
+ return;
70
+ }
44
71
 
45
- // Validate script existence
46
- const pkgJsonPath = path.join(execPath, 'package.json');
47
- if (!(await fs.pathExists(pkgJsonPath))) {
48
- this.error(`Failed to find package.json at ${execPath}`);
49
- return;
50
- }
72
+ const finalArgs = ['run', scriptName, '--', ...scriptArgs];
73
+ logger.debug(`Executing: npm ${finalArgs.join(' ')} in ${execPath}`);
74
+
75
+ const child = spawn('npm', finalArgs, {
76
+ cwd: execPath,
77
+ stdio: 'inherit',
78
+ env: {
79
+ ...process.env,
80
+ FORCE_COLOR: '1',
81
+ },
82
+ });
83
+
84
+ // Handle process termination to kill child
85
+ const cleanup = () => {
86
+ child.kill();
87
+ process.exit();
88
+ };
51
89
 
52
- try {
53
- const pkg = await fs.readJson(pkgJsonPath);
54
- if (!pkg.scripts || !pkg.scripts[scriptName]) {
55
- const type = script.includes(':') ? `module ${script.split(':')[0]}` : 'Nexical core';
56
- this.error(`Script "${scriptName}" does not exist in ${type}`);
57
- return;
58
- }
59
- } catch (e: any) {
60
- this.error(`Failed to read package.json at ${execPath}: ${e.message}`);
61
- return;
62
- }
90
+ process.on('SIGINT', cleanup);
91
+ process.on('SIGTERM', cleanup);
63
92
 
64
- const finalArgs = ['run', scriptName, '--', ...scriptArgs];
65
- logger.debug(`Executing: npm ${finalArgs.join(' ')} in ${execPath}`);
66
-
67
- const child = spawn('npm', finalArgs, {
68
- cwd: execPath,
69
- stdio: 'inherit',
70
- env: {
71
- ...process.env,
72
- FORCE_COLOR: '1'
73
- }
74
- });
75
-
76
- // Handle process termination to kill child
77
- const cleanup = () => {
78
- child.kill();
79
- process.exit();
80
- };
81
-
82
- process.on('SIGINT', cleanup);
83
- process.on('SIGTERM', cleanup);
84
-
85
- await new Promise<void>((resolve) => {
86
- child.on('close', (code) => {
87
- // Remove listeners to prevent memory leaks if this command is run multiple times in-process (e.g. tests)
88
- process.off('SIGINT', cleanup);
89
- process.off('SIGTERM', cleanup);
90
-
91
- if (code !== 0) {
92
- process.exit(code || 1);
93
- }
94
- resolve();
95
- });
96
- });
97
- }
93
+ await new Promise<void>((resolve) => {
94
+ child.on('close', (code) => {
95
+ // Remove listeners to prevent memory leaks if this command is run multiple times in-process (e.g. tests)
96
+ process.off('SIGINT', cleanup);
97
+ process.off('SIGTERM', cleanup);
98
+
99
+ if (code !== 0) {
100
+ process.exit(code || 1);
101
+ }
102
+ resolve();
103
+ });
104
+ });
105
+ }
98
106
  }
@@ -0,0 +1,92 @@
1
+ import { BaseCommand, logger } from '@nexical/cli-core';
2
+ import fs from 'fs-extra';
3
+ import path from 'path';
4
+
5
+ export default class SetupCommand extends BaseCommand {
6
+ static description = 'Setup the application environment by symlinking core assets.';
7
+
8
+ async run() {
9
+ // We assume we are in the project root
10
+ // But the CLI might be run from anywhere?
11
+ // findProjectRoot in index.ts handles finding the root.
12
+ // BaseCommand has this.projectRoot?
13
+
14
+ // BaseCommand doesn't expose projectRoot directly in current implementation seen in memory, checking source if possible?
15
+ // InitCommand used process.cwd().
16
+
17
+ // Let's assume process.cwd() is project root if run via `npm run setup` from root.
18
+ const rootDir = process.cwd();
19
+
20
+ // Verify we are in the right place
21
+ if (!fs.existsSync(path.join(rootDir, 'core'))) {
22
+ this.error('Could not find "core" directory. Are you in the project root?');
23
+ process.exit(1);
24
+ }
25
+
26
+ const apps = ['frontend', 'backend'];
27
+ const sharedAssets = [
28
+ 'prisma',
29
+ 'src',
30
+ 'public',
31
+ 'locales',
32
+ 'scripts',
33
+ 'astro.config.mjs',
34
+ 'tsconfig.json',
35
+ ]; // tsconfig might be needed if extended
36
+
37
+ for (const app of apps) {
38
+ const appDir = path.join(rootDir, 'apps', app);
39
+ if (!fs.existsSync(appDir)) {
40
+ this.warn(`App directory ${app} not found. Skipping.`);
41
+ continue;
42
+ }
43
+
44
+ this.info(`Setting up ${app}...`);
45
+
46
+ for (const asset of sharedAssets) {
47
+ const source = path.join(rootDir, 'core', asset);
48
+ const dest = path.join(appDir, asset);
49
+
50
+ if (!fs.existsSync(source)) {
51
+ this.warn(`Source asset ${asset} not found in core.`);
52
+ continue;
53
+ }
54
+
55
+ try {
56
+ // Remove existing destination if it exists (to ensure clean symlink)
57
+ // Be careful not to delete real files if they aren't symlinks?
58
+ // For now, we assume setup controls these.
59
+
60
+ const destDir = path.dirname(dest);
61
+ await fs.ensureDir(destDir);
62
+
63
+ try {
64
+ fs.lstatSync(dest);
65
+ fs.removeSync(dest);
66
+ } catch (e: unknown) {
67
+ if (
68
+ e &&
69
+ typeof e === 'object' &&
70
+ 'code' in e &&
71
+ (e as { code: string }).code !== 'ENOENT'
72
+ )
73
+ throw e;
74
+ }
75
+
76
+ const relSource = path.relative(destDir, source);
77
+ await fs.symlink(relSource, dest);
78
+
79
+ logger.debug(`Symlinked ${asset} to ${app}`);
80
+ } catch (e: unknown) {
81
+ if (e instanceof Error) {
82
+ this.error(`Failed to symlink ${asset} to ${app}: ${e.message}`);
83
+ } else {
84
+ this.error(`Failed to symlink ${asset} to ${app}: ${String(e)}`);
85
+ }
86
+ }
87
+ }
88
+ }
89
+
90
+ this.success('Application setup complete.');
91
+ }
92
+ }