@p8ec/shared 2.4.2 → 2.5.1

package/README.md

@@ -7,6 +7,7 @@ Shared TypeScript/JavaScript libraries for P(8) products.
 Shared (**and very opinionated**) configuration for P(8) projects.
 
 **Contents:**
+
 - ESLint configuration
 - Prettier configuration
 - Commitlint configuration
@@ -62,9 +63,16 @@ p8-cli [command] [options]
 
 ### Commands
 
-- `init` - Initialize P(8) shared configuration in your project. Options: `cleanup` - remove configuration entries from `package.json`
-  - Example: `p8-cli init --cleanup` - initializes the shared configuration and removes corresponding entries from `package.json`.
+- `init` - Initialize P(8) shared configuration in your project. Options: `cleanup` - remove configuration entries from
+  `package.json`
+    - Example: `p8-cli init --cleanup` - initializes the shared configuration and removes corresponding entries from
+      `package.json`.
 - `dirn` - Get the directory name. Options: `0` - current directory (default), `1` - parent directory, `2` - 2 levels up
   directory, etc.
-  - Example: `p8-cli dirn 1` - shows the parent directory name.
-
+    - Example: `p8-cli dirn 1` - shows the parent directory name.
+- `run` - Returns a script string using the detected or specified package manager. Options: `script` - script name,
+  `packageManager` - npm, yarn, or pnpm (auto-detected by default), `workspaceMode` - mode of concurrency for workspaces
+  (if applicable): `seq` (default) or `par`.
+    - Example: `p8-cli run build` - runs the `build` script using the detected package manager.
+    - Example: `p8-cli run test pnpm par` - runs the `test` script using
+      `pnpm` in parallel mode for workspaces.

package/dist/cjs/bin/p8-shared-cli.js

@@ -50,30 +50,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = exports.dirn = exports.init = exports.detectPackageManager = exports.initCleanup = exports.cliUtils = exports.IS_DEV = void 0;
 /**
  * P8 Shared CLI tool.
  *
  * This tool is used to simplify the process of creating new P8 components.
  *
  */
-const path = __importStar(require("path"));
-const fs = __importStar(require("fs"));
+const path = __importStar(require("node:path"));
+const fs = __importStar(require("node:fs"));
 const ferramenta_1 = require("ferramenta");
 const yesno_1 = __importDefault(require("./utils/yesno"));
 const prompt_1 = __importDefault(require("./utils/prompt"));
 const child_process = __importStar(require("node:child_process"));
-const IS_DEV = process.env.NODE_ENV === 'development';
+exports.IS_DEV = process.env.NODE_ENV === 'development';
 let args = ferramenta_1.processArgs.args;
 const self = path.parse(ferramenta_1.processArgs.name).name;
 const writeLn = console.log;
-const execShell = (command) => IS_DEV ? writeLn(`DEV: execShell ${command}`) : child_process.execSync(command).toString();
-const writeFile = (name, data) => IS_DEV ? writeLn(`DEV: writeFile name=${name} data=${data}`) : fs.writeFileSync(path.join(process.cwd(), name), data);
-const copyAsset = (name) => IS_DEV
-    ? writeLn(`DEV: copyAsset name=${name}`)
-    : fs.copyFileSync(path.join(__dirname, '..', '..', 'assets', name), path.join(process.cwd(), name));
-if (args.length === 0 && !IS_DEV) {
+exports.cliUtils = {
+    execShell: (command) => exports.IS_DEV ? writeLn(`DEV: execShell ${command}`) : child_process.execSync(command).toString(),
+    writeFile: (name, data) => exports.IS_DEV
+        ? writeLn(`DEV: writeFile name=${name} data=${data}`)
+        : fs.writeFileSync(path.join(process.cwd(), name), data),
+    copyAsset: (name) => exports.IS_DEV
+        ? writeLn(`DEV: copyAsset name=${name}`)
+        : fs.copyFileSync(path.join(__dirname, '..', '..', 'assets', name), path.join(process.cwd(), name)),
+};
+if (args.length === 0 && !exports.IS_DEV && require.main === module) {
     writeLn(`
-Usage: ${self} [command] [options]
+Usage: ${self} {command} [options]
 
 Commands:
 	init [cleanup]
@@ -84,8 +89,22 @@ Commands:
 		Returns the directory name of the caller.
 			Options:
 				levelsUp: The number of levels up to return the directory name.
+	run [script [packageManager [workspaceMode]]]
+		Returns a command to run a script with the specified package manager.
+			Options:
+				script: The script to run.
+					- 'start': Starts the application.
+					- 'build': Builds the application.
+					- 'test': Runs tests.
+					- 'lint': Lints the application.
+					- 'start-workspace': Starts the workspace.
+					- 'build-workspace': Builds the workspace.
+					- 'test-workspace': Runs tests in the workspace.
+					- 'lint-workspace': Lints the workspace.
+				packageManager: The package manager to use (npm, yarn, pnpm). Defaults to npm.
+				workspaceMode: Whether to run in workspace mode (seq or par for pnpm). Defaults to none.
 `);
-    if (IS_DEV) {
+    if (exports.IS_DEV) {
         writeLn(`DEVELOPMENT MODE`);
     }
     process.exit(1);
@@ -102,21 +121,48 @@ const initCleanup = (packageJson) => {
             delete packageJson[section];
         }
     });
-    writeFile(`${configBackupFile}`, JSON.stringify(configBackup, null, 2));
-    writeFile('package.json', JSON.stringify(packageJson, null, 2));
+    exports.cliUtils.writeFile(`${configBackupFile}`, JSON.stringify(configBackup, null, 2));
+    exports.cliUtils.writeFile('package.json', JSON.stringify(packageJson, null, 2));
 };
