1.1.14

.gitlab-ci.yml

@@ -1,137 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-auditProductionDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - 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
-
-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
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

.vscode/launch.json

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

cli.child.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+process.env.CLI_CALL = 'true';
+import * as cliTool from './ts/index.js';
+cliTool.runCli();

cli.js

@@ -1,3 +1,4 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
-require('./dist/index');
+const cliTool = await import('./dist_ts/index.js');
+cliTool.runCli();

cli.ts.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
-require('@gitzone/tsrun');
+
-require('./ts/index');
+import * as tsrun from '@git.zone/tsrun';
+tsrun.runPath('./cli.child.js', import.meta.url);

npmextra.json

@@ -6,7 +6,7 @@
       "gitscope": "gitzone",
       "gitrepo": "tsdoc",
       "shortDescription": "a tool for better documentation",
-      "npmPackagename": "@gitzone/tsdoc",
+      "npmPackagename": "@git.zone/tsdoc",
       "license": "MIT",
       "projectDomain": "git.zone"
     }

package.json

@@ -1,10 +1,11 @@
 {
-  "name": "@gitzone/tsdoc",
+  "name": "@git.zone/tsdoc",
-  "version": "1.1.1",
+  "version": "1.1.14",
   "private": false,
   "description": "a tool for better documentation",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "bin": {
@@ -12,27 +13,29 @@
   },
   "scripts": {
     "test": "(tstest test/) && (node ./cli.ts.js)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany)"
-    "buildMkdocs": "(cd mkdocs/originalrepo && docker rmi -f mkdocs && docker build -t mkdocs .)",
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@git.zone/tsbuild": "^2.1.65",
-    "@gitzone/tstest": "^1.0.52",
+    "@git.zone/tsrun": "^1.2.46",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@git.zone/tstest": "^1.0.73",
-    "@types/node": "^14.14.9",
+    "@push.rocks/tapbundle": "^5.0.4",
-    "tslint": "^6.1.3",
+    "@types/node": "^20.12.2"
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/early": "^3.0.6",
+    "@push.rocks/early": "^4.0.3",
-    "@pushrocks/smartcli": "^3.0.12",
+    "@push.rocks/npmextra": "^5.0.10",
-    "@pushrocks/smartfile": "^8.0.8",
+    "@push.rocks/qenv": "^6.0.5",
-    "@pushrocks/smartlog": "^2.0.39",
+    "@push.rocks/smartai": "^0.0.6",
-    "@pushrocks/smartlog-destination-local": "^8.0.8",
+    "@push.rocks/smartcli": "^4.0.6",
-    "@pushrocks/smartshell": "^2.0.26",
+    "@push.rocks/smartfile": "^11.0.4",
-    "typedoc": "^0.19.2",
+    "@push.rocks/smartinteract": "^2.0.14",
-    "typescript": "^4.1.2"
+    "@push.rocks/smartlog": "^3.0.1",
+    "@push.rocks/smartlog-destination-local": "^9.0.1",
+    "@push.rocks/smartpath": "^5.0.5",
+    "@push.rocks/smartshell": "^3.0.4",
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.3"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -1,8 +1,8 @@
-# @gitzone/tsdoc
+# @git.zone/tsdoc
 a tool for better documentation
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsdoc)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@git.zone/tsdoc)
 * [gitlab.com (source)](https://gitlab.com/gitzone/tsdoc)
 * [github.com (source mirror)](https://github.com/gitzone/tsdoc)
 * [docs (typedoc)](https://gitzone.gitlab.io/tsdoc/)
@@ -13,18 +13,19 @@ Status Category | Status Badge
 -- | --
 GitLab Pipelines | [![pipeline status](https://gitlab.com/gitzone/tsdoc/badges/master/pipeline.svg)](https://lossless.cloud)
 GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@gitzone/tsdoc)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@git.zone/tsdoc)](https://lossless.cloud)
 Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/gitzone/tsdoc)](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/@gitzone/tsdoc)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@git.zone/tsdoc)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@gitzone/tsdoc)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@git.zone/tsdoc)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@gitzone/tsdoc)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@git.zone/tsdoc)](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
 
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 

test/test.aidocs.ts

@@ -0,0 +1,15 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+
+import * as tsdocs from '../ts/index.js';
+
+let aidocs: tsdocs.AiDocs;
+
+tap.test('should create an AIdocs class', async () => {
+  aidocs = new tsdocs.AiDocs();
+  expect(aidocs).toBeInstanceOf(tsdocs.AiDocs);
+});
+
+tap.test('should start AIdocs', async () => {})
+
+
+tap.start();

test/test.ts

@@ -1,5 +1,5 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
-import * as tsdoc from '../ts/index';
+import * as tsdoc from '../ts/index.js';
 
 tap.test('first test', async () => {
   console.log('test');

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@git.zone/tsdoc',
+  version: '1.1.14',
+  description: 'a tool for better documentation'
+}

ts/index.ts

@@ -1,6 +1,12 @@
-import * as early from '@pushrocks/early';
+import * as early from '@push.rocks/early';
 early.start('tsdoc');
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
-import * as cli from './tsdoc.cli';
+import * as cli from './tsdoc.cli.js';
 early.stop();
-cli.run();
+
+export const runCli = async () => {
+  await cli.run();
+};
+
+// exports
+export * from './tsdoc.classes.aidocs.js';

ts/tsdoc.classes.aidocs.ts

@@ -0,0 +1,44 @@
+import * as plugins from './tsdoc.plugins.js';
+
+export class AiDocs {
+  private openaiToken: string;
+
+  public npmextraKV: plugins.npmextra.KeyValueStore;
+  public qenvInstance: plugins.qenv.Qenv;
+  public smartinteractInstance: plugins.smartinteract.SmartInteract;
+  public openaiInstance: plugins.smartai.OpenAiProvider;
+
+  constructor() {}
+
+  public async start() {
+    // lets care about prerequisites
+    this.smartinteractInstance = new plugins.smartinteract.SmartInteract();
+    this.qenvInstance = new plugins.qenv.Qenv()
+    if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
+      this.npmextraKV = new plugins.npmextra.KeyValueStore({
+        typeArg: 'userHomeDir',
+        identityArg: 'tsdoc',
+        mandatoryKeys: ['OPENAI_TOKEN']
+      });
+
+      const missingKeys = this.npmextraKV.getMissingMandatoryKeys();
+      if (missingKeys.length > 0) {
+        const answerObject = await this.smartinteractInstance.askQuestion({
+          type: 'input',
+          message: `Please provide your OpenAI token`,
+          name: 'OPENAI_TOKEN',
+          default: '',
+        });
+        this.openaiToken = answerObject.value
+        await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
+      }
+    }
+
+    // lets assume we have an OPENAI_Token now
+    // we can now assemble the directory structure.
+    const smartfilesMod = plugins.smartfile.fs.fileTreeToObject(process.cwd(), 'ts/**/*.ts');
+    const smartfilesTest = plugins.smartfile.fs.fileTreeToObject(process.cwd(), 'test/**/*.ts');
+    console.log(smartfilesMod);
+    console.log(smartfilesTest);
+  }
+}

ts/tsdoc.classes.typedoc.ts

@@ -1,5 +1,5 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
-import * as paths from './tsdoc.paths';
+import * as paths from './tsdoc.paths.js';
 
 export class TypeDoc {
   public smartshellInstance = new plugins.smartshell.Smartshell({
@@ -9,10 +9,7 @@ export class TypeDoc {
 
   // Static
   public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
-    const result = await plugins.smartfile.fs.fileExists(
+    return true;
-      plugins.path.join(dirPathArg, 'mkdocs.yml')
-    );
-    return !result;
   }
 
   // Instance
@@ -21,20 +18,39 @@ export class TypeDoc {
     this.typedocDirectory = dirPathArg;
   }
 
-  public async compile() {
+  public async compile(options?: { publicSubdir?: string }) {
     const data = {
-      compilerOptions: {
+      "compilerOptions": {
-        target: 'es2017',
+        "experimentalDecorators": true,
-        module: 'commonjs',
+        "useDefineForClassFields": false,
-        esModuleInterop: true,
+        "target": "ES2022",
-        experimentalDecorators: true,
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "esModuleInterop": true,
+        "verbatimModuleSyntax": true
       },
       include: [],
     };
-    data.include = [plugins.path.join(paths.cwd, './ts/**/*')];
+    let startDirectory = '';
+    if (plugins.smartfile.fs.isDirectory(plugins.path.join(paths.cwd, './ts'))) {
+      data.include.push(plugins.path.join(paths.cwd, './ts/**/*'));
+      startDirectory = 'ts';
+    }
+
+    if (plugins.smartfile.fs.isDirectory(plugins.path.join(paths.cwd, './ts_web'))) {
+      data.include.push(plugins.path.join(paths.cwd, './ts_web/**/*'));
+      if (!startDirectory) {
+        startDirectory = 'ts_web';
+      }
+    }
+
     await plugins.smartfile.memory.toFs(JSON.stringify(data), paths.tsconfigFile);
+    let targetDir = paths.publicDir;
+    if (options?.publicSubdir) {
+      targetDir = plugins.path.join(targetDir, options.publicSubdir);
+    }
     await this.smartshellInstance.exec(
-      `typedoc --tsconfig ${paths.tsconfigFile} --out ${paths.publicDir}`
+      `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`
     );
     plugins.smartfile.fs.remove(paths.tsconfigFile);
   }

ts/tsdoc.cli.ts

@@ -1,18 +1,19 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
-import * as paths from './tsdoc.paths';
+import * as paths from './tsdoc.paths.js';
-import { logger } from './tsdoc.logging';
+import { logger } from './tsdoc.logging.js';
 
-import { TypeDoc } from './tsdoc.classes.typedoc';
+import { TypeDoc } from './tsdoc.classes.typedoc.js';
+import { AiDocs } from './tsdoc.classes.aidocs.js';
 
 export const run = async () => {
   const tsdocCli = new plugins.smartcli.Smartcli();
 
-  tsdocCli.standardTask().subscribe(async (argvArg) => {
+  tsdocCli.standardCommand().subscribe(async (argvArg) => {
     logger.log('warn', `Auto detecting environment!`);
     switch (true) {
       case await TypeDoc.isTypeDocDir(paths.cwd):
         logger.log('ok', `Detected TypeDoc compliant directory at ${paths.cwd}`);
-        tsdocCli.trigger('typedoc');
+        tsdocCli.triggerCommand('typedoc', argvArg);
         break;
       default:
         logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
@@ -21,11 +22,17 @@ export const run = async () => {
 
   tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
     const typeDocInstance = new TypeDoc(paths.cwd);
-    await typeDocInstance.compile();
+    await typeDocInstance.compile({
+      publicSubdir: argvArg.publicSubdir,
+    });
   });
 
+  tsdocCli.addCommand('aidocs').subscribe(async (argvArg) => {
+    const aidocs = new AiDocs();
+  })
+
   tsdocCli.addCommand('test').subscribe((argvArg) => {
-    tsdocCli.trigger('typedoc');
+    tsdocCli.triggerCommand('typedoc', argvArg);
     process.on('exit', async () => {
       await plugins.smartfile.fs.remove(paths.publicDir);
     });

ts/tsdoc.logging.ts

@@ -1,4 +1,4 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
 
 export const logger = new plugins.smartlog.Smartlog({
   logContext: {

ts/tsdoc.paths.ts

@@ -1,7 +1,7 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
 
 // dirs
-export const packageDir = plugins.path.join(__dirname, '../');
+export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
 export const cwd = process.cwd();
 export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
 export const assetsDir = plugins.path.join(packageDir, './assets');

ts/tsdoc.plugins.ts

@@ -4,13 +4,18 @@ import * as path from 'path';
 export { path };
 
 // pushrocks scope
-import * as smartcli from '@pushrocks/smartcli';
+import * as npmextra from '@push.rocks/npmextra';
-import * as smartfile from '@pushrocks/smartfile';
+import * as qenv from '@push.rocks/qenv';
-import * as smartlog from '@pushrocks/smartlog';
+import * as smartai from '@push.rocks/smartai';
-import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
+import * as smartcli from '@push.rocks/smartcli';
-import * as smartshell from '@pushrocks/smartshell';
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartinteract from '@push.rocks/smartinteract';
+import * as smartlog from '@push.rocks/smartlog';
+import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartshell from '@push.rocks/smartshell';
 
-export { smartcli, smartfile, smartlog, smartlogDestinationLocal, smartshell };
+export { npmextra, qenv, smartai, smartcli, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
 
 // third party scope
 import * as typedoc from 'typedoc';

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"
+  ]
+}

tslint.json

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