@decaf-ts/cli 0.0.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tiago Venceslau 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,297 @@
+![Banner](./workdocs/assets/Banner.png)
+## Decaf-ts cli
+
+
+
+![Licence](https://img.shields.io/github/license/decaf-ts/cli.svg?style=plastic)
+![GitHub language count](https://img.shields.io/github/languages/count/decaf-ts/cli?style=plastic)
+![GitHub top language](https://img.shields.io/github/languages/top/decaf-ts/cli?style=plastic)
+[![Tests](https://github.com/decaf-ts/cli/actions/workflows/jest-test.yaml/badge.svg)](http://www.pdmfc.com)
+[![CodeQL](https://github.com/starnowski/posmulten/workflows/CodeQL/badge.svg)](https://github.com/decaf-ts/cli/actions?query=workflow%3ACodeQL)
+
+![Open Issues](https://img.shields.io/github/issues/decaf-ts/cli.svg)
+![Closed Issues](https://img.shields.io/github/issues-closed/decaf-ts/cli.svg)
+![Pull Requests](https://img.shields.io/github/issues-pr-closed/decaf-ts/cli.svg)
+![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)
+
+![Line Coverage](workdocs/coverage/badge-lines.svg)
+![Function Coverage](workdocs/coverage/badge-functions.svg)
+![Statement Coverage](workdocs/coverage/badge-statements.svg)
+![Branch Coverage](workdocs/coverage/badge-branches.svg)
+
+
+![Forks](https://img.shields.io/github/forks/decaf-ts/cli.svg)
+![Stars](https://img.shields.io/github/stars/decaf-ts/cli.svg)
+![Watchers](https://img.shields.io/github/watchers/decaf-ts/cli.svg)
+
+![Node Version](https://img.shields.io/badge/dynamic/json.svg?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbadges%2Fshields%2Fmaster%2Fpackage.json&label=Node&query=$.engines.node&colorB=blue)
+![NPM Version](https://img.shields.io/badge/dynamic/json.svg?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbadges%2Fshields%2Fmaster%2Fpackage.json&label=NPM&query=$.engines.npm&colorB=purple)
+
+Defaults to module, but exports to CommonJS and ESM.
+
+With documentation, update and release mechanisms and gitlab/github workflows to match;
+
+Defines a 'way' to write jsDocs to optimize the output
+
+Optimized for github in terms of badges. CI is equivalent between Gitlab and Github.
+
+Auto setup on first `npm install`
+
+Will accept a `.token` file containing token valid for private npm dependencies, npm and docker registries
+
+### ***Initial Setup***
+
+#### if you use github
+
+create a new project using this one as a template.
+
+clone it `git clone <project>` and navigate to the root folder `cd <project>`
+
+#### If your project has private dependencies or publishes to private npm registries, create an `.npmrc` containing:
+
+```text
+@<scope1>:registry=https://<ADDRESS>.com/api/v4/packages/npm/
+@<scope2>:registry=https://<ADDRESS>.<DOMAIN>.com/api/v4/packages/npm/
+//<ADDRESS>.<DOMAIN>.com/:_authToken=${TOKEN}
+//<ADDRESS>.<DOMAIN>.com/api/v4/groups/<GROUP_ID>/packages/npm/:_authToken=${TOKEN}
+//<ADDRESS>.<DOMAIN>.com/api/v4/projects/<PROJECT_ID>/packages/npm/:_authToken=${TOKEN}
+```
+
+Changing:
+ - <ADDRESS> to `gitlab` or `github` (or other);
+ - <DOMAIN> to your domain if any (if you are using plain gitlab or github use empty and take care to remove the extra `.`);
+ - <GROUP_ID> to your project's group id (if any). otherwise remove this line
+ - <PROJECT_ID> to your project's id
+
+and adding a `.token` file containing your access token to the private registries na repositories.
+
+### Installation
+
+Run `npm install` (or `npm run do-install` if you have private dependencies and a `.token` file) to install the dependencies:
+
+If this is the first time you are running this command it will also:
+ - update this repository's dependencies to their latest version;
+ - creates a `.token` file which you can leave empty unless you have private dependencies or publish to private registries
+ - delete this 'first run script' file and npm call from the `package.json`;
+ - try to commit the updated `package.json` and deleted files (having ssh access helps here);
+## Linting
+
+This repo comes with eslint + prettier preconfigured to the default standards
+## Testing
+
+Preconfigured Jest based testing:
+
+- unit tests under the `tests/unit` folder;
+  - include a default bundle test (helps with circular dependencies and such);
+- integration tests under the `tests/integration` folder;
+- stores converage results under `workdocs/coverage`;
+- publishes coverage result to docs;
+- ignores `cli.ts` from coverage since that is an executable file;
+- defines the coverage threshold in `jest.config.ts`;
+### Releases
+
+This repository automates releases in the following manner:
+
+- run `npm run release -- <major|minor|patch|version> <message>`:
+  - if arguments are missing you will be prompted for them;
+- it will run `npm run prepare-release` npm script;
+- it will commit all changes;
+- it will push the new tag;
+
+If publishing to a private repo's npm registry, make sure you add to your `package.json`:
+
+```json
+{
+  "publishConfig": {
+    "<SCOPE>:registry": " https://<REGISTRY>/api/v4/projects/<PROJECT_ID>/packages/npm/"
+  }
+}
+```
+
+Where:
+
+- `<SCOPE>` - Is the scope of your package;
+- `<REGISTRY>` - your registry host;
+- `<PROJECT_ID>` - you project ID number (easy to grab via UI in gitlab or by
+  running `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in the repository page in github)
+  ;
+
+### Publishing
+
+Unless the `-no-ci` flag is passed in the commit message to the `npm run release` command, publishing will be handled
+automatically by github/gitlab (triggered by the tag).
+
+When the `-no-ci` flag is passed then you can:
+
+- run `npm run publish`. This command assumes :
+  - you have previously run the `npm run release`;
+  - you have you publishing properly configured in `npmrc` and `package.json`;
+  - The token for any special access required is stored in the `.token` file;
+ 
+## Continuous Integration/Deployment
+
+While the implementationfor gitlab and github are not perfectly matched, they are perfectly usable.
+
+The template comes with ci/cd for :
+  - gitlab (with caching for performance):
+    - stages: 
+      - dependencies: Installs dependencies (on `package-lock.json` changes, caches node modules);
+      - build: builds the code (on `src/*` changes, caches `lib` and `dist`);
+      - test: tests the code (on `src/*`, `test/*` changes, caches `workdocs/{resources, badges, coverage}`);
+      - deploy: 
+        - deploys to package registry on a tag (public|private);
+        - deploys docker image to docker registry (private);
+        - Deploys the documentation to the repository pages;
+  - github:
+    - jest-test: standard `install -> build -> test` loop;
+    - jest-coverage: extracts coverage from the tests;
+    - codeql-analysis: Code quality analisys;
+    - pages: builds the documentation and deploys to github pages
+    - release-on-tag: issues a release when the tag does not contain `-no-ci` string
+    - publish-on-release: publishes to package registry when the tag does not contain the `-no-ci` string
+    - Requires Variables:
+      - CONSECUTIVE_ACTION_TRIGGER: secret to enable actions to trigger other actions;
+      - NPM_TOKEN: npm/docker registry token
+## Considerations
+ - Setup for a linux based environment (Sorry windows users. use WSL... or just change already);
+ - Setup for node 20, but will work at least with 16;
+ - Requires docker to build documentation (drawings and PlantUML)
+## Documentation
+
+The repository proposes a way to generate documentation that while still not ideal, produces verys consitest results.
+
+In the code you see an example on how to properly document each code object, but the overall structure is:
+  - each package is a `@module`;
+  - Classes and Interfaces are categorized into `@category` and `@subcategory`;
+  - All other objects are categorized by `@namespace` and `@memberOf`;
+  - Enums and const are declared as `@const` and both must describe their properties as `@property` (when constants are objects);
+  - Interfaces must declare their methods `@method`;
+
+There are 3 steps the generating the documentation (automated in CI):
+ - `npm run drawings` - generates png files from each drawing in the `workdocs/drawings` folder and moves them to the `workdocs/resources` folder (requires Docker);
+ - `npm run uml` - generates png files from each PlantUML diagram in the `workdocs/uml` folder and moves them to the `workdocs/resources` folder (requires Docker);
+ - `npm run docs` - this has several stages, defined under the `gulp docs` (gulpfile.js):
+   - compiles the Readme file via md compile:
+     - enables keeping separate files for sections that are then joined into a single file;
+     - Allows keeping specific files in the jsdocs tutorial folder so they show up on their own menu;
+   - compiles the documentation from the source code using jsdocs:
+     - uses the better docs template with the category and component plugins
+     - uses the mermaid jsdoc plugin to embue uml diagrams in the docs
+     - includes a nav link to the test coverage results;
+   - copies the jsdoc and mds to `/docs`;
+   - copies the `./workdocs/{drawings, uml, assets, resources}` to `./docs`;
+
+The produced `docs` folder contains the resulting documentation;
+### Related
+
+[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=decaf-ts&repo=ts-workspace)](https://github.com/decaf-ts/ts-workspace)
+### Social
+
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/decaf-ts/)
+### Scripts
+
+The following npm scripts are available for development:
+
+- `preinstall` - will run only on the first install to trigger the dep update. will self delete;
+- `do-install` - sets a `TOKEN` environment variable to the contents of `.token` and runs npm install (useful when you
+  have private dependencies);
+- `flash-forward` - updates all dependencies. Take care, This may not be desirable is some cases;
+- `reset` - updates all dependencies. Take care, This may not be desirable is some cases;
+- `build` - builds the code (via gulp `gulpfile.js`) in development mode (generates `lib` and `dist` folder);
+- `build:prod` - builds the code (via gulp `gulpfile.js`) in production mode (generates `lib` and `dist` folder);
+- `test` - runs unit tests;
+- `test:integration` - runs it tests;
+- `test:all` - runs all tests;
+- `lint` - runs es lint on the code folder;
+- `lint-fix` - tries to auto-fix the code folder;
+- `prepare-release` - defines the commands to run prior to a new tag (defaults to linting, building production code,
+  running tests and documentation generation);
+- `release` - triggers a new tag being pushed to master (via `./bin/tag_release.sh`);
+- `clean-publish` - cleans the package.json for publishing;
+- `coverage` - runs all test, calculates coverage and generates badges for readme;
+- `drawings` - compiles all DrawIO `*.drawio` files in the `workdocs/drawings` folder to png and moves them to
+  the `workdocs/resources` folder;
+- `uml` - compiles all PlantUML `*.puml` files in the `workdocs/uml` folder to png and moves them to
+  the `workdocs/resources` folder;
+- `docs` - compiles all the coverage, drawings, uml, jsdocs and md docs into a readable web page under `./docs`;
+
+### Repository Structure
+
+```
+ts-workspace
+│
+│   .gitignore              <-- Defines files ignored to git
+│   .npmignore              <-- Defines files ignored by npm
+│   .nmprc                  <-- Defines the Npm registry for this package
+│   .eslintrc.cjs           <-- linting for the project
+│   .prettier.config.cjs    <-- Code style for the project
+│   .gitlab-ci.yml          <-- Gillab CI/CD file
+│   gulpfile.js             <-- Gulp build scripts. used for building na other features (eg docs)
+│   jest.config.ts          <-- Tests Configuration file
+│   mdCompile.json          <-- md Documentation generation configuration file
+│   jsdocs.json             <-- jsdoc Documentation generation configuration file
+│   Dockerfile              <-- minimal example of a node service Dockerfile
+│   LICENCE.md              <-- Licence disclamer
+│   package.json
+│   package-lock.json
+│   README.md               <-- Readme File dynamically compiled from 'workdocs' via the 'docs' npm script
+│   tsconfig.json           <-- Typescript config file. Is overriden in 'gulpfile.js' 
+│
+└───bin
+│   │   tag_release.sh      <-- Script to help with releases
+│   
+└───docs
+│   │   ...                 <-- Dinamically generated folder, containing the compiled documentation for this repository. generated via the 'docs' npm script
+│   
+└───src
+│   │   ...                 <-- Source code for this repository
+│   
+└───tests
+│   │───unit                <-- Unit tests
+│   └───integration         <-- Integration tests
+│   
+└───workdocs                <-- Folder with all pre-compiled documentation
+│   │───assets              <-- Documentation asset folder
+│   │───badges              <-- Auto generated coverage badges folder
+│   │───coverage            <-- Auto generated coverage results
+│   │───drawings            <-- DrawIO folder. Drawings (*.drawio) here will be processed to generate documentation (requires docker)
+│   │───uml                 <-- PlantUML folder. Diagrams (*.puml) here will be processed to generate documentation (requires docker)
+│   │───tutorials           <-- Tutorial folder
+│   │   ...                 <-- Categorized *.md files that are merged to generate the final readme (via md compile)
+│   │   Readme.md           <-- Entry point to the README.md   
+│  
+└───dist
+│   │   ...                 <-- Dinamically generated folder containing the bundles for distribution
+│
+└───lib
+    |   ...                 <-- Dinamically generated folder containing the compiled code
+```
+
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
+![NodeJS](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)
+![ShellScript](https://img.shields.io/badge/Shell_Script-121011?style=for-the-badge&logo=gnu-bash&logoColor=white)
+
+## Getting help
+
+If you have bug reports, questions or suggestions please [create a new issue](https://github.com/decaf-ts/ts-workspace/issues/new/choose).
+
+## Contributing
+
+I am grateful for any contributions made to this project. Please read [this](./workdocs/98-Contributing.md) to get started.
+
+## Supporting
+
+The first and easiest way you can support it is by [Contributing](./workdocs/98-Contributing.md). Even just finding a typo in the documentation is important.
+
+Financial support is always welcome and helps keep the both me and the project alive and healthy.
+
+So if you can, if this project in any way. either by learning something or simply by helping you save precious time, please consider donating.
+
+## License
+
+This project is released under the [MIT License](LICENSE.md).
+
+#### Disclaimer:
+
+badges found [here](https://dev.to/envoy_/150-badges-for-github-pnk), [here](https://github.com/alexandresanlim/Badges4-README.md-Profile#-social-) and [here](https://github.com/Ileriayo/markdown-badges)

package/lib/CliWrapper.cjs

@@ -0,0 +1,131 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliWrapper = void 0;
+const commander_1 = require("commander");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const constants_1 = require("./constants.cjs");
+const utils_1 = require("./utils.cjs");
+/**
+ * @summary Util class to handle CLI functionality from all Decaf modules
+ * @description CLI handler class
+ *
+ * @param {string} [basepath] the base path to look for modules in. defaults to `./`
+ * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
+ *
+ * @class CliWrapper
+ */
+class CliWrapper {
+    constructor(basePath = "./", crawlLevels = 4) {
+        this.basePath = basePath;
+        this.crawlLevels = crawlLevels;
+        this.modules = {};
+    }
+    /**
+     * @description Retrieves and initializes the {@link Command} object
+     * @private
+     */
+    get command() {
+        if (!this._command) {
+            this._command = new commander_1.Command();
+            utils_1.CLIUtils.initialize(this._command, this.basePath);
+        }
+        return this._command;
+    }
+    /**
+     * @description loads and registers module from a file
+     *
+     * @param {string} filePath path to look for modules
+     * @param {string} rootPath repo root to find the package.json
+     * @return {string} the module name
+     *
+     * @private
+     */
+    async load(filePath, rootPath) {
+        let name;
+        try {
+            const module = await utils_1.CLIUtils.loadFromFile(filePath);
+            name = module.name;
+            const cmd = new commander_1.Command();
+            utils_1.CLIUtils.initialize(cmd, path_1.default.dirname(rootPath));
+            let m = module();
+            if (m instanceof Promise)
+                m = await m;
+            this.modules[name] = m;
+        }
+        catch (e) {
+            throw new Error(`failed to load module ${name || "unnamed"} under ${filePath}: ${e instanceof Error ? e.message : e}`);
+        }
+        return name;
+    }
+    /**
+     * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
+     * and loads them
+     * @private
+     */
+    async boot() {
+        const basePath = path_1.default.join(process.cwd(), this.basePath);
+        const modules = this.crawl(basePath, this.crawlLevels);
+        for (const module of modules) {
+            if (module.includes("@decaf-ts/cli")) {
+                continue;
+            }
+            let name;
+            try {
+                name = await this.load(module, process.cwd());
+            }
+            catch (e) {
+                console.error(e);
+                continue;
+            }
+            if (!this.command.commands.find((c) => c["_name"] === name))
+                try {
+                    this.command.command(name).addCommand(this.modules[name]);
+                }
+                catch (e) {
+                    console.error(e);
+                }
+        }
+        console.log(`loaded modules:\n${Object.keys(this.modules)
+            .map((k) => `- ${k}`)
+            .join("\n")}`);
+    }
+    /**
+     * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
+     * @param {string} basePath the relative base batch to start searching in
+     * @param {number} [levels] the max number of levels to crawl. defaults to 2
+     * @private
+     */
+    crawl(basePath, levels = 2) {
+        if (levels <= 0)
+            return [];
+        return fs_1.default.readdirSync(basePath).reduce((accum, file) => {
+            file = path_1.default.join(basePath, file);
+            if (fs_1.default.statSync(file).isDirectory()) {
+                accum.push(...this.crawl(file, levels - 1));
+            }
+            else if (file.endsWith(`${constants_1.CLI_FILE_NAME}.cjs`)) {
+                accum.push(file);
+            }
+            else {
+                // ignored file
+            }
+            return accum;
+        }, []);
+    }
+    /**
+     * @description runs the given command
+     *
+     * @param {string[]} [args] args to run. defaults to process.argv
+     */
+    async run(args = process.argv) {
+        await this.boot();
+        return this.command.parseAsync(args);
+    }
+}
+exports.CliWrapper = CliWrapper;
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,{"version":3,"sources":["src/CliWrapper.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAoC;AACpC,4CAAoB;AACpB,gDAAwB;AACxB,2CAA4C;AAC5C,mCAAmC;AAEnC;;;;;;;;GAQG;AACH,MAAa,UAAU;IAIrB,YACU,WAAmB,IAAI,EACvB,cAAc,CAAC;QADf,aAAQ,GAAR,QAAQ,CAAe;QACvB,gBAAW,GAAX,WAAW,CAAI;QAJjB,YAAO,GAA4B,EAAE,CAAC;IAK3C,CAAC;IAEJ;;;OAGG;IACH,IAAY,OAAO;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAO,EAAE,CAAC;YAC9B,gBAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,QAAgB;QACnD,IAAI,IAAI,CAAC;QACT,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,gBAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACrD,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACnB,MAAM,GAAG,GAAG,IAAI,mBAAO,EAAE,CAAC;YAC1B,gBAAQ,CAAC,UAAU,CAAC,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,YAAY,OAAO;gBAAE,CAAC,GAAG,MAAM,CAAC,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAEb,yBAAyB,IAAI,IAAI,SAAS,UAAU,QAAQ,KAAK,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CACtG,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,IAAI;QAChB,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACvD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YACD,IAAI,IAAY,CAAC;YACjB,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YAChD,CAAC;YAAC,OAAO,CAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,SAAS;YACX,CAAC;YAED,IACE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CAAE,CAAuC,CAAC,OAAO,CAAC,KAAK,IAAI,CAClE;gBAED,IAAI,CAAC;oBACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC5D,CAAC;gBAAC,OAAO,CAAU,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;QACL,CAAC;QACD,OAAO,CAAC,GAAG,CACT,oBAAoB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,QAAgB,EAAE,SAAiB,CAAC;QAChD,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,CAAC;QAC3B,OAAO,YAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAe,EAAE,IAAI,EAAE,EAAE;YAC/D,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACjC,IAAI,YAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACpC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,yBAAa,MAAM,CAAC,EAAE,CAAC;gBACjD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,eAAe;YACjB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,OAAiB,OAAO,CAAC,IAAI;QACrC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AArHD,gCAqHC","file":"CliWrapper.js","sourcesContent":["import { Command } from \"commander\";\nimport fs from \"fs\";\nimport path from \"path\";\nimport { CLI_FILE_NAME } from \"./constants\";\nimport { CLIUtils } from \"./utils\";\n\n/**\n * @summary Util class to handle CLI functionality from all Decaf modules\n * @description CLI handler class\n *\n * @param {string} [basepath] the base path to look for modules in. defaults to `./`\n * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4\n *\n * @class CliWrapper\n */\nexport class CliWrapper {\n  private _command?: Command;\n  private modules: Record<string, Command> = {};\n\n  constructor(\n    private basePath: string = \"./\",\n    private crawlLevels = 4\n  ) {}\n\n  /**\n   * @description Retrieves and initializes the {@link Command} object\n   * @private\n   */\n  private get command() {\n    if (!this._command) {\n      this._command = new Command();\n      CLIUtils.initialize(this._command, this.basePath);\n    }\n    return this._command;\n  }\n\n  /**\n   * @description loads and registers module from a file\n   *\n   * @param {string} filePath path to look for modules\n   * @param {string} rootPath repo root to find the package.json\n   * @return {string} the module name\n   *\n   * @private\n   */\n  private async load(filePath: string, rootPath: string): Promise<string> {\n    let name;\n    try {\n      const module = await CLIUtils.loadFromFile(filePath);\n      name = module.name;\n      const cmd = new Command();\n      CLIUtils.initialize(cmd, path.dirname(rootPath));\n      let m = module();\n      if (m instanceof Promise) m = await m;\n      this.modules[name] = m;\n    } catch (e: unknown) {\n      throw new Error(\n         \n        `failed to load module ${name || \"unnamed\"} under ${filePath}: ${e instanceof Error ? e.message : e}`\n      );\n    }\n    return name;\n  }\n\n  /**\n   * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}\n   * and loads them\n   * @private\n   */\n  private async boot() {\n    const basePath = path.join(process.cwd(), this.basePath);\n    const modules = this.crawl(basePath, this.crawlLevels);\n    for (const module of modules) {\n      if (module.includes(\"@decaf-ts/cli\")) {\n        continue;\n      }\n      let name: string;\n      try {\n        name = await this.load(module, process.cwd());\n      } catch (e: unknown) {\n        console.error(e);\n        continue;\n      }\n\n      if (\n        !this.command.commands.find(\n          (c) => (c as unknown as Record<string, string>)[\"_name\"] === name\n        )\n      )\n        try {\n          this.command.command(name).addCommand(this.modules[name]);\n        } catch (e: unknown) {\n          console.error(e);\n        }\n    }\n    console.log(\n      `loaded modules:\\n${Object.keys(this.modules)\n        .map((k) => `- ${k}`)\n        .join(\"\\n\")}`\n    );\n  }\n\n  /**\n   * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file\n   * @param {string} basePath the relative base batch to start searching in\n   * @param {number} [levels] the max number of levels to crawl. defaults to 2\n   * @private\n   */\n  private crawl(basePath: string, levels: number = 2) {\n    if (levels <= 0) return [];\n    return fs.readdirSync(basePath).reduce((accum: string[], file) => {\n      file = path.join(basePath, file);\n      if (fs.statSync(file).isDirectory()) {\n        accum.push(...this.crawl(file, levels - 1));\n      } else if (file.endsWith(`${CLI_FILE_NAME}.cjs`)) {\n        accum.push(file);\n      } else {\n        // ignored file\n      }\n      return accum;\n    }, []);\n  }\n\n  /**\n   * @description runs the given command\n   *\n   * @param {string[]} [args] args to run. defaults to process.argv\n   */\n  async run(args: string[] = process.argv) {\n    await this.boot();\n    return this.command.parseAsync(args);\n  }\n}\n"]}

package/lib/CliWrapper.d.ts

@@ -0,0 +1,51 @@
+import { Command } from "commander";
+/**
+ * @summary Util class to handle CLI functionality from all Decaf modules
+ * @description CLI handler class
+ *
+ * @param {string} [basepath] the base path to look for modules in. defaults to `./`
+ * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
+ *
+ * @class CliWrapper
+ */
+export declare class CliWrapper {
+    private basePath;
+    private crawlLevels;
+    private _command?;
+    private modules;
+    constructor(basePath?: string, crawlLevels?: number);
+    /**
+     * @description Retrieves and initializes the {@link Command} object
+     * @private
+     */
+    private get command();
+    /**
+     * @description loads and registers module from a file
+     *
+     * @param {string} filePath path to look for modules
+     * @param {string} rootPath repo root to find the package.json
+     * @return {string} the module name
+     *
+     * @private
+     */
+    private load;
+    /**
+     * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
+     * and loads them
+     * @private
+     */
+    private boot;
+    /**
+     * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
+     * @param {string} basePath the relative base batch to start searching in
+     * @param {number} [levels] the max number of levels to crawl. defaults to 2
+     * @private
+     */
+    private crawl;
+    /**
+     * @description runs the given command
+     *
+     * @param {string[]} [args] args to run. defaults to process.argv
+     */
+    run(args?: string[]): Promise<Command>;
+}

package/lib/cli.cjs

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Actual CLI file
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const CliWrapper_1 = require("./CliWrapper.cjs");
+new CliWrapper_1.CliWrapper()
+    .run(process.argv)
+    .then(() => {
+    console.log("Thank you for using decaf-ts' command line interface");
+})
+    .catch((e) => {
+    console.error(`${e instanceof Error ? e.message : e}`);
+    process.exit(1);
+});
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9jbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOztHQUVHOztBQUVILDZDQUEwQztBQUMxQyxJQUFJLHVCQUFVLEVBQUU7S0FDYixHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztLQUNqQixJQUFJLENBQUMsR0FBRyxFQUFFO0lBQ1QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO0FBQ3RFLENBQUMsQ0FBQztLQUNELEtBQUssQ0FBQyxDQUFDLENBQVUsRUFBRSxFQUFFO0lBQ3BCLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFlBQVksS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDbEIsQ0FBQyxDQUFDLENBQUMiLCJmaWxlIjoiY2xpLmpzIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBBY3R1YWwgQ0xJIGZpbGVcbiAqL1xuXG5pbXBvcnQgeyBDbGlXcmFwcGVyIH0gZnJvbSBcIi4vQ2xpV3JhcHBlclwiO1xubmV3IENsaVdyYXBwZXIoKVxuICAucnVuKHByb2Nlc3MuYXJndilcbiAgLnRoZW4oKCkgPT4ge1xuICAgIGNvbnNvbGUubG9nKFwiVGhhbmsgeW91IGZvciB1c2luZyBkZWNhZi10cycgY29tbWFuZCBsaW5lIGludGVyZmFjZVwiKTtcbiAgfSlcbiAgLmNhdGNoKChlOiB1bmtub3duKSA9PiB7XG4gICAgY29uc29sZS5lcnJvcihgJHtlIGluc3RhbmNlb2YgRXJyb3IgPyBlLm1lc3NhZ2UgOiBlfWApO1xuICAgIHByb2Nlc3MuZXhpdCgxKTtcbiAgfSk7XG4iXX0=

package/lib/cli.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Actual CLI file
+ */
+export {};

package/lib/constants.cjs

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLI_FILE_NAME = void 0;
+/**
+ * @description The name for decaf cli modules where each library must export
+ * a single {@link CliModule}
+ *
+ * @constant
+ * @memberOf module:CLI.cli
+ */
+exports.CLI_FILE_NAME = "cli-module";
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9jb25zdGFudHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBR0E7Ozs7OztHQU1HO0FBQ1UsUUFBQSxhQUFhLEdBQUcsWUFBWSxDQUFDIiwiZmlsZSI6ImNvbnN0YW50cy5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnNcbmltcG9ydCB7IENsaU1vZHVsZSB9IGZyb20gXCIuL3R5cGVzXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIFRoZSBuYW1lIGZvciBkZWNhZiBjbGkgbW9kdWxlcyB3aGVyZSBlYWNoIGxpYnJhcnkgbXVzdCBleHBvcnRcbiAqIGEgc2luZ2xlIHtAbGluayBDbGlNb2R1bGV9XG4gKlxuICogQGNvbnN0YW50XG4gKiBAbWVtYmVyT2YgbW9kdWxlOkNMSS5jbGlcbiAqL1xuZXhwb3J0IGNvbnN0IENMSV9GSUxFX05BTUUgPSBcImNsaS1tb2R1bGVcIjtcbiJdfQ==

package/lib/constants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @description The name for decaf cli modules where each library must export
+ * a single {@link CliModule}
+ *
+ * @constant
+ * @memberOf module:CLI.cli
+ */
+export declare const CLI_FILE_NAME = "cli-module";

package/lib/demo/cli-module.cjs

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = demo;
+const commander_1 = require("commander");
+/**
+ * @description demo CLI module for libraries
+ * @summary minimal implementation on how to extend the decaf-ts cli
+ *
+ * Simply logs a message
+ *
+ * @function demo
+ *
+ * @category CLI
+ * @memberOf module:CLI.cli
+ */
+function demo() {
+    return new commander_1.Command()
+        .command("command <type>")
+        .description("A demo command")
+        .action((args) => {
+        console.log(`executed demo command with type variable: ${args}`);
+    });
+}
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9kZW1vL2NsaS1tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFhQSx1QkFPQztBQXBCRCx5Q0FBb0M7QUFFcEM7Ozs7Ozs7Ozs7R0FVRztBQUNILFNBQXdCLElBQUk7SUFDMUIsT0FBTyxJQUFJLG1CQUFPLEVBQUU7U0FDakIsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3pCLFdBQVcsQ0FBQyxnQkFBZ0IsQ0FBQztTQUM3QixNQUFNLENBQUMsQ0FBQyxJQUFZLEVBQUUsRUFBRTtRQUN2QixPQUFPLENBQUMsR0FBRyxDQUFDLDZDQUE2QyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ25FLENBQUMsQ0FBQyxDQUFDO0FBQ1AsQ0FBQyIsImZpbGUiOiJkZW1vL2NsaS1tb2R1bGUuanMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb21tYW5kIH0gZnJvbSBcImNvbW1hbmRlclwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBkZW1vIENMSSBtb2R1bGUgZm9yIGxpYnJhcmllc1xuICogQHN1bW1hcnkgbWluaW1hbCBpbXBsZW1lbnRhdGlvbiBvbiBob3cgdG8gZXh0ZW5kIHRoZSBkZWNhZi10cyBjbGlcbiAqXG4gKiBTaW1wbHkgbG9ncyBhIG1lc3NhZ2VcbiAqXG4gKiBAZnVuY3Rpb24gZGVtb1xuICpcbiAqIEBjYXRlZ29yeSBDTElcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Q0xJLmNsaVxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBkZW1vKCkge1xuICByZXR1cm4gbmV3IENvbW1hbmQoKVxuICAgIC5jb21tYW5kKFwiY29tbWFuZCA8dHlwZT5cIilcbiAgICAuZGVzY3JpcHRpb24oXCJBIGRlbW8gY29tbWFuZFwiKVxuICAgIC5hY3Rpb24oKGFyZ3M6IHN0cmluZykgPT4ge1xuICAgICAgY29uc29sZS5sb2coYGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6ICR7YXJnc31gKTtcbiAgICB9KTtcbn1cbiJdfQ==

package/lib/demo/cli-module.d.ts

@@ -0,0 +1,13 @@
+import { Command } from "commander";
+/**
+ * @description demo CLI module for libraries
+ * @summary minimal implementation on how to extend the decaf-ts cli
+ *
+ * Simply logs a message
+ *
+ * @function demo
+ *
+ * @category CLI
+ * @memberOf module:CLI.cli
+ */
+export default function demo(): Command;

package/lib/esm/CliWrapper.d.ts

@@ -0,0 +1,51 @@
+import { Command } from "commander";
+/**
+ * @summary Util class to handle CLI functionality from all Decaf modules
+ * @description CLI handler class
+ *
+ * @param {string} [basepath] the base path to look for modules in. defaults to `./`
+ * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
+ *
+ * @class CliWrapper
+ */
+export declare class CliWrapper {
+    private basePath;
+    private crawlLevels;
+    private _command?;
+    private modules;
+    constructor(basePath?: string, crawlLevels?: number);
+    /**
+     * @description Retrieves and initializes the {@link Command} object
+     * @private
+     */
+    private get command();
+    /**
+     * @description loads and registers module from a file
+     *
+     * @param {string} filePath path to look for modules
+     * @param {string} rootPath repo root to find the package.json
+     * @return {string} the module name
+     *
+     * @private
+     */
+    private load;
+    /**
+     * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
+     * and loads them
+     * @private
+     */
+    private boot;
+    /**
+     * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
+     * @param {string} basePath the relative base batch to start searching in
+     * @param {number} [levels] the max number of levels to crawl. defaults to 2
+     * @private
+     */
+    private crawl;
+    /**
+     * @description runs the given command
+     *
+     * @param {string[]} [args] args to run. defaults to process.argv
+     */
+    run(args?: string[]): Promise<Command>;
+}