3.0.14

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,109 +18,114 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - 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:
-  - docker
-  - notpriv
+    - docker
+
+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 --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -128,15 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
-  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${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

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,29 +0,0 @@
-# smartcli
-
-nodejs wrapper for CLI related tasks
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartcli)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartcli)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartcli)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartcli/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartcli/badges/master/build.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)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartcli.svg)](https://www.npmjs.com/package/smartcli)
-[![Dependency Status](https://david-dm.org/pushrocks/smartcli.svg)](https://david-dm.org/pushrocks/smartcli)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartcli/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartcli/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartcli/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartcli)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://)

docs/index.md

@@ -23,45 +23,6 @@ nodejs wrapper for CLI related tasks
 
 ## Usage
 
-this plugin tries to establish some logic in which CLI tools work.
-
-take the following commandline input:
-
-```
-mytool command argument1 argument2 --option1 -o2 option2Value
-```
-
-- `mytool` obviously is the tool (like git)
-- `command` is the main thing the tool shall do (like commit)
-- `argument1` and `argument2` are arguments
-- `option1` is a longform option you can add (like --message for message)
-- `optionValue` is the referenced option value (like a commit message)
-
-When there is no command and no option specified the standardTask applied.
-When there is a option specified but no command, standardTask applies,
-except when of the options is -v, --version or --help.
-
-```javascript
-import { Smartcli } from 'smartcli';
-mySmartcli = new Smartcli();
-mySmartcli.standardTask().then(argvArg => {
-  // do something if program is called without an command
-});
-
-mySmartcli.addCommand({ commandname: 'install' }).then(argvArg => {
-  // do something if program is called with command "install"
-});
-
-mySmartcli.addVersion('1.0.0'); // -v and --version options will display the specified version in the terminal
-
-mySmartCli.addHelp({
-  // is triggered by help command and --help option
-  helpText: 'some help text to print' // the helpText to display
-});
-
-mySmartcli.startParse(); // starts the evaluation and fullfills or rejects promises.
-```
-
 For further information read the linked docs at the top of this README.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

npmextra.json

@@ -1,9 +1,17 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts",
-      "ts-node"
-    ],
+    "npmGlobalTools": [],
     "npmAccesslevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartcli",
+      "shortDescription": "easy observable cli tasks",
+      "npmPackagename": "@pushrocks/smartcli",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartcli",
   "private": false,
-  "version": "3.0.4",
-  "description": "nodejs wrapper for CLI related tasks",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "version": "3.0.14",
+  "description": "easy observable cli tasks",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -26,19 +26,36 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartcli",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.1",
-    "@pushrocks/smartlog": "^2.0.1",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@types/yargs": "^11.1.1",
-    "rxjs": "^6.3.0",
-    "smartparam": "1.0.2",
-    "yargs": "^12.0.1"
+    "@pushrocks/lik": "^4.0.20",
+    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartparam": "^1.1.6",
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@types/yargs": "^16.0.1",
+    "rxjs": "^6.6.7",
+    "yargs": "^16.2.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.5",
-    "@types/node": "^10.9.4"
-  }
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^14.14.37",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,76 @@
+# @pushrocks/smartcli
+easy observable cli tasks
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartcli)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartcli)
+* [github.com (source mirror)](https://github.com/pushrocks/smartcli)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartcli/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartcli/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartcli/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartcli)](https://lossless.cloud)
+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
+
+this plugin tries to establish some logic in which CLI tools work.
+
+take the following commandline input:
+
+```
+mytool command argument1 argument2 --option1 -o2 option2Value
+```
+
+- `mytool` obviously is the tool (like git)
+- `command` is the main thing the tool shall do (like commit)
+- `argument1` and `argument2` are arguments
+- `option1` is a longform option you can add (like --message for message)
+- `optionValue` is the referenced option value (like a commit message)
+
+When there is no command and no option specified the standardTask applied.
+When there is a option specified but no command, standardTask applies,
+except when of the options is -v, --version or --help.
+
+```javascript
+import { Smartcli } from 'smartcli';
+mySmartcli = new Smartcli();
+mySmartcli.standardTask().then((argvArg) => {
+  // do something if program is called without an command
+});
+
+mySmartcli.addCommand({ commandname: 'install' }).then((argvArg) => {
+  // do something if program is called with command "install"
+});
+
+mySmartcli.addVersion('1.0.0'); // -v and --version options will display the specified version in the terminal
+
+mySmartCli.addHelp({
+  // is triggered by help command and --help option
+  helpText: 'some help text to print', // the helpText to display
+});
+
+mySmartcli.startParse(); // starts the evaluation and fullfills or rejects promises.
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

ts/smartcli.classes.smartcli.ts

@@ -1,10 +1,10 @@
-import * as smartq from 'smartq';
+import * as smartpromise from '@pushrocks/smartpromise';
 import { Subject } from 'rxjs';
 
 import * as plugins from './smartcli.plugins';
 
 // import classes
-import { Objectmap } from '@pushrocks/lik';
+import { ObjectMap } from '@pushrocks/lik';
 
 // interfaces
 export interface ICommandPromiseObject {
@@ -17,37 +17,39 @@ export interface ITriggerObservableObject {
   subject: Subject<any>;
 }
 
+const logger = new plugins.smartlog.ConsoleLog();
+
 /**
  * class to create a new instance of Smartcli. Handles parsing of command line arguments.
  */
 export class Smartcli {
   argv: any;
   questionsDone;
-  parseStarted: smartq.Deferred<any>;
+  parseStarted: smartpromise.Deferred<any>;
   commands;
   questions;
   version: string;
-  private onlyOnProcessEnvCliCall = false;
+  private checkForEnvCliCall = true;
 
   /**
    * map of all Trigger/Observable objects to keep track
    */
-  allTriggerObservablesMap = new Objectmap<ITriggerObservableObject>();
+  allTriggerObservablesMap = new ObjectMap<ITriggerObservableObject>();
 
   /**
    * The constructor of Smartcli
    */
   constructor() {
     this.argv = plugins.yargs;
-    this.questionsDone = smartq.defer();
-    this.parseStarted = smartq.defer();
+    this.questionsDone = smartpromise.defer();
+    this.parseStarted = smartpromise.defer();
   }
 
   /**
    * halts any execution of commands if (process.env.CLI_CALL === false)
    */
-  onlyTriggerOnProcessEnvCliCall() {
-    this.onlyOnProcessEnvCliCall = true;
+  disableEnvCliCall() {
+    this.checkForEnvCliCall = false;
   }
 
   /**
@@ -63,7 +65,7 @@ export class Smartcli {
    * Note: in e.g. "npm install something" the "install" is considered the command.
    */
   addCommand(commandNameArg: string): Subject<any> {
-    let triggerSubject = this.addTrigger(commandNameArg);
+    const triggerSubject = this.addTrigger(commandNameArg);
     this.parseStarted.promise.then(() => {
       if (this.argv._.indexOf(commandNameArg) === 0) {
         this.trigger(commandNameArg);
@@ -76,11 +78,11 @@ export class Smartcli {
    * adds a Trigger. Like addCommand(), but returns an subscribable observable
    */
   addTrigger(triggerNameArg: string) {
-    let triggerSubject = new Subject<any>();
+    const triggerSubject = new Subject<any>();
     if (!this.getTriggerSubject(triggerNameArg)) {
       this.allTriggerObservablesMap.add({
         triggerName: triggerNameArg,
-        subject: triggerSubject
+        subject: triggerSubject,
       });
     } else {
       throw new Error(`you can't add a trigger twice`);
@@ -93,14 +95,14 @@ export class Smartcli {
    * @param commandNameArg - the name of the command to trigger
    */
   trigger(triggerName: string) {
-    let triggerSubject = this.getTriggerSubject(triggerName);
+    const triggerSubject = this.getTriggerSubject(triggerName);
     triggerSubject.next(this.argv);
     return triggerSubject;
   }
 
   getTriggerSubject(triggerName: string) {
     const triggerObservableObject = this.allTriggerObservablesMap.find(
-      triggerObservableObjectArg => {
+      (triggerObservableObjectArg) => {
         return triggerObservableObjectArg.triggerName === triggerName;
       }
     );
@@ -115,8 +117,8 @@ export class Smartcli {
    * allows to specify help text to be printed above the rest of the help text
    */
   addHelp(optionsArg: { helpText: string }) {
-    this.addCommand('help').subscribe(argvArg => {
-      plugins.smartlog.defaultLogger.info(optionsArg.helpText);
+    this.addCommand('help').subscribe((argvArg) => {
+      logger.log('info', optionsArg.helpText);
     });
   }
 
@@ -137,18 +139,14 @@ export class Smartcli {
    * adds a trigger that is called when no command is specified
    */
   standardTask(): Subject<any> {
-    let standardSubject = this.addTrigger('standardTask');
+    const standardSubject = this.addTrigger('standardTask');
     this.parseStarted.promise.then(() => {
-      if (this.argv._.length === 0 && !this.argv.v) {
-        if (this.onlyOnProcessEnvCliCall) {
-          if (process.env.CLI_CALL === 'true') {
-            this.trigger('standardTask');
-          } else {
-            return;
-          }
-        } else {
-          this.trigger('standardTask');
-        }
+      if (
+        (this.argv._.length === 0 ||
+          (this.argv._.length === 1 && this.argv._[0].startsWith('test/'))) &&
+        !this.argv.v
+      ) {
+        this.trigger('standardTask');
       }
     });
     return standardSubject;
@@ -158,6 +156,12 @@ export class Smartcli {
    * start the process of evaluating commands
    */
   startParse(): void {
+    if (!process.env.CLI_CALL && this.checkForEnvCliCall) {
+      console.log(
+        `note: @pushrocks/smartcli: You called .startParse() on a SmartCli instance. However process.env.CLI_CALL being absent prevented parsing.`
+      );
+      return;
+    }
     this.argv = this.argv.argv;
     this.parseStarted.resolve();
     return;

ts/smartcli.plugins.ts

@@ -2,6 +2,6 @@ import * as yargs from 'yargs';
 import * as smartlog from '@pushrocks/smartlog';
 import * as lik from '@pushrocks/lik';
 import * as path from 'path';
-import * as smartparam from 'smartparam';
+import * as smartparam from '@pushrocks/smartparam';
 
 export { yargs, smartlog, lik, path, smartparam };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }