AAE-39314 Break dependencies on the "commander" lib in the CLI (#11299)

Author: DenysVuika

lib/cli/README.md

@@ -18,12 +18,24 @@ adf-cli <command> --help
 
 ## Developing
 
-Link the project as a global tool
+### Quick Setup
+
+Link the project as a global tool (builds and links in one command):
 
 ```bash
-npm link
+npm run link
 ```
 
+This will build the CLI and make the `adf-cli` command available globally on your system.
+
+When you're done developing:
+
+```bash
+npm run unlink
+```
+
+### Development Mode
+
 Build the tool in the **develop** mode (automatically watches for changes and rebuilds the commands):
 
 ```bash
@@ -38,6 +50,21 @@ DEVELOP=true adf-cli <command>
 
 In develop mode, the CLI takes the prebuilt scripts from the dist folder.
 
+### Manual Workflow
+
+If you need more control, you can manually build and link:
+
+```bash
+# Build the CLI
+npm run build
+
+# Or build with full distribution (includes copying resources)
+npm run dist
+
+# Link from the dist directory
+cd ../../dist/libs/cli && npm link
+```
+
 ## Commands
 
 | **Commands**     | **Description**                                                |

lib/cli/bin/adf-cli

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const minimist = require('minimist');
+const { parseArgs } = require('node:util');
 const { resolve, join }  = require('node:path');
 const { readFileSync, existsSync } = require('node:fs');
 const { argv, exit, env, cwd } = require('node:process');
@@ -10,10 +10,22 @@ function printHelp() {
     console.log(`${name} v${version}`);
 }
 
-const args = minimist(argv.slice(2), {
-    boolean: ['verbose']
+const { values, positionals } = parseArgs({
+    args: argv.slice(2),
+    options: {
+        verbose: {
+            type: 'boolean'
+        }
+    },
+    allowPositionals: true,
+    strict: false
 });
 
+const args = {
+    ...values,
+    _: positionals
+};
+
 if (args._.length === 0) {
     printHelp();
     exit(1);

lib/cli/package.json

@@ -17,15 +17,15 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "develop": "tsc -p tsconfig.json --watch",
-    "dist": "rm -rf ../../dist/libs/cli && npm run build && cp -R ./bin ../../dist/libs/cli && cp -R ./resources ../../dist/libs/cli && cp -R ./templates ../../dist/libs/cli && cp ./package.json ../../dist/libs/cli"
+    "dist": "rm -rf ../../dist/libs/cli && npm run build && cp -R ./bin ../../dist/libs/cli && cp -R ./resources ../../dist/libs/cli && cp -R ./templates ../../dist/libs/cli && cp ./package.json ../../dist/libs/cli",
+    "link": "npm run dist && cd ../../dist/libs/cli && npm link",
+    "unlink": "cd ../../dist/libs/cli && npm unlink"
   },
   "dependencies": {
     "@alfresco/js-api": ">=8.4.0-0",
-    "commander": "^6.2.1",
     "ejs": "^3.1.10",
     "license-checker": "^25.0.1",
     "node-fetch": "^2.7.0",
-    "rxjs": "7.8.2",
     "shelljs": "^0.10.0",
     "spdx-license-list": "^5.0.0"
   },

lib/cli/scripts/audit.ts

@@ -22,9 +22,7 @@ import * as ejs from 'ejs';
 import * as path from 'path';
 import * as fs from 'fs';
 import { argv, exit } from 'node:process';
-import { Command } from 'commander';
-
-const program = new Command();
+import { parseArgs } from 'node:util';
 
 interface AuditCommandArgs {
     package?: string;
@@ -39,19 +37,39 @@ interface AuditCommandArgs {
  * @returns void
  */
 export default function main(_args: string[], workingDir: string) {
-    program
-        .description('Generate an audit report')
-        .usage('audit [options]')
-        .option('-p, --package <path>', 'Path to package file (default: package.json in working directory)')
-        .option('-d, --outDir <dir>', 'Ouput directory (default: working directory)')
-        .parse(argv);
-
     if (argv.includes('-h') || argv.includes('--help')) {
-        program.outputHelp();
+        console.log(`
+Usage: audit [options]
+
+Generate an audit report
+
+Options:
+  -p, --package <path>  Path to package file (default: package.json in working directory)
+  -d, --outDir <dir>    Output directory (default: working directory)
+  -h, --help            Display help for command
+`);
         exit(0);
     }
 
-    const options: AuditCommandArgs = program.opts();
+    const { values } = parseArgs({
+        args: argv.slice(2),
+        options: {
+            package: {
+                type: 'string',
+                short: 'p'
+            },
+            outDir: {
+                type: 'string',
+                short: 'd'
+            }
+        },
+        allowPositionals: true
+    });
+
+    const options: AuditCommandArgs = {
+        package: values.package as string | undefined,
+        outDir: values.outDir as string | undefined
+    };
 
     let packagePath = path.resolve(workingDir, 'package.json');
 

lib/cli/scripts/changelog.ts

@@ -20,15 +20,13 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 
 import { argv, exit } from 'node:process';
+import { parseArgs } from 'node:util';
 import * as shell from 'shelljs';
 import * as path from 'path';
-import { Command } from 'commander';
 import { logger } from './logger';
 import * as fs from 'fs';
 import * as ejs from 'ejs';
 
-const program = new Command();
-
 interface Commit {
     hash: string;
     author: string;
@@ -151,28 +149,74 @@ function commitAuthorAllowed(commit: Commit, authorFilter: string): boolean {
  * @returns void
  */
 export default function main(_args: string[], workingDir: string) {
-    program
-        .description('Generate changelog report for two branches of git repository')
-        .version('0.0.1', '-v, --version')
-        .usage('changelog [options]')
-        .option('-r, --range <range>', 'Commit range, e.g. origin/master..develop', 'origin/master..develop')
-        .option('-d, --dir <dir>', 'Working directory (default: working directory)')
-        .option('-m, --max <number>', 'Limit the number of commits to output')
-        .option('-o, --output <dir>', 'Output directory, will use console output if not defined')
-        .option('--skip <number>', 'Skip number commits before starting to show the commit output')
-        .option('-f, --format <format>', 'Output format (md, html)', 'md')
-        .option('-e --exclude <string>', 'Exclude authors from the output, comma-delimited list')
-        .parse(argv);
-
     if (argv.includes('-h') || argv.includes('--help')) {
-        program.outputHelp();
+        console.log(`
+Usage: changelog [options]
+
+Generate changelog report for two branches of git repository
+
+Options:
+  -v, --version          Output the version number
+  -r, --range <range>    Commit range, e.g. origin/master..develop (default: "origin/master..develop")
+  -d, --dir <dir>        Working directory (default: working directory)
+  -m, --max <number>     Limit the number of commits to output
+  -o, --output <dir>     Output directory, will use console output if not defined
+  --skip <number>        Skip number commits before starting to show the commit output
+  -f, --format <format>  Output format (md, html) (default: "md")
+  -e, --exclude <string> Exclude authors from the output, comma-delimited list
+  -h, --help             Display help for command
+`);
         exit(0);
     }
 
-    const options = program.opts();
+    if (argv.includes('-v') || argv.includes('--version')) {
+        console.log('0.0.1');
+        exit(0);
+    }
+
+    const { values } = parseArgs({
+        args: argv.slice(2),
+        options: {
+            range: {
+                type: 'string',
+                short: 'r',
+                default: 'origin/master..develop'
+            },
+            dir: {
+                type: 'string',
+                short: 'd'
+            },
+            max: {
+                type: 'string',
+                short: 'm'
+            },
+            output: {
+                type: 'string',
+                short: 'o'
+            },
+            skip: {
+                type: 'string'
+            },
+            format: {
+                type: 'string',
+                short: 'f',
+                default: 'md'
+            },
+            exclude: {
+                type: 'string',
+                short: 'e'
+            }
+        },
+        allowPositionals: true
+    });
 
-    const dir = path.resolve(options.dir || workingDir);
-    const { range, skip, max, format, output, exclude } = options;
+    const dir = path.resolve((values.dir as string) || workingDir);
+    const range = values.range as string;
+    const skip = values.skip ? parseInt(values.skip as string, 10) : undefined;
+    const max = values.max ? parseInt(values.max as string, 10) : undefined;
+    const format = values.format as string;
+    const output = values.output as string | undefined;
+    const exclude = values.exclude as string | undefined;
 
     const remote = getRemote(dir);
 

lib/cli/scripts/check-cs-env.ts

@@ -17,7 +17,7 @@
 
 import { AlfrescoApi /*, NodesApi, UploadApi*/ } from '@alfresco/js-api';
 import { argv, exit } from 'node:process';
-import { Command } from 'commander';
+import { parseArgs } from 'node:util';
 import { logger } from './logger';
 
 interface CheckCsEnvArgs {
@@ -27,8 +27,6 @@ interface CheckCsEnvArgs {
     time?: number;
     retry?: number;
 }
-
-const program = new Command();
 const MAX_RETRY = 3;
 const TIMEOUT = 20000;
 
@@ -39,18 +37,63 @@ let alfrescoJsApi: AlfrescoApi;
  * Check CS environment command
  */
 export default async function main() {
-    program
-        .version('0.1.0')
-        .description('Check Content service is up ')
-        .usage('check-cs-env [options]')
-        .option('--host [type]', 'Remote environment host adf.lab.com ')
-        .option('-p, --password [type]', 'password ')
-        .option('-u, --username [type]', 'username ')
-        .option('-t, --time [type]', 'time ')
-        .option('-r, --retry [type]', 'retry ')
-        .parse(argv);
-
-    const opts = program.opts();
+    if (argv.includes('-h') || argv.includes('--help')) {
+        console.log(`
+Usage: check-cs-env [options]
+
+Check Content service is up
+
+Options:
+  -v, --version         Output the version number
+  --host <host>         Remote environment host adf.lab.com
+  -p, --password <pass> Password
+  -u, --username <user> Username
+  -t, --time <ms>       Time in milliseconds
+  -r, --retry <num>     Retry count
+  -h, --help            Display help for command
+`);
+        exit(0);
+    }
+
+    if (argv.includes('-v') || argv.includes('--version')) {
+        console.log('0.1.0');
+        exit(0);
+    }
+
+    const { values } = parseArgs({
+        args: argv.slice(2),
+        options: {
+            host: {
+                type: 'string'
+            },
+            password: {
+                type: 'string',
+                short: 'p'
+            },
+            username: {
+                type: 'string',
+                short: 'u'
+            },
+            time: {
+                type: 'string',
+                short: 't'
+            },
+            retry: {
+                type: 'string',
+                short: 'r'
+            }
+        },
+        allowPositionals: true
+    });
+
+    const opts: CheckCsEnvArgs = {
+        host: values.host as string | undefined,
+        username: values.username as string | undefined,
+        password: values.password as string | undefined,
+        time: values.time ? parseInt(values.time as string, 10) : undefined,
+        retry: values.retry ? parseInt(values.retry as string, 10) : undefined
+    };
+
     await checkEnv(opts);
     // TODO: https://alfresco.atlassian.net/browse/ACS-5873
     // await checkDiskSpaceFullEnv();