4.0.6

.gitlab-ci.yml

@@ -12,30 +12,35 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci git mirror
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
-audit:
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +55,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +66,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +86,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -109,11 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable 
-    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.snyk

@@ -1,9 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.12.0
-# ignores vulnerabilities until expiry date; change duration by modifying expiry date
-ignore:
-  'npm:mem:20180117':
-    - yargs > os-locale > mem:
-        reason: None given
-        expires: '2018-09-29T22:12:38.004Z'
-patch: {}

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartcli",
-      "shortDescription": "easy observable cli tasks",
+      "description": "easy observable cli tasks",
       "npmPackagename": "@pushrocks/smartcli",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,15 @@
 {
   "name": "@pushrocks/smartcli",
   "private": false,
-  "version": "3.0.11",
+  "version": "4.0.6",
   "description": "easy observable cli tasks",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -26,22 +28,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartcli",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.19",
+    "@pushrocks/lik": "^6.0.0",
-    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartlog": "^3.0.1",
     "@pushrocks/smartparam": "^1.1.6",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.3",
-    "@types/yargs": "^15.0.4",
+    "@pushrocks/smartrx": "^2.0.25",
-    "rxjs": "^6.5.5",
+    "yargs-parser": "21.0.1"
-    "yargs": "^15.3.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.22",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^13.11.1",
+    "@types/node": "^18.6.3"
-    "tslint": "^6.1.1",
-    "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/**/*",
@@ -54,5 +53,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,13 +8,20 @@ easy observable cli tasks
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartcli/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smartcli/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartcli/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartcli/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartcli/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartcli.svg)](https://www.npmjs.com/package/@pushrocks/smartcli)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartcli/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartcli)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartcli/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartcli/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartcli)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartcli)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartcli)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartcli)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartcli)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -39,11 +46,11 @@ except when of the options is -v, --version or --help.
 ```javascript
 import { Smartcli } from 'smartcli';
 mySmartcli = new Smartcli();
-mySmartcli.standardTask().then(argvArg => {
+mySmartcli.standardTask().then((argvArg) => {
   // do something if program is called without an command
 });
 
-mySmartcli.addCommand({ commandname: 'install' }).then(argvArg => {
+mySmartcli.addCommand({ commandname: 'install' }).then((argvArg) => {
   // do something if program is called with command "install"
 });
 
@@ -51,7 +58,7 @@ mySmartcli.addVersion('1.0.0'); // -v and --version options will display the spe
 
 mySmartCli.addHelp({
   // is triggered by help command and --help option
-  helpText: 'some help text to print' // the helpText to display
+  helpText: 'some help text to print', // the helpText to display
 });
 
 mySmartcli.startParse(); // starts the evaluation and fullfills or rejects promises.

test/test.ts

@@ -1,43 +1,42 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 import { Subject } from 'rxjs';
 
-import smartcli = require('../ts/index');
+import * as smartcli from '../ts/index.js';
-
-let smartCliTestObject: smartcli.Smartcli;
 
 tap.test('should create a new Smartcli', async () => {
-  smartCliTestObject = new smartcli.Smartcli();
+  const smartCliTestObject = new smartcli.Smartcli();
-  expect(smartCliTestObject).to.be.instanceof(smartcli.Smartcli);
+  expect(smartCliTestObject).toBeInstanceOf(smartcli.Smartcli);
 });
 
-tap.test('should add an command', async () => {
+tap.test('should add an command', async (toolsArg) => {
-  expect(smartCliTestObject.addCommand('awesome')).to.be.instanceOf(Subject);
+  const done = toolsArg.defer();
+  const smartCliTestObject = new smartcli.Smartcli();
+  const awesomeCommandSubject = smartCliTestObject.addCommand('awesome')
+  expect(awesomeCommandSubject).toBeInstanceOf(Subject);
+  awesomeCommandSubject.subscribe(() => {
+    done.resolve();
+  });
+  console.log(process.argv);
+  process.argv.splice(2, 0, 'awesome');
+  console.log(process.argv);
+  smartCliTestObject.startParse();
+  await done.promise;
 });
 
 tap.test('should start parsing a standardTask', async () => {
-  expect(smartCliTestObject.standardTask()).to.be.instanceOf(Subject);
+  const smartCliTestObject = new smartcli.Smartcli();
+  expect(smartCliTestObject.standardCommand()).toBeInstanceOf(Subject);
 });
 
 let hasExecuted: boolean = false;
 
 tap.test('should accept a command', async () => {
-  smartCliTestObject.addTrigger('triggerme').subscribe(() => {
+  const smartCliTestObject = new smartcli.Smartcli();
+  smartCliTestObject.addCommand('triggerme').subscribe(() => {
     hasExecuted = true;
   });
-});
+  smartCliTestObject.triggerCommand('triggerme', {});
-
+  expect(hasExecuted).toBeTrue();
-tap.test('should not have executed yet', async () => {
-  expect(hasExecuted).to.be.false;
-});
-
-tap.test('should execute when triggered', async () => {
-  smartCliTestObject.trigger('triggerme');
-  expect(hasExecuted).be.true;
-});
-
-tap.test('should start parsing the CLI input', async () => {
-  smartCliTestObject.startParse();
-  expect(smartCliTestObject.parseStarted.promise).to.be.instanceOf(Promise);
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartcli',
+  version: '4.0.6',
+  description: 'easy observable cli tasks'
+}

ts/index.ts

@@ -1 +1 @@
-export { Smartcli } from './smartcli.classes.smartcli';
+export { Smartcli } from './smartcli.classes.smartcli.js';

ts/smartcli.classes.smartcli.ts

@@ -1,107 +1,77 @@
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as plugins from './smartcli.plugins.js';
-import { Subject } from 'rxjs';
-
-import * as plugins from './smartcli.plugins';
-
-// import classes
-import { Objectmap } from '@pushrocks/lik';
 
 // interfaces
-export interface ICommandPromiseObject {
+export interface ICommandObservableObject {
   commandName: string;
-  promise: Promise<void>;
+  subject: plugins.smartrx.rxjs.Subject<any>;
 }
 
-export interface ITriggerObservableObject {
+const logger = new plugins.smartlog.ConsoleLog();
-  triggerName: string;
-  subject: Subject<any>;
-}
 
 /**
  * class to create a new instance of Smartcli. Handles parsing of command line arguments.
  */
 export class Smartcli {
-  argv: any;
+  /**
-  questionsDone;
+   * this Deferred contains the parsed result in the end
-  parseStarted: smartpromise.Deferred<any>;
+   */
-  commands;
+  public parseCompleted = plugins.smartpromise.defer<any>();
-  questions;
+
-  version: string;
+  public version: string;
-  private checkForEnvCliCall = true;
 
   /**
    * map of all Trigger/Observable objects to keep track
    */
-  allTriggerObservablesMap = new Objectmap<ITriggerObservableObject>();
+  private commandObservableMap = new plugins.lik.ObjectMap<ICommandObservableObject>();
+
+  /**
+   * maps alias
+   */
+  public aliasObject: { [key: string]: string[] } = {};
 
   /**
    * The constructor of Smartcli
    */
-  constructor() {
+  constructor() {}
-    this.argv = plugins.yargs;
-    this.questionsDone = smartpromise.defer();
-    this.parseStarted = smartpromise.defer();
-  }
-
-  /**
-   * halts any execution of commands if (process.env.CLI_CALL === false)
-   */
-  disableEnvCliCall() {
-    this.checkForEnvCliCall = false;
-  }
 
   /**
    * adds an alias, meaning one equals the other in terms of command execution.
    */
-  addCommandAlias(keyArg, aliasArg): void {
+  public addCommandAlias(originalArg: string, aliasArg: string): void {
-    this.argv = this.argv.alias(keyArg, aliasArg);
+    this.aliasObject[originalArg] = this.aliasObject[originalArg] || [];
-    return;
+    this.aliasObject[originalArg].push(aliasArg);
   }
 
   /**
    * adds a Command by returning a Promise that reacts to the specific commandString given.
    * Note: in e.g. "npm install something" the "install" is considered the command.
    */
-  addCommand(commandNameArg: string): Subject<any> {
+  public addCommand(commandNameArg: string): plugins.smartrx.rxjs.Subject<any> {
-    const triggerSubject = this.addTrigger(commandNameArg);
+    let commandSubject: plugins.smartrx.rxjs.Subject<any>;
-    this.parseStarted.promise.then(() => {
+    const existingCommandSubject = this.getCommandSubject(commandNameArg);
-      if (this.argv._.indexOf(commandNameArg) === 0) {
+    commandSubject = existingCommandSubject || new plugins.smartrx.rxjs.Subject<any>();
-        this.trigger(commandNameArg);
-      }
-    });
-    return triggerSubject;
-  }
 
-  /**
+    this.commandObservableMap.add({
-   * adds a Trigger. Like addCommand(), but returns an subscribable observable
+      commandName: commandNameArg,
-   */
+      subject: commandSubject,
-  addTrigger(triggerNameArg: string) {
+    });
-    const triggerSubject = new Subject<any>();
+    return commandSubject;
-    if (!this.getTriggerSubject(triggerNameArg)) {
-      this.allTriggerObservablesMap.add({
-        triggerName: triggerNameArg,
-        subject: triggerSubject
-      });
-    } else {
-      throw new Error(`you can't add a trigger twice`);
-    }
-    return triggerSubject;
   }
 
   /**
    * execute trigger by name
    * @param commandNameArg - the name of the command to trigger
    */
