1.1.14

.gitignore

@@ -8,13 +8,13 @@ pages/
 # installs
 node_modules/
 
-# caches and builds
+# caches
 .yarn/
 .cache/
+.rpt2_cache
+
+# builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom
-mkdocs/originalrepo

.gitlab-ci.yml

@@ -1,125 +0,0 @@
-# gitzone standard
-image: 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
-  tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# test stage
-# ====================
-
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install stable
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  image: docker:stable
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: metadata
-  script:
-    - npmci command npm install -g typedoc typescript @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.snyk

@@ -1,13 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.5
-# ignores vulnerabilities until expiry date; change duration by modifying expiry date
-ignore:
-  SNYK-JS-MARKED-174116:
-    - typedoc > marked:
-        reason: None given
-        expires: '2019-06-13T06:50:33.594Z'
-  'npm:shelljs:20140723':
-    - typedoc > shelljs:
-        reason: None given
-        expires: '2019-06-13T06:50:33.594Z'
-patch: {}

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

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

@@ -1,11 +1,12 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "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,35 +1,55 @@
 {
-  "name": "@gitzone/tsdoc",
+  "name": "@git.zone/tsdoc",
-  "version": "1.0.3",
+  "version": "1.1.14",
   "private": false,
   "description": "a tool for better documentation",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"
   },
   "scripts": {
-    "test": "(tstest test/) && node ./cli.ts.js",
+    "test": "(tstest test/) && (node ./cli.ts.js)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web --allowimplicitany)"
-    "buildMkdocs": "(cd mkdocs/originalrepo && docker rmi -f mkdocs && docker build -t mkdocs .)",
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@git.zone/tsbuild": "^2.1.65",
-    "@gitzone/tstest": "^1.0.15",
+    "@git.zone/tsrun": "^1.2.46",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@git.zone/tstest": "^1.0.73",
-    "@types/node": "^12.0.0",
+    "@push.rocks/tapbundle": "^5.0.4",
-    "tslint": "^5.11.0",
+    "@types/node": "^20.12.2"
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/early": "^3.0.3",
+    "@push.rocks/early": "^4.0.3",
-    "@pushrocks/smartcli": "^3.0.7",
+    "@push.rocks/npmextra": "^5.0.10",
-    "@pushrocks/smartfile": "^7.0.2",
+    "@push.rocks/qenv": "^6.0.5",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@push.rocks/smartai": "^0.0.6",
-    "@pushrocks/smartlog-destination-local": "^7.0.5",
+    "@push.rocks/smartcli": "^4.0.6",
-    "typedoc": "^0.14.2"
+    "@push.rocks/smartfile": "^11.0.4",
-  }
+    "@push.rocks/smartinteract": "^2.0.14",
+    "@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/**/*",
+    "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,39 @@
+# @git.zone/tsdoc
+a tool for better documentation
+
+## Availabililty and Links
+* [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/)
+
+## Status for master
+
+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/@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/@git.zone/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/@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
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

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,2 +1,57 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
+import * as paths from './tsdoc.paths.js';
 
+export class TypeDoc {
+  public smartshellInstance = new plugins.smartshell.Smartshell({
+    executor: 'bash',
+    pathDirectories: [paths.binDir],
+  });
+
+  // Static
+  public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
+    return true;
+  }
+
+  // Instance
+  public typedocDirectory: string;
+  constructor(dirPathArg) {
+    this.typedocDirectory = dirPathArg;
+  }
+
+  public async compile(options?: { publicSubdir?: string }) {
+    const data = {
+      "compilerOptions": {
+        "experimentalDecorators": true,
+        "useDefineForClassFields": false,
+        "target": "ES2022",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "esModuleInterop": true,
+        "verbatimModuleSyntax": true
+      },
+      include: [],
+    };
+    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 ${targetDir} ${startDirectory}/index.ts`
+    );
+    plugins.smartfile.fs.remove(paths.tsconfigFile);
+  }
+}

ts/tsdoc.cli.ts

@@ -1,14 +1,41 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
-import { logger } from './tsdoc.logging';
+import * as paths from './tsdoc.paths.js';
+import { logger } from './tsdoc.logging.js';
+
+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.addCommand('typedoc').subscribe(async argvArg => {});
 
-  tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {});
+  tsdocCli.standardCommand().subscribe(async (argvArg) => {
-
-  tsdocCli.standardTask().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.triggerCommand('typedoc', argvArg);
+        break;
+      default:
+        logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
+    }
+  });
+
+  tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
+    const typeDocInstance = new TypeDoc(paths.cwd);
+    await typeDocInstance.compile({
+      publicSubdir: argvArg.publicSubdir,
+    });
+  });
+
+  tsdocCli.addCommand('aidocs').subscribe(async (argvArg) => {
+    const aidocs = new AiDocs();
+  })
+
+  tsdocCli.addCommand('test').subscribe((argvArg) => {
+    tsdocCli.triggerCommand('typedoc', argvArg);
+    process.on('exit', async () => {
+      await plugins.smartfile.fs.remove(paths.publicDir);
+    });
   });
 
   tsdocCli.startParse();

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: {
@@ -7,9 +7,9 @@ export const logger = new plugins.smartlog.Smartlog({
     containerName: 'Some Containername',
     environment: 'local',
     runtime: 'node',
-    zone: 'gitzone'
+    zone: 'gitzone',
   },
-  minimumLogLevel: 'silly'
+  minimumLogLevel: 'silly',
 });
 
 logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

ts/tsdoc.paths.ts

@@ -0,0 +1,13 @@
+import * as plugins from './tsdoc.plugins.js';
+
+// dirs
+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');
+export const publicDir = plugins.path.join(cwd, './public');
+export const tsDir = plugins.path.join(cwd, './ts');
+
+// files
+export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');
+export const typedocOptionsFile = plugins.path.join(assetsDir, './typedoc.json');

ts/tsdoc.plugins.ts

@@ -1,17 +1,23 @@
-// pushrocks scope
+// node native
-import * as smartcli from '@pushrocks/smartcli';
+import * as path from 'path';
-import * as smartlog from '@pushrocks/smartlog';
-import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
 
-export {
+export { path };
-  smartcli,
+
-  smartlog,
+// pushrocks scope
-  smartlogDestinationLocal
+import * as npmextra from '@push.rocks/npmextra';
-};
+import * as qenv from '@push.rocks/qenv';
+import * as smartai from '@push.rocks/smartai';
+import * as smartcli from '@push.rocks/smartcli';
+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 { npmextra, qenv, smartai, smartcli, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
 
 // third party scope
 import * as typedoc from 'typedoc';
 
-export {
+export { typedoc };
-  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"
-}