@o3r/create 11.0.0-next.0 → 11.0.0-next.2

package/README.md

@@ -3,20 +3,42 @@
   <img src="https://raw.githubusercontent.com/AmadeusITGroup/otter/main/assets/logo/otter.png" alt="Super cute Otter!" width="40%"/>
 </p>
 
+## Description
+
+[![Stable Version](https://img.shields.io/npm/v/@o3r/create?style=for-the-badge)](https://www.npmjs.com/package/@o3r/create)
+[![Bundle Size](https://img.shields.io/bundlephobia/min/@o3r/create?color=green&style=for-the-badge)](https://www.npmjs.com/package/@o3r/create)
+
+This package is an [NPM initializer](https://docs.npmjs.com/cli/v8/commands/npm-init) to generate a web application based on the [Otter Framework](https://github.com/AmadeusITGroup/otter).
+
 ## Create an Otter application
 
 This package is simplifying the start of an [Otter Framework](https://github.com/AmadeusITGroup/otter) based application.
 
 ## Usage
 
-### NPM
-
 ```shell
 npm create @o3r <project-name> -- [...options]
 ```
 
-### Yarn
+or
 
 ```shell
 yarn create @o3r <project-name> [...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)).
+
+You can generate an environment with a specific package manager thanks to the `--package-manager` options:
+
+```shell
+npm create @o3r <project-name> -- --package-manager=yarn [...options]
+```
+
+## Available options
+
+The generator accepts all the configurations from Angular `ng new` command, find the list [here](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).

package/index.js

@@ -6,7 +6,10 @@ const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
 const minimist = require("minimist");
 const { properties } = JSON.parse((0, node_fs_1.readFileSync)(require.resolve('@schematics/angular/ng-new/schema').replace(/\.js$/, '.json'), { encoding: 'utf-8' }));
-const { version } = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.resolve)(__dirname, 'package.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 = [
+    'yarn-version'
+];
 const logo = `
 
                         &BPPPB                    &                    &BPGB&
@@ -69,18 +72,23 @@ const logo = `
 `;
 const binPath = (0, node_path_1.join)(require.resolve('@angular/cli/package.json'), '../bin/ng.js');
 const args = process.argv.slice(2).filter((a) => a !== '--create-application');
+// Default styling to Sass
 if (!args.some((a) => a.startsWith('--style'))) {
     args.push('--style', 'scss');
 }
-const hasPackageManagerArg = args.some((a) => a.startsWith('--package-manager'));
-if (!hasPackageManagerArg) {
-    const packageManager = process.env.npm_config_user_agent?.split('/')[0];
-    if (packageManager && ['npm', 'pnpm', 'yarn', 'cnpm'].includes(packageManager)) {
-        args.push('--package-manager', packageManager);
-    }
+// Default Preset to Basic
+if (!args.some((a) => a.startsWith('--preset'))) {
+    args.push('--preset', 'basic');
 }
 args.push('--no-create-application');
 const argv = minimist(args);
+const packageManagerEnv = process.env.npm_config_user_agent?.split('/')[0];
+let defaultPackageManager = 'npm';
+if (packageManagerEnv && ['npm', 'yarn'].includes(packageManagerEnv)) {
+    defaultPackageManager = packageManagerEnv;
+}
+const packageManager = argv['package-manager'] || defaultPackageManager;
+const exactO3rVersion = !!argv['exact-o3r-version'];
 if (argv._.length === 0) {
     // eslint-disable-next-line no-console
     console.error('The project name is mandatory');
@@ -100,8 +108,17 @@ const isNgNewOptions = (arg) => {
     }
     return true;
 };
+const exitProcessIfErrorInSpawnSync = (exitCode, { error, status }) => {
+    if (error || status !== 0) {
+        if (error) {
+            // eslint-disable-next-line no-console
+            console.error(error);
+        }
+        process.exit(exitCode);
+    }
+};
 const schematicsCliOptions = Object.entries(argv)
-    .filter(([key]) => key !== '_')
+    .filter(([key]) => key !== '_' && !optionsList.includes(key))
     .map(([key, value]) => value === true && [key] || value === false && key.length > 1 && [`no-${key}`] || [key, value])
     .map(([key, value]) => {
     const optionKey = key.length > 1 ? `--${key}` : `-${key}`;
@@ -111,30 +128,77 @@ const createNgProject = () => {
     const options = schematicsCliOptions
         .filter(([key]) => isNgNewOptions(key))
         .flat();
-    const { error } = (0, node_child_process_1.spawnSync)(process.execPath, [binPath, 'new', ...argv._, ...options, '--skip-install'], {
-        stdio: 'inherit'
+    exitProcessIfErrorInSpawnSync(1, (0, node_child_process_1.spawnSync)(`"${process.execPath}"`, [binPath, 'new', ...argv._, ...options], {
+        stdio: 'inherit',
+        shell: true
+    }));
+};
+const prepareWorkspace = (relativeDirectory = '.', projectPackageManager = 'npm') => {
+    const cwd = (0, node_path_1.resolve)(process.cwd(), relativeDirectory);
+    const runner = process.platform === 'win32' ? `${projectPackageManager}.cmd` : projectPackageManager;
+    const mandatoryDependencies = [
+        '@angular-devkit/schematics',
+        '@schematics/angular',
+        '@angular-devkit/core',
+        '@angular-devkit/architect',
+        '@o3r/schematics'
+    ];
+    const packageJsonPath = (0, node_path_1.resolve)(cwd, 'package.json');
+    const packageJson = JSON.parse((0, node_fs_1.readFileSync)(packageJsonPath, { encoding: 'utf-8' })
+        // Replace the ^ with ~ to use the same minor version for angular packages as @angular/cli
+        .replace(/(@(?:angular|schematics).*)\^/g, '$1~'));
+    packageJson.devDependencies ||= {};
+    mandatoryDependencies.forEach((dep) => {
+        packageJson.devDependencies[dep] = dependencies?.[dep] || devDependencies?.[dep] || 'latest';
     });
-    if (error) {
-        // eslint-disable-next-line no-console
-        console.error(error);
-        process.exit(1);
+    if (exactO3rVersion) {
+        const o3rPackages = ['@o3r/core', '@o3r/schematics', '@o3r/workspace'];
+        const resolutions = {};
+        o3rPackages.forEach((pkg) => {
+            if (packageJson.devDependencies?.[pkg]) {
+                packageJson.devDependencies[pkg] = version;
+            }
+            resolutions[pkg] = version;
+        });
+        if (projectPackageManager === 'yarn') {
+            packageJson.resolutions = resolutions;
+        }
+        else {
+            packageJson.overrides = resolutions;
+        }
     }
+    (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
+        }));
+    }
+    exitProcessIfErrorInSpawnSync(2, (0, node_child_process_1.spawnSync)(runner, ['install'], {
+        stdio: 'inherit',
+        shell: true,
+        cwd
+    }));
 };
-const addOtterFramework = (relativeDirectory = '.') => {
+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();
-    const { error } = (0, node_child_process_1.spawnSync)(process.execPath, [binPath, 'add', `@o3r/core@${version || 'latest'}`, ...options], {
+    exitProcessIfErrorInSpawnSync(3, (0, node_child_process_1.spawnSync)(runner, ['exec', 'ng', 'add', `@o3r/core@${exactO3rVersion ? '' : '~'}${version}`, ...(projectPackageManager === 'npm' ? ['--'] : []), ...options], {
         stdio: 'inherit',
-        cwd
-    });
-    if (error) {
-        // eslint-disable-next-line no-console
-        console.error(error);
-        process.exit(2);
-    }
+        cwd,
+        shell: true,
+        env: exactO3rVersion && projectPackageManager === 'npm' ? {
+            ...process.env,
+            // eslint-disable-next-line @typescript-eslint/naming-convention, camelcase
+            NPM_CONFIG_SAVE_EXACT: 'true'
+        } : undefined
+    }));
 };
 const projectFolder = argv._[0]?.replaceAll(' ', '-').toLowerCase() || '.';
 console.info(logo);
 createNgProject();
-addOtterFramework(projectFolder);
+prepareWorkspace(projectFolder, packageManager);
+addOtterFramework(projectFolder, packageManager);

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@o3r/create",
-  "version": "11.0.0-next.0",
+  "version": "11.0.0-next.2",
+  "publishConfig": {
+    "access": "public"
+  },
   "description": "Create a new Otter based application",
   "keywords": [
     "create",
@@ -15,46 +18,54 @@
     "prepare:publish": "prepare-publish ./dist"
   },
   "dependencies": {
-    "@angular/cli": "~17.0.3",
-    "@schematics/angular": "~17.0.3",
+    "@angular/cli": "~17.3.0",
+    "@schematics/angular": "~17.3.0",
     "minimist": "^1.2.6",
-    "tslib": "^2.5.3"
+    "tslib": "^2.6.2",
+    "type-fest": "^4.10.2"
   },
   "devDependencies": {
-    "@angular-eslint/eslint-plugin": "~17.1.0",
-    "@angular-eslint/eslint-plugin-template": "~17.1.0",
-    "@nx/eslint": "~17.1.1",
-    "@nx/eslint-plugin": "~17.1.1",
-    "@nx/jest": "~17.1.1",
-    "@nx/js": "~17.1.1",
-    "@o3r/build-helpers": "^11.0.0-next.0",
-    "@o3r/eslint-config-otter": "^11.0.0-next.0",
-    "@o3r/eslint-plugin": "^11.0.0-next.0",
-    "@o3r/test-helpers": "^11.0.0-next.0",
+    "@angular-devkit/architect": "~0.1703.0",
+    "@angular-devkit/core": "~17.3.0",
+    "@angular-devkit/schematics": "~17.3.0",
+    "@angular-eslint/eslint-plugin": "~17.3.0",
+    "@angular-eslint/eslint-plugin-template": "~17.3.0",
+    "@nx/eslint": "~18.3.0",
+    "@nx/eslint-plugin": "~18.3.0",
+    "@nx/jest": "~18.3.0",
+    "@nx/js": "~18.3.0",
+    "@o3r/build-helpers": "^11.0.0-next.2",
+    "@o3r/eslint-config-otter": "^11.0.0-next.2",
+    "@o3r/eslint-plugin": "^11.0.0-next.2",
+    "@o3r/schematics": "^11.0.0-next.2",
+    "@o3r/test-helpers": "^11.0.0-next.2",
+    "@stylistic/eslint-plugin-ts": "^1.5.4",
     "@types/jest": "~29.5.2",
     "@types/minimist": "^1.2.2",
     "@types/node": "^20.0.0",
-    "@typescript-eslint/eslint-plugin": "6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
     "cpy-cli": "^5.0.0",
-    "eslint": "^8.42.0",
-    "eslint-import-resolver-node": "^0.3.4",
-    "eslint-plugin-jest": "~27.6.0",
-    "eslint-plugin-jsdoc": "~48.0.0",
+    "eslint": "^8.57.0",
+    "eslint-import-resolver-node": "^0.3.9",
+    "eslint-plugin-jest": "~27.9.0",
+    "eslint-plugin-jsdoc": "~48.2.1",
     "eslint-plugin-prefer-arrow": "~1.2.3",
-    "eslint-plugin-unicorn": "^50.0.0",
+    "eslint-plugin-unicorn": "^51.0.1",
     "jest": "~29.7.0",
     "jest-junit": "~16.0.0",
     "jsonc-eslint-parser": "~2.4.0",
-    "nx": "~17.1.1",
+    "nx": "~18.3.0",
     "rimraf": "^5.0.1",
     "rxjs": "^7.8.1",
-    "ts-jest": "~29.1.1",
-    "type-fest": "^4.3.1",
-    "typescript": "~5.2.2"
+    "ts-jest": "~29.1.2",
+    "type-fest": "^4.10.2",
+    "typescript": "~5.4.2"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18.0.0",
+    "yarn": "<2.0.0",
+    "npm": "*"
   },
   "contributors": [
     {