@o3r/create 11.0.0-prerelease.13 → 11.0.0-prerelease.14

package/README.md

@@ -20,25 +20,35 @@ This package is simplifying the start of an [Otter Framework](https://github.com
 npm create @o3r <project-name> -- [...options]
 ```
 
-or
+> [!WARNING]
+> `yarn create` is not supported.
+
+### Custom package manager
+
+You can generate an environment with a specific package manager thanks to the `--package-manager` options:
 
 ```shell
-yarn create @o3r <project-name> [...options]
+npm create @o3r <project-name> -- --package-manager=yarn [...options]
 ```
 
-> [!WARNING]
-> Please notice that the command `yarn create` is **not** available for versions *>= 2.0.0* (see [Yarn cli commands](https://yarnpkg.com/cli)).
+> [!NOTE]
+> At the moment, the ``package-manager`` option only supports `yarn` and `npm`.
 
-You can generate an environment with a specific package manager thanks to the `--package-manager` options:
+### Custom registry
+
+You can specify the npm's package registry to use.
 
 ```shell
-npm create @o3r <project-name> -- --package-manager=yarn [...options]
+npm create @o3r <project-name> --registry=<registry-url> -- [...options]
 ```
 
-## Available options
+It will create a project with a `.npmrc` file configured to target the specified registry.
+If the specified package manager is `yarn`, it will also configure the `.yarnrc.yml` file.
+
+### Others available options
 
-The generator accepts all the configurations from Angular `ng new` command, find the list [here](https://angular.io/cli/new#options).
+The generator accepts all the configurations from the Angular `ng new` command, see the [options list](https://angular.io/cli/new#options).
 On top of them, the following options can be provided to the initializer:
 
-- `--yarn-version` : specify the version of yarn to use (default: `latest`)
-- `--exact-o3r-version` : use a pinned version for [otter packages](https://github.com/AmadeusITGroup/otter/blob/main/docs/README.md).
+- `--yarn-version`: specify the version of yarn to use (default: `latest`)
+- `--exact-o3r-version`: use a pinned version for [Otter packages](https://github.com/AmadeusITGroup/otter/blob/main/docs/README.md).

package/index.js

@@ -5,6 +5,7 @@ const node_child_process_1 = require("node:child_process");
 const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
 const minimist = require("minimist");
+const shell_quote_1 = require("shell-quote");
 const { properties } = JSON.parse((0, node_fs_1.readFileSync)(require.resolve('@schematics/angular/ng-new/schema').replace(/\.js$/, '.json'), { encoding: 'utf-8' }));
 const { version, dependencies, devDependencies } = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.resolve)(__dirname, 'package.json'), { encoding: 'utf-8' }));
 const optionsList = [
@@ -81,13 +82,24 @@ if (!args.some((a) => a.startsWith('--preset'))) {
     args.push('--preset', 'basic');
 }
 args.push('--no-create-application');
+const supportedPackageManager = ['npm', 'yarn'];
+const supportedPackageManagerRegExp = new RegExp(`^(${supportedPackageManager.join('|')})$`);
 const argv = minimist(args);
 const packageManagerEnv = process.env.npm_config_user_agent?.split('/')[0];
-let defaultPackageManager = 'npm';
-if (packageManagerEnv && ['npm', 'yarn'].includes(packageManagerEnv)) {
+let defaultPackageManager = supportedPackageManager[0];
+if (packageManagerEnv && supportedPackageManager.includes(packageManagerEnv)) {
     defaultPackageManager = packageManagerEnv;
 }
-const packageManager = argv['package-manager'] || defaultPackageManager;
+const argvPackageManager = argv['package-manager'];
+let packageManager = supportedPackageManagerRegExp.test(argvPackageManager) ? argv['package-manager'] : defaultPackageManager;
+if (argvPackageManager && supportedPackageManagerRegExp.test(argvPackageManager)) {
+    packageManager = argvPackageManager;
+}
+else if (argvPackageManager) {
+    // eslint-disable-next-line no-console
+    console.error(`The package manager option supports only npm and yarn, you provided "${argvPackageManager}"`);
+    process.exit(-1);
+}
 const exactO3rVersion = !!argv['exact-o3r-version'];
 if (argv._.length === 0) {
     // eslint-disable-next-line no-console
@@ -108,6 +120,12 @@ const isNgNewOptions = (arg) => {
     }
     return true;
 };
+const NG_NEW_ERROR_CODE = 1;
+const YARN_SET_VERSION_ERROR_CODE = 2;
+const ADD_O3R_CORE_ERROR_CODE = 3;
+const NPM_CONFIG_REGISTRY_ERROR_CODE = 4;
+const YARN_CONFIG_REGISTRY_ERROR_CODE = 5;
+const INSTALL_PROCESS_ERROR_CODE = 6;
 const exitProcessIfErrorInSpawnSync = (exitCode, { error, status }) => {
     if (error || status !== 0) {
         if (error) {
@@ -128,13 +146,23 @@ const createNgProject = () => {
     const options = schematicsCliOptions
         .filter(([key]) => isNgNewOptions(key))
         .flat();
-    exitProcessIfErrorInSpawnSync(1, (0, node_child_process_1.spawnSync)(`"${process.execPath}"`, [binPath, 'new', ...argv._, ...options], {
+    exitProcessIfErrorInSpawnSync(NG_NEW_ERROR_CODE, (0, node_child_process_1.spawnSync)(`"${process.execPath}"`, [
+        binPath,
+        'new',
+        ...argv._.map((arg) => arg && (0, shell_quote_1.quote)([arg])),
+        ...options.map((opt) => opt && (0, shell_quote_1.quote)([opt]))
+    ], {
         stdio: 'inherit',
         shell: true
     }));
 };
 const prepareWorkspace = (relativeDirectory = '.', projectPackageManager = 'npm') => {
     const cwd = (0, node_path_1.resolve)(process.cwd(), relativeDirectory);
+    const spawnSyncOpts = {
+        stdio: 'inherit',
+        shell: true,
+        cwd
+    };
     const runner = process.platform === 'win32' ? `${projectPackageManager}.cmd` : projectPackageManager;
     const mandatoryDependencies = [
         '@angular-devkit/schematics',
@@ -169,24 +197,25 @@ const prepareWorkspace = (relativeDirectory = '.', projectPackageManager = 'npm'
     }
     (0, node_fs_1.writeFileSync)(packageJsonPath, JSON.stringify(packageJson, null, 2));
     if (projectPackageManager === 'yarn') {
-        exitProcessIfErrorInSpawnSync(2, (0, node_child_process_1.spawnSync)(runner, ['set', 'version', argv['yarn-version'] || 'stable'], {
-            stdio: 'inherit',
-            shell: true,
-            cwd
-        }));
+        const yarnVersion = (0, shell_quote_1.quote)([argv['yarn-version'] || 'stable']);
+        exitProcessIfErrorInSpawnSync(YARN_SET_VERSION_ERROR_CODE, (0, node_child_process_1.spawnSync)(runner, ['set', 'version', yarnVersion], spawnSyncOpts));
     }
-    exitProcessIfErrorInSpawnSync(2, (0, node_child_process_1.spawnSync)(runner, ['install'], {
-        stdio: 'inherit',
-        shell: true,
-        cwd
-    }));
+    const registry = process.env.npm_config_registry || (argv.registry && (0, shell_quote_1.quote)([argv.registry]));
+    if (registry) {
+        // Need to add this even for yarn because `ng add` only reads registry from .npmrc
+        exitProcessIfErrorInSpawnSync(NPM_CONFIG_REGISTRY_ERROR_CODE, (0, node_child_process_1.spawnSync)(runner, ['config', 'set', '-L', 'project', 'registry', registry], spawnSyncOpts));
+        if (projectPackageManager === 'yarn') {
+            exitProcessIfErrorInSpawnSync(YARN_CONFIG_REGISTRY_ERROR_CODE, (0, node_child_process_1.spawnSync)(runner, ['config', 'set', 'npmRegistryServer', registry], spawnSyncOpts));
+        }
+    }
+    exitProcessIfErrorInSpawnSync(INSTALL_PROCESS_ERROR_CODE, (0, node_child_process_1.spawnSync)(runner, ['install'], spawnSyncOpts));
 };
 const addOtterFramework = (relativeDirectory = '.', projectPackageManager = 'npm') => {
     const cwd = (0, node_path_1.resolve)(process.cwd(), relativeDirectory);
     const runner = process.platform === 'win32' ? `${projectPackageManager}.cmd` : projectPackageManager;
     const options = schematicsCliOptions
         .flat();
-    exitProcessIfErrorInSpawnSync(3, (0, node_child_process_1.spawnSync)(runner, ['exec', 'ng', 'add', `@o3r/core@${exactO3rVersion ? '' : '~'}${version}`, ...(projectPackageManager === 'npm' ? ['--'] : []), ...options], {
+    exitProcessIfErrorInSpawnSync(ADD_O3R_CORE_ERROR_CODE, (0, node_child_process_1.spawnSync)(runner, ['exec', 'ng', 'add', `@o3r/core@${exactO3rVersion ? '' : '~'}${version}`, ...(projectPackageManager === 'npm' ? ['--'] : []), ...options], {
         stdio: 'inherit',
         cwd,
         shell: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/create",
-  "version": "11.0.0-prerelease.13",
+  "version": "11.0.0-prerelease.14",
   "publishConfig": {
     "access": "public"
   },
@@ -21,6 +21,7 @@
     "@angular/cli": "~17.3.0",
     "@schematics/angular": "~17.3.0",
     "minimist": "^1.2.6",
+    "shell-quote": "^1.8.1",
     "tslib": "^2.6.2",
     "type-fest": "^4.10.2"
   },
@@ -34,15 +35,16 @@
     "@nx/eslint-plugin": "~18.3.0",
     "@nx/jest": "~18.3.0",
     "@nx/js": "~18.3.0",
-    "@o3r/build-helpers": "^11.0.0-prerelease.13",
-    "@o3r/eslint-config-otter": "^11.0.0-prerelease.13",
-    "@o3r/eslint-plugin": "^11.0.0-prerelease.13",
-    "@o3r/schematics": "^11.0.0-prerelease.13",
-    "@o3r/test-helpers": "^11.0.0-prerelease.13",
+    "@o3r/build-helpers": "^11.0.0-prerelease.14",
+    "@o3r/eslint-config-otter": "^11.0.0-prerelease.14",
+    "@o3r/eslint-plugin": "^11.0.0-prerelease.14",
+    "@o3r/schematics": "^11.0.0-prerelease.14",
+    "@o3r/test-helpers": "^11.0.0-prerelease.14",
     "@stylistic/eslint-plugin-ts": "^1.5.4",
     "@types/jest": "~29.5.2",
     "@types/minimist": "^1.2.2",
     "@types/node": "^20.0.0",
+    "@types/shell-quote": "^1.7.5",
     "@typescript-eslint/eslint-plugin": "^7.2.0",
     "@typescript-eslint/parser": "^7.2.0",
     "cpy-cli": "^5.0.0",