feat(cli): create cli package with config, plugins and commands

.vscode/extensions.json

@@ -1,6 +1,3 @@
 {
-  "recommendations": [
-    "nrwl.angular-console",
-    "esbenp.prettier-vscode",
-  ]
+  "recommendations": ["nrwl.angular-console", "esbenp.prettier-vscode"]
 }

package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "license": "MIT",
   "scripts": {
-    "build": "nx build create-app",
+    "build": "nx run-many --target=build",
     "test": "nx run-many --target=test --watch=false",
     "lint": "nx run-many --target=lint"
   },

packages/cli/README.md

@@ -0,0 +1,11 @@
+# cli
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build cli` to build the library.
+
+## Running unit tests
+
+Run `nx test cli` to execute the unit tests via [Jest](https://jestjs.io).

packages/cli/eslint.config.js

@@ -0,0 +1,21 @@
+const baseConfig = require('../../eslint.config.js');
+
+module.exports = [
+  ...baseConfig,
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs}'],
+          // TODO: @nx/dependency-checks incorrectly reports unused dependencies
+          checkObsoleteDependencies: false,
+        },
+      ],
+    },
+    languageOptions: {
+      parser: require('jsonc-eslint-parser'),
+    },
+  },
+];

packages/cli/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@callstack/rnef-cli",
+  "version": "0.0.1",
+  "dependencies": {
+    "commander": "^12.1.0",
+    "tslib": "^2.3.0"
+  },
+  "bin": {
+    "rnef": "./src/bin.js"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "private": true
+}

packages/cli/project.json

@@ -0,0 +1,19 @@
+{
+  "name": "cli",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/cli/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "packages/cli/dist",
+        "main": "packages/cli/src/index.ts",
+        "tsConfig": "packages/cli/tsconfig.lib.json",
+        "assets": ["packages/cli/*.md"]
+      }
+    }
+  }
+}

packages/cli/src/bin.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { cli } from './lib/cli';
+
+cli();

packages/cli/src/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/cli';
+

packages/cli/src/lib/__tests__/__fixtures__/SamplePlugin.ts

@@ -0,0 +1,65 @@
+type PlatformConfig = {
+  name: string;
+  init: () => Promise<void>;
+  build: () => Promise<void>;
+  run: () => Promise<void>;
+  linkModules: () => Promise<void>;
+  linkAssets: () => Promise<void>;
+};
+
+type PluginOutput = {
+  name: string;
+  description: string;
+  action: () => Promise<void>;
+  platform?: () => PlatformConfig;
+};
+
+type CommandType = {
+  name: string;
+  description: string;
+  action: () => void;
+};
+
+type PluginArgs = {
+  registerCommand: (command: CommandType) => void;
+};
+
+export default function SamplePlugin(api: PluginArgs): PluginOutput {
+  const name = 'xplat';
+  const linkModules = async () => {
+    // noop
+  };
+  const linkAssets = async () => {
+    // noop
+  };
+  const build = async () => {
+    linkModules();
+    linkAssets();
+    // noop - build
+  };
+  const run = async () => {
+    linkModules();
+    linkAssets();
+    // noop - build
+  };
+
+  api.registerCommand({
+    name: `${name}build`,
+    description: 'Build xplat',
+    action: build,
+  });
+
+  api.registerCommand({
+    name: `${name}run`,
+    description: 'Run xplat',
+    action: run,
+  });
+
+  return {
+    name: 'xplat',
+    description: 'sample plugin',
+    action: async () => {
+      // noop
+    },
+  };
+}

packages/cli/src/lib/__tests__/cli.spec.ts

@@ -0,0 +1,8 @@
+import { describe, it, expect } from 'vitest';
+import { cli } from '../cli';
+
+describe('cli', () => {
+  it('should throw when config not found', async () => {
+    await expect(cli()).rejects.toThrow('rnef.config not found in any parent directory of /');
+  });
+});

packages/cli/src/lib/__tests__/getConfig.spec.ts

@@ -0,0 +1,60 @@
+import { vi, expect, beforeEach, afterEach, test } from 'vitest';
+import { getConfig } from '../getConfig';
+import {
+  cleanup,
+  writeFiles,
+  getTempDirectory,
+} from '../../../../../test-helpers';
+
+const DIR = getTempDirectory('test_config');
+
+beforeEach(() => {
+  cleanup(DIR);
+  vi.resetModules();
+  vi.clearAllMocks();
+});
+
+afterEach(() => cleanup(DIR));
+
+test.each([['.js'], ['.mjs'], ['.ts']])(
+  'should load configs with %s extension',
+  async (ext) => {
+    writeFiles(DIR, {
+      [`rnef.config${ext}`]: `module.exports = {
+      plugins: {}
+    }`,
+    });
+    expect(await getConfig(DIR)).toMatchObject({ commands: [] });
+  }
+);
+
+test('should load plugin that registers a command', async () => {
+  writeFiles(DIR, {
+    'rnef.config.js': `module.exports = {
+      plugins: {
+        'test-plugin': function TestPlugin(config) {
+          return {
+            name: 'test-plugin',
+            commands: [
+              {
+                name: 'test-command',
+                description: 'Test command',
+                action: () => { console.log('Test command executed'); },
+              },
+            ],
+          };
+        }
+      }
+    }`,
+  });
+
+  expect(await getConfig(DIR)).toMatchObject({
+    commands: [
+      {
+        name: 'test-command',
+        description: 'Test command',
+        action: expect.any(Function),
+      },
+    ],
+  });
+});

packages/cli/src/lib/cli.ts

@@ -0,0 +1,36 @@
+import { Command } from 'commander';
+import { version } from '../../package.json';
+import { getConfig } from '@callstack/rnef-config';
+
+const program = new Command();
+
+program
+  .name('rnef')
+  .description('React Native Enterprise Framework CLI.')
+  .version(version);
+
+export const cli = async () => {
+  const config = await getConfig();
+
+  // Register commands from the config
+  config.commands?.forEach((command) => {
+    const cmd = program
+      .command(command.name)
+      .description(command.description || '')
+      .action(async () => {
+        try {
+          command.action(program.args);
+        } catch (e) {
+          // TODO handle nicely
+          console.log('Error: ', e);
+          process.exit(1);
+        }
+      });
+
+    for (const opt of command.options || []) {
+      cmd.option(opt.name, opt.description ?? '');
+    }
+  });
+
+  program.parse();
+};

packages/cli/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "resolveJsonModule": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

packages/cli/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "../config/src/lib/config.ts"],
+  "exclude": ["vitest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

packages/cli/tsconfig.spec.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["node"]
+  },
+  "include": [
+    "vite.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+, "__tests__/getConfig.spec.ts"  ]
+}

packages/cli/vitest.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    name: 'cli',
+    environment: 'node',
+    include: ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+      reportsDirectory: '../../coverage/packages/cli',
+    },
+    typecheck: {
+      tsconfig: './tsconfig.spec.json',
+    },
+  },
+  resolve: {
+    extensions: ['.ts', '.js', '.html'],
+  },
+});

packages/config/README.md

@@ -0,0 +1,11 @@
+# config
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build config` to build the library.
+
+## Running unit tests
+
+Run `nx test config` to execute the unit tests via [Vitest](https://vitest.dev/).

packages/config/eslint.config.js

@@ -0,0 +1,22 @@
+const baseConfig = require('../../eslint.config.js');
+
+module.exports = [
+  ...baseConfig,
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: [
+            '{projectRoot}/eslint.config.{js,cjs,mjs}',
+            '{projectRoot}/vite.config.{js,ts,mjs,mts}',
+          ],
+        },
+      ],
+    },
+    languageOptions: {
+      parser: require('jsonc-eslint-parser'),
+    },
+  },
+];

packages/config/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@callstack/rnef-config",
+  "version": "0.0.1",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "private": true
+}