4.0.9

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -1,6 +1,20 @@
-node_modules/
-.settings/
-.idea/
+.nogit/
 
-ts/*.js
-ts/*.js.map
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.travis.yml

@@ -1,20 +0,0 @@
-language: node_js
-before_install:
-- nvm install stable
-- node -v
-- npm -v
-- npm install -g gulp
-- npm install gulp
-- npm install gulp-typescript
-deploy:
-  provider: npm
-  email: npm@smart-coordination.com
-  api_key:
-    secure: XAtA2XHAr96ILKpm1VnB/Nff9hiQv3FUa/NDfGZgvJKimuF/TwU2+kXyAag/LlEQGckZ9/IDx0PTIe8x4wOvg2VyKceYktGt6G5/MHeAXwzkkM253k2CKweVtBgnpZ2doTZXeeV/h7hHuEWZbWRXIVCgM6/inaaNe4cMRGCWqwb1xmw6D8VkLpNo6PiB37gR4GfMokasgVHZEVMg2evWKk0moREGW9XKqoE6PS9TPHPHerdqFqfbmeOq3nNgHrJZkNsAJ3PPESWCe/NGEBwtYDKrPI3QlouvXmxScI9/p2VCQmdFoUxKMDsVzBdRMrCx+XxoS8x81HxubZSpnvzUlzGtznZi7e6OyAlI7xXELIO551AH4V/pNWWUPATX+7vXVDGh7aAZYme/fejisjO5Tk9aqRvohh2jCDml3ED6alHHfI0oX5UvBpOE+XwGTIJ8qpf9RrLP5DC27JWE3fqY/WoqIZX7phoKeKYLl+R7Iln/dfvepbMBgcesnBf4PuMh3Qm2l2G1bElJ/hniV1dgggwjcg50nA0Ee9sCnORPxxjdDIMwJw//NJSe+Aq5Fm1ure9oNiBYOeF0bLVQyfGIC8J8coy1xdqv2klKnGHjMMN44bjNlmDp00SaRpbdDuavyocosQVpzfA+hY2QtGV5TXFv6TLgcMYwf8gNyVNkSGE=
-  on:
-    tags: true
-    repo: pushrocks/smartcli
-notifications:
-  slack:
-    secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=
-  email: false

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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,16 +0,0 @@
-# smartcli
-nodejs wrapper for CLI related tasks
-
-### Buildstatus/Dependencies
-[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli)
-[![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
-
-### Usage
-This npm package comes with everything you need to start your own gulp plugin.
-
-We recommend modifying the ts/index.ts file, 
-then run `npm install` to install the dev dependencies
-and use `npm test` to compile the TypeScript file.
- 
-Cheers  
-Phil from Lossless Digital

docs/index.md

@@ -0,0 +1,31 @@
+# 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/)
+
+## Usage
+
+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://push.rocks)

index.js

@@ -1,113 +0,0 @@
-/// <reference path="index.ts" />
-/// <reference path="typings/tsd.d.ts" />
-/// <reference path="./interfaces.ts" />
-var path = require("path");
-var beautylog = require("beautylog");
-var cliff = require("cliff");
-var inquirer = require("inquirer");
-var argv = require('yargs').argv;
-//define the smartcli object
-var smartcli = {};
-//add plugins from above for direct use
-smartcli.inquirer = inquirer;
-smartcli.cliff = cliff;
-smartcli.argv = argv;
-/* ------------------------------------------------------------------------------
- *----------------------- initial call CLI args -----------------------------
- *----------------------------------------------------------------------------- */
-// commands
-smartcli.checkCommand = function (commandString) {
-    if (argv._.indexOf(commandString) != -1) {
-        return true;
-    }
-    return false;
-};
-smartcli.getCommands = function () {
-    return argv._;
-};
-// options
-smartcli.getOption = function (optionName) {
-    if (argv.hasOwnProperty(optionName)) {
-        return {
-            name: optionName,
-            specified: true,
-            value: argv[optionName] //we already know from the "if" above that the value is available.
-        };
-    }
-    return {
-        name: optionName,
-        specified: false,
-        value: false
-    };
-};
-smartcli.getOptions = function () {
-    var options = {};
-    for (var key in argv) {
-        if (key != "_") {
-            options['key'] = argv['key'];
-        }
-    }
-    return options;
-};
-/**
- * returns Directory of cwd
- * @returns {{path: string}}
- */
-smartcli.getCwd = function () {
-    return {
-        path: process.cwd()
-    };
-};
-/* ------------------------------------------------------------------------------
-*----------------------- in program CLI interaction -----------------------------
-*----------------------------------------------------------------------------- */
-/**
- * executes callback with answer to question as argument
- * @param questionString the question you want to ask the user
- * @param cb the function to execute with answer as param
- * @returns {null}
- */
-smartcli.getAnswer = function (questionString, cb) {
-    if (typeof questionString != 'string') {
-        beautylog.error('no question specified');
-        return null;
-    }
-    //make inquirer compatible question object
-    var question = {
-        type: "input",
-        name: "userFeedback",
-        message: questionString,
-        validate: function (value) {
-            return true;
-        }
-    };
-    inquirer.prompt([question], function (answers) {
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-smartcli.getChoice = function (questionString, choiceOptions, cb) {
-    if (!Array.isArray(choiceOptions)) {
-        return null;
-    }
-    //make inquirer compatible question object
-    var question = {
-        type: "list",
-        name: "userFeedback",
-        message: questionString,
-        choices: choiceOptions,
-        filter: function (val) { return val.toLowerCase(); }
-    };
-    inquirer.prompt(question, function (answers) {
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-module.exports = smartcli;

npmextra.json

@@ -0,0 +1,20 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccesslevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartcli",
+      "description": "easy observable cli tasks",
+      "npmPackagename": "@push.rocks/smartcli",
+      "license": "MIT"
+    }
+  },
+  "tsdocs": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
+  }
+}

package.json

@@ -1,38 +1,60 @@
 {
-  "name": "smartcli",
-  "version": "0.0.8",
-  "description": "nodejs wrapper for CLI related tasks",
-  "main": "index.js",
+  "name": "@push.rocks/smartcli",
+  "private": false,
+  "version": "4.0.9",
+  "description": "easy observable cli tasks",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(cd ts/compile && gulp)",
-    "devTest": "(npm test) && (node test.js --test true)",
-    "reinstall": "(rm -r node_modules && npm install)",
-    "release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
-    "startdev": "(git checkout master && git pull origin master)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pushrocks/smartcli.git"
+    "url": "https://gitlab.com/pushrocks/smartcli.git"
   },
   "keywords": [
-    "json",
-    "jade",
-    "template"
+    "cli",
+    "promise",
+    "task",
+    "push.rocks"
   ],
-  "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
+  "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/smartcli/issues"
+    "url": "https://gitlab.com/pushrocks/smartcli/issues"
   },
-  "homepage": "https://github.com/pushrocks/smartcli",
+  "homepage": "https://gitlab.com/pushrocks/smartcli",
   "dependencies": {
-    "beautylog": "0.0.15",
-    "cliff": "^0.1.10",
-    "inquirer": "^0.10.1",
-    "yargs": "^3.26.0"
+    "@push.rocks/lik": "^6.0.3",
+    "@push.rocks/smartlog": "^3.0.1",
+    "@push.rocks/smartparam": "^1.1.10",
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/smartrx": "^3.0.3",
+    "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "gulp": "3.9.0",
-    "gulp-typescript": "2.9.2"
-  }
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.42",
+    "@git.zone/tstest": "^1.0.74",
+    "@push.rocks/tapbundle": "^5.0.4",
+    "@types/node": "^20.4.1"
+  },
+  "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,74 @@
+# @push.rocks/smartcli
+easy observable cli tasks
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartcli)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/smartcli)
+* [github.com (source mirror)](https://github.com/push.rocks/smartcli)
+* [docs (typedoc)](https://push.rocks.gitlab.io/smartcli/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartcli/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartcli/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartcli)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/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/@push.rocks/smartcli)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartcli)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartcli)](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.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test.js

@@ -1,45 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartcli = require("./index.js");
-var bl = require("beautylog");
-bl.log('now starting Test');
-bl.log('starting with initial CLI commands and options');
-var commandsString = 'You specified the following commands:';
-var commands = smartcli.getCommands();
-for (var key in commands) {
-    commandsString = commandsString + ' ' + commands[key];
-}
-bl.log(commandsString);
-var getCwdTest = function () {
-    console.log('The current directory is: ' + smartcli.getCwd().path);
-};
-var checkCommandTest = function () {
-    if (smartcli.checkCommand('jazz')) {
-        bl.log('One of your commands is jazz');
-    }
-    else {
-        bl.log('None of your commands is jazz');
-    }
-};
-var getOptionTest = function () {
-    console.log('We now test for option --test');
-    console.log(smartcli.getOption('test'));
-};
-var checkOptionTest = function () {
-};
-var getAnswerTest = function () {
-    smartcli.getAnswer('How do you feel?', function (answer) {
-        console.log('The answer is: ' + answer);
-        getChoiceTest();
-    });
-};
-var getChoiceTest = function () {
-    smartcli.getChoice('What music do you like to hear?', ['Jazz', 'Blues', 'Classical'], function (answer) {
-        console.log('The answer is: ' + answer);
-    });
-};
-//starting command tests
-getCwdTest();
-checkCommandTest();
-getOptionTest();
-//starting first interaction test (the other tests are then started via callbacks)
-getAnswerTest();

test/test.ts

@@ -0,0 +1,42 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as smartrx from '@push.rocks/smartrx';
+
+import * as smartcli from '../ts/index.js';
+
+tap.test('should create a new Smartcli', async () => {
+  const smartCliTestObject = new smartcli.Smartcli();
+  expect(smartCliTestObject).toBeInstanceOf(smartcli.Smartcli);
+});
+
+tap.test('should add an command', async (toolsArg) => {
+  const done = toolsArg.defer();
+  const smartCliTestObject = new smartcli.Smartcli();
+  const awesomeCommandSubject = smartCliTestObject.addCommand('awesome');
+  expect(awesomeCommandSubject).toBeInstanceOf(smartrx.rxjs.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 () => {
+  const smartCliTestObject = new smartcli.Smartcli();
+  expect(smartCliTestObject.standardCommand()).toBeInstanceOf(smartrx.rxjs.Subject);
+});
+
+let hasExecuted: boolean = false;
+
+tap.test('should accept a command', async () => {
+  const smartCliTestObject = new smartcli.Smartcli();
+  smartCliTestObject.addCommand('triggerme').subscribe(() => {
+    hasExecuted = true;
+  });
+  smartCliTestObject.triggerCommand('triggerme', {});
+  expect(hasExecuted).toBeTrue();
+});
+
+tap.start();

ts/00_commitinfo_data.ts

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

ts/compile/gulpfile.js

@@ -1,25 +0,0 @@
-// import gulp
-var gulp = require("gulp"),
-	gulpTypescript = require("gulp-typescript");
-
-gulp.task('compileTS', function() {
-	var stream = gulp.src('../index.ts')
-	  .pipe(gulpTypescript({
-	  	out: "index.js"
-	  }))
-	  .pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('compileTestTS', function() {
-	var stream = gulp.src('../test.ts')
-			.pipe(gulpTypescript({
-				out: "test.js"
-			}))
-			.pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('default',['compileTS','compileTestTS'], function() {
-	console.log('Typescript compiled');
-});

ts/compile/readme.md

@@ -1,2 +0,0 @@
-# How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.

ts/index.ts

@@ -1,139 +1 @@
-/// <reference path="typings/tsd.d.ts" />
-/// <reference path="./interfaces.ts" />
-
-var path = require("path");
-var beautylog = require("beautylog");
-var cliff = require("cliff");
-var inquirer = require("inquirer");
-var argv = require('yargs').argv;
-
-//define the smartcli object
-var smartcli:any = {};
-
-//add plugins from above for direct use
-smartcli.inquirer = inquirer;
-smartcli.cliff = cliff;
-smartcli.argv = argv;
-
-/* ------------------------------------------------------------------------------
- *----------------------- initial call CLI args -----------------------------
- *----------------------------------------------------------------------------- */
-
-// commands
-
-
-smartcli.checkCommand = function(commandString:string):boolean {
-    if (argv._.indexOf(commandString) != -1) {
-        return true
-    }
-    return false;
-};
-
-smartcli.getCommands = function ():string[] {
-    return argv._;
-};
-
-
-// options
-smartcli.getOption = function(optionName:string):CliOption {
-    if (argv.hasOwnProperty(optionName)) {
-        return {
-            name:optionName,
-            specified: true,
-            value: argv[optionName] //we already know from the "if" above that the value is available.
-        };
-
-    }
-    return {
-        name:optionName,
-        specified: false,
-        value: false
-    }
-};
-
-
-smartcli.getOptions = function() {
-    var options = {};
-    for (var key in argv) {
-        if (key != "_") {
-            options['key'] = argv['key'];
-        }
-    }
-    return options;
-};
-
-/**
- * returns Directory of cwd
- * @returns {{path: string}}
- */
-smartcli.getCwd = function():Directory {
-    return {
-        path: process.cwd()
-    }
-};
-
-
-
-/* ------------------------------------------------------------------------------
-*----------------------- in program CLI interaction -----------------------------
-*----------------------------------------------------------------------------- */
-
-
-
-/**
- * executes callback with answer to question as argument
- * @param questionString the question you want to ask the user
- * @param cb the function to execute with answer as param
- * @returns {null}
- */
-smartcli.getAnswer = function(questionString:string, cb) {
-    if (typeof questionString != 'string') {
-        beautylog.error('no question specified');
-        return null;
-    }
-    //make inquirer compatible question object
-    var question = {
-        type: "input",
-        name: "userFeedback",
-        message: questionString,
-        validate: function( value ) {
-            return true;
-        }
-    };
-
-    inquirer.prompt([question],function(answers){
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-smartcli.getChoice = function(questionString:string, choiceOptions:string[], cb) {
-    if(!Array.isArray(choiceOptions)) {
-        return null;
-    }
-
-    //make inquirer compatible question object
-    var question = {
-        type: "list",
-        name: "userFeedback",
-        message: questionString,
-        choices: choiceOptions,
-        filter: function( val ) { return val.toLowerCase(); }
-    };
-
-    inquirer.prompt(question,function(answers){
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-
-};
-
-
-module.exports = smartcli;
+export { Smartcli } from './smartcli.classes.smartcli.js';

ts/interfaces.ts

@@ -1,11 +0,0 @@
-/// <reference path="index.ts" />
-interface CliOption {
-    name: string;
-    specified:boolean;
-    value: any;
-}
-
-interface Directory {
-    path: string;
-}
-

ts/smartcli.classes.smartcli.ts

@@ -0,0 +1,174 @@
+import * as plugins from './smartcli.plugins.js';
+
+// interfaces
+export interface ICommandObservableObject {
+  commandName: string;
+  subject: plugins.smartrx.rxjs.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 {
+  /**
+   * this Deferred contains the parsed result in the end
+   */
+  public parseCompleted = plugins.smartpromise.defer<any>();
+
+  public version: string;
+
+  /**
+   * map of all Trigger/Observable objects to keep track
+   */
+  private commandObservableMap = new plugins.lik.ObjectMap<ICommandObservableObject>();
+
+  /**
+   * maps alias
+   */
+  public aliasObject: { [key: string]: string[] } = {};
+
+  /**
+   * The constructor of Smartcli
+   */
+  constructor() {}
+
+  /**
+   * adds an alias, meaning one equals the other in terms of command execution.
+   */
+  public addCommandAlias(originalArg: string, aliasArg: string): void {
+    this.aliasObject[originalArg] = this.aliasObject[originalArg] || [];
+    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.
+   */
+  public addCommand(commandNameArg: string): plugins.smartrx.rxjs.Subject<any> {
+    let commandSubject: plugins.smartrx.rxjs.Subject<any>;
+    const existingCommandSubject = this.getCommandSubject(commandNameArg);
+    commandSubject = existingCommandSubject || new plugins.smartrx.rxjs.Subject<any>();
+
+    this.commandObservableMap.add({
+      commandName: commandNameArg,
+      subject: commandSubject,
+    });
+    return commandSubject;
+  }
+
+  /**
+   * execute trigger by name
+   * @param commandNameArg - the name of the command to trigger
+   */
+  public triggerCommand(commandNameArg: string, argvObject: any) {
+    const triggerSubject = this.getCommandSubject(commandNameArg);
+    triggerSubject.next(argvObject);
+    return triggerSubject;
+  }
+
+  /**
+   * gets the command subject for the specified name.
+   * call this before calling .parse()
+   * @param commandNameArg 
+   * @returns 
+   */
+  public getCommandSubject(commandNameArg: string) {
+    const triggerObservableObject = this.commandObservableMap.findSync(
+      (triggerObservableObjectArg) => {
+        return triggerObservableObjectArg.commandName === commandNameArg;
+      }
+    );
+    if (triggerObservableObject) {
+      return triggerObservableObject.subject;
+    } else {
+      return null;
+    }
+  }
+
+  /**
+   * getOption
+   */
+  public getOption(optionNameArg: string) {
+    const parsedYargs = plugins.yargsParser(process.argv);
+    return parsedYargs[optionNameArg];
+  }
+
+  /**
+   * allows to specify help text to be printed above the rest of the help text
+   */
+  public addHelp(optionsArg: { helpText: string }) {
+    this.addCommand('help').subscribe((argvArg) => {
+      logger.log('info', optionsArg.helpText);
+    });
+  }
+
+  /**
+   * specify version to be printed for -v --version
+   */
+  public addVersion(versionArg: string) {
+    this.version = versionArg;
+  }
+
+  /**
+   * adds a trigger that is called when no command is specified
+   */
+  public standardCommand(): plugins.smartrx.rxjs.Subject<any> {
+    const standardSubject = this.addCommand('standardCommand');
+    return standardSubject;
+  }
+
+  /**
+   * start the process of evaluating commands
+   */
+  public startParse(): void {
+    const parsedYArgs = plugins.yargsParser(process.argv);
+
+    // 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;
+    }
+    console.log(`Wanted command: ${wantedCommand}`);
+    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

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

ts/test.ts

@@ -1,58 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartcli = require("./index.js");
-var bl = require("beautylog");
-
-bl.log('now starting Test');
-bl.log('starting with initial CLI commands and options');
-
-var commandsString:string = 'You specified the following commands:';
-var commands = smartcli.getCommands();
-for (var key in commands) {
-    commandsString = commandsString + ' ' + commands[key];
-}
-bl.log(commandsString);
-
-
-var getCwdTest = function(){
-    console.log('The current directory is: ' + smartcli.getCwd().path);
-};
-
-var checkCommandTest = function() {
-    if (smartcli.checkCommand('jazz')) {
-        bl.log('One of your commands is jazz');
-    } else {
-        bl.log('None of your commands is jazz');
-    }
-};
-
-var getOptionTest = function() {
-    console.log('We now test for option --test')
-    console.log(smartcli.getOption('test'));
-}
-
-var checkOptionTest = function() {
-
-};
-
-var getAnswerTest = function() {
-    smartcli.getAnswer('How do you feel?',function(answer){
-        console.log('The answer is: ' + answer);
-        getChoiceTest();
-    });
-};
-
-var getChoiceTest = function() {
-    smartcli.getChoice('What music do you like to hear?',['Jazz','Blues','Classical'],function(answer){
-        console.log('The answer is: ' + answer);
-    });
-};
-
-
-
-//starting command tests
-getCwdTest();
-checkCommandTest();
-getOptionTest();
-
-//starting first interaction test (the other tests are then started via callbacks)
-getAnswerTest();

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="node/node.d.ts" />

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}