-  trigger(triggerName: string) {
+  public triggerCommand(commandNameArg: string, argvObject: any) {
-    const triggerSubject = this.getTriggerSubject(triggerName);
+    const triggerSubject = this.getCommandSubject(commandNameArg);
-    triggerSubject.next(this.argv);
+    triggerSubject.next(argvObject);
     return triggerSubject;
   }
 
-  getTriggerSubject(triggerName: string) {
+  public getCommandSubject(commandNameArg: string) {
-    const triggerObservableObject = this.allTriggerObservablesMap.find(
+    const triggerObservableObject = this.commandObservableMap.findSync(
-      triggerObservableObjectArg => {
+      (triggerObservableObjectArg) => {
-        return triggerObservableObjectArg.triggerName === triggerName;
+        return triggerObservableObjectArg.commandName === commandNameArg;
       }
     );
     if (triggerObservableObject) {
@@ -114,52 +84,77 @@ export class Smartcli {
   /**
    * allows to specify help text to be printed above the rest of the help text
    */
-  addHelp(optionsArg: { helpText: string }) {
+  public addHelp(optionsArg: { helpText: string }) {
-    this.addCommand('help').subscribe(argvArg => {
+    this.addCommand('help').subscribe((argvArg) => {
-      plugins.smartlog.defaultLogger.log('info', optionsArg.helpText);
+      logger.log('info', optionsArg.helpText);
     });
   }
 
   /**
    * specify version to be printed for -v --version
    */
-  addVersion(versionArg: string) {
+  public addVersion(versionArg: string) {
     this.version = versionArg;
-    this.addCommandAlias('v', 'version');
-    this.parseStarted.promise.then(() => {
-      if (this.argv.v) {
-        console.log(this.version);
-      }
-    });
   }
 
   /**
    * adds a trigger that is called when no command is specified
    */
-  standardTask(): Subject<any> {
+  public standardCommand(): plugins.smartrx.rxjs.Subject<any> {
-    const standardSubject = this.addTrigger('standardTask');
+    const standardSubject = this.addCommand('standardCommand');
-    this.parseStarted.promise.then(() => {
-      if (
-        (this.argv._.length === 0 ||
-          (this.argv._.length === 1 && this.argv._[0].startsWith('test/'))) &&
-        !this.argv.v
-      ) {
-        this.trigger('standardTask');
-      }
-    });
     return standardSubject;
   }
 
   /**
    * start the process of evaluating commands
    */
-  startParse(): void {
+  public startParse(): void {
-    if (!process.env.CLI_CALL && this.checkForEnvCliCall) {
+    const parsedYArgs = plugins.yargsParser(process.argv);
-      console.log(`note: @pushrocks/smartcli: You called .startParse() on a SmartCli instance. However process.env.CLI_CALL being absent prevented parsing.`);
+
+    // lets handle commands
+    let counter = 0;
+    let foundCommand = false;
+    parsedYArgs._ = parsedYArgs._.filter((commandPartArg) => {
+      counter++;
+      if (typeof commandPartArg === 'number') {
+        return true;
+      }
+      if (counter <= 2 && !foundCommand) {
+        const isPath = commandPartArg.startsWith('/');
+        foundCommand = !isPath;
+        return foundCommand;
+      } else {
+        return true;
+      }
+    });
+    const wantedCommand = parsedYArgs._[0];
+
+    // lets handle some standards
+    if (!wantedCommand && (parsedYArgs.v || parsedYArgs.version)) {
+      console.log(this.version || 'unknown version');
       return;
     }
-    this.argv = this.argv.argv;
+    console.log(`Wanted command: ${wantedCommand}`);
-    this.parseStarted.resolve();
+    for (const command of this.commandObservableMap.getArray()) {
+      if (!wantedCommand) {
+        const standardCommand = this.commandObservableMap.findSync((commandArg) => {
+          return commandArg.commandName === 'standardCommand';
+        });
+        if (standardCommand) {
+          standardCommand.subject.next(parsedYArgs);
+        } else {
+          console.log('no smartcli standard task was created or assigned.');
+        }
+        break;
+      }
+      if (command.commandName === parsedYArgs._[0]) {
+        command.subject.next(parsedYArgs);
+        break;
+      }
+      if (this.aliasObject[parsedYArgs[0]]) {
+      }
+    }
+    this.parseCompleted.resolve(parsedYArgs);
     return;
   }
 }

ts/smartcli.plugins.ts

@@ -1,7 +1,14 @@
-import * as yargs from 'yargs';
+// @pushrocks scope
 import * as smartlog from '@pushrocks/smartlog';
 import * as lik from '@pushrocks/lik';
 import * as path from 'path';
 import * as smartparam from '@pushrocks/smartparam';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
 
-export { yargs, smartlog, lik, path, smartparam };
+export { smartlog, lik, path, smartparam, smartpromise, smartrx };
+
+// thirdparty scope
+import yargsParser from 'yargs-parser';
+
+export { yargsParser };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}