+exports.initCleanup = initCleanup;
+/**
+ * Detects the package manager used in the project.
+ */
+const detectPackageManager = (cwd = process.cwd()) => {
+    if (fs.existsSync(path.join(cwd, 'pnpm-lock.yaml'))) {
+        return 'pnpm';
+    }
+    if (fs.existsSync(path.join(cwd, 'yarn.lock'))) {
+        return 'yarn';
+    }
+    return 'npm';
+};
+exports.detectPackageManager = detectPackageManager;
 /**
  * Initializes a TypeScript project with P8 shared configurations.
  */
-const init = (option) => __awaiter(void 0, void 0, void 0, function* () {
-    const packageJson = JSON.parse(String(fs.readFileSync(path.join(process.cwd(), 'package.json'))));
+const init = (option_1, ...args_1) => __awaiter(void 0, [option_1, ...args_1], void 0, function* (option, packageManager = (0, exports.detectPackageManager)()) {
+    var _a;
+    const packageJsonData = fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8');
+    const packageJson = JSON.parse(packageJsonData);
     const moduleType = packageJson['type'] === 'module' ? 'mjs' : 'cjs';
     writeLn(`Creating eslint.config.${moduleType}...`);
-    copyAsset(`eslint.config.${moduleType}`);
+    exports.cliUtils.copyAsset(`eslint.config.${moduleType}`);
     writeLn(`Creating prettier.config.${moduleType}...`);
-    copyAsset(`prettier.config.${moduleType}`);
-    packageJson.scripts['npm:reset'] = 'rm -rf ./**/node_modules && rm -rf ./**/package-lock.json && npm install';
-    packageJson.scripts['npm:audit'] = 'npm audit --audit-level=moderate';
+    exports.cliUtils.copyAsset(`prettier.config.${moduleType}`);
+    (_a = packageJson.scripts) !== null && _a !== void 0 ? _a : (packageJson.scripts = {});
+    packageJson.scripts[`${packageManager}:reset`] =
+        packageManager === 'pnpm'
+            ? 'rm -rf ./**/node_modules && rm -rf ./**/pnpm-lock.yaml && pnpm install'
+            : packageManager === 'yarn'
+                ? 'rm -rf ./**/node_modules && rm -rf ./**/yarn.lock && yarn install'
+                : 'rm -rf ./**/node_modules && rm -rf ./**/package-lock.json && npm install';
+    packageJson.scripts[`${packageManager}:audit`] =
+        packageManager === 'pnpm'
+            ? 'pnpm audit'
+            : packageManager === 'yarn'
+                ? 'yarn npm audit'
+                : 'npm audit --audit-level=moderate';
     const lefthook = yield (0, yesno_1.default)({
         question: 'Do you want to use commitlint/lefthook? [y]n',
         defaultValue: true,
@@ -125,28 +171,30 @@ const init = (option) => __awaiter(void 0, void 0, void 0, function* () {
     });
     if (lefthook) {
         writeLn(`Creating commitlint.config.${moduleType}...`);
-        copyAsset(`commitlint.config.${moduleType}`);
+        exports.cliUtils.copyAsset(`commitlint.config.${moduleType}`);
         writeLn('Creating lefthook.yml...');
-        copyAsset('lefthook.yml');
+        exports.cliUtils.copyAsset('lefthook.yml');
         writeLn('Adding lefthook install to postinstall...');
         const lefthookInstall = 'lefthook install';
         packageJson.scripts.postinstall = lefthookInstall;
-        const npmInstall = 'npm install --save-dev @commitlint/{config-conventional,cli} commitlint lefthook';
-        const pnpmInstall = 'pnpm install -D @commitlint/{config-conventional,cli} commitlint lefthook';
+        const installCommands = {
+            npm: 'npm install --save-dev @commitlint/{config-conventional,cli} commitlint lefthook',
+            pnpm: 'pnpm install -D @commitlint/{config-conventional,cli} commitlint lefthook',
+            yarn: 'yarn add -D @commitlint/config-conventional @commitlint/cli commitlint lefthook',
+        };
+        const installCommand = installCommands[packageManager];
         if (yield (0, yesno_1.default)({
-            question: `Do you want to run "${npmInstall}" now? [y]n`,
+            question: `Do you want to run "${installCommand}" now? [y]n`,
             defaultValue: true,
             yesValues: ['yes', 'y'],
             noValues: ['no', 'n'],
         })) {
-            writeLn(`Executing ${npmInstall}...`);
-            execShell(npmInstall);
+            writeLn(`Executing ${installCommand}...`);
+            exports.cliUtils.execShell(installCommand);
         }
         else {
             writeLn('You could run the following command to install needed dependencies:');
-            writeLn(npmInstall);
-            writeLn('Or, for pnpm users:');
-            writeLn(pnpmInstall);
+            writeLn(installCommand);
         }
         if (yield (0, yesno_1.default)({
             question: `Do you want to run "${lefthookInstall}" now? [y]n`,
@@ -155,17 +203,18 @@ const init = (option) => __awaiter(void 0, void 0, void 0, function* () {
             noValues: ['no', 'n'],
         })) {
             writeLn(`Executing ${lefthookInstall}...`);
-            execShell(lefthookInstall);
+            exports.cliUtils.execShell(lefthookInstall);
         }
     }
     if (option === null || option === void 0 ? void 0 : option.split(',').includes('cleanup')) {
-        initCleanup(packageJson);
+        (0, exports.initCleanup)(packageJson);
     }
     else {
         writeLn('Skipping cleanup...');
-        writeFile('package.json', JSON.stringify(packageJson, null, 2));
+        exports.cliUtils.writeFile('package.json', JSON.stringify(packageJson, null, 2));
     }
 });
+exports.init = init;
 /**
  * Returns the directory name of the caller, optionally returns a directory name specified levels up.
  */
@@ -175,33 +224,70 @@ const dirn = (levelsUp) => {
     const levels = parseInt(levelsUp) || DEFAULT_LEVELS_UP;
     return process.cwd().split(path.sep).reverse()[levels];
 };
-const setup = () => __awaiter(void 0, void 0, void 0, function* () {
+exports.dirn = dirn;
+const run = (script, packageManager = (0, exports.detectPackageManager)(), workspaceMode = 'none') => {
+    var _a;
+    const pnpmWorkspaceSeq = '-r --workspace-concurrency=1 --if-present --reporter-hide-prefix';
+    const pnpmWorkspacePar = '-r --if-present --parallel';
+    const yarnWorkspaceSeq = 'workspaces foreach -A';
+    const yarnWorkspacePar = 'workspaces foreach -A -p';
+    const commands = {
+        npm: {
+            none: `npm run ${script}`,
+            seq: `npm run ${script} --workspaces --if-present`,
+        },
+        yarn: {
+            none: `yarn run ${script}`,
+            seq: `yarn ${yarnWorkspaceSeq} run ${script}`,
+            par: `yarn ${yarnWorkspacePar} run ${script}`,
+        },
+        pnpm: {
+            none: `pnpm run ${script}`,
+            seq: `pnpm ${pnpmWorkspaceSeq} run ${script}`,
+            par: `pnpm ${pnpmWorkspacePar} run ${script}`,
+        },
+    };
+    if (!commands[packageManager]) {
+        throw new Error(`Unknown package manager: ${packageManager}`);
+    }
+    if (!((_a = commands[packageManager]) === null || _a === void 0 ? void 0 : _a[workspaceMode])) {
+        throw new Error(`Unknown workspace mode: ${workspaceMode}`);
+    }
+    return commands[packageManager][workspaceMode];
+};
+exports.run = run;
+const main = () => __awaiter(void 0, void 0, void 0, function* () {
     // Ask the user for arguments if IS_DEV is true
-    if (IS_DEV) {
+    if (exports.IS_DEV) {
         args = (yield (0, prompt_1.default)('Enter arguments: ')).split(' ');
     }
     switch (args[0]) {
         case 'init':
-            yield init(args[1]);
+            yield (0, exports.init)(args[1]);
             break;
         case 'dirn':
-            writeLn(dirn(args[1]));
+            writeLn((0, exports.dirn)(args[1]));
+            break;
+        case 'run':
+            writeLn((0, exports.run)(args[1], args[2]));
             break;
         default:
             console.error(`Unknown command: ${args[0]}`);
             process.exit(1);
     }
 });
-setup()
-    .then((r) => {
-    if (IS_DEV) {
-        writeLn(`DEV: setup completed with result: ${r}`);
-    }
-})
-    .catch((err) => {
-    if (IS_DEV) {
-        writeLn(`DEV: setup failed with error: ${err}`);
-    }
-    console.error(`Error: ${err}`);
-    process.exit(1);
-});
+if (require.main === module) {
+    main()
+        .then((r) => {
+        if (exports.IS_DEV) {
+            writeLn(`DEV: setup completed with result: ${r}`);
+        }
+    })
+        .catch((err) => {
+        if (exports.IS_DEV) {
+            writeLn(`DEV: setup failed with error: ${err}`);
+        }
+        console.error(`Error: ${err}`);
+        process.exit(1);
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@p8ec/shared",
-	"version": "2.4.2",
+	"version": "2.5.1",
 	"description": "P(8) Global Shared Library for Javascript",
 	"repository": {
 		"type": "git",