1.1.7

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,102 +18,114 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+
+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
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
-    
+testBuild:
-testSTABLE:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   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:
@@ -121,5 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - 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,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

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

assets/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2017",
-    "module": "commonjs",
-    "esModuleInterop": true
-  }
-}

cli.js

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

cli.ts.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
 require('@gitzone/tsrun');
-require('./ts/index');
+const cliTool = require('./ts/index');
+cliTool.runCli();

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "gitzone",

package.json

@@ -1,47 +1,52 @@
 {
   "name": "@gitzone/tsdoc",
-  "version": "1.0.19",
+  "version": "1.1.7",
   "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",
   "author": "Lossless GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"
   },
   "scripts": {
-    "test": "(tstest test/) && (node ./cli.ts.js) && rm -rf public/",
+    "test": "(tstest test/) && (node ./cli.ts.js)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
     "buildMkdocs": "(cd mkdocs/originalrepo && docker rmi -f mkdocs && docker build -t mkdocs .)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^12.0.2",
+    "@types/node": "^14.14.32",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/early": "^3.0.3",
+    "@pushrocks/early": "^3.0.6",
-    "@pushrocks/smartcli": "^3.0.7",
+    "@pushrocks/smartcli": "^3.0.12",
-    "@pushrocks/smartfile": "^7.0.2",
+    "@pushrocks/smartfile": "^8.0.8",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartlog": "^2.0.39",
-    "@pushrocks/smartlog-destination-local": "^7.0.5",
+    "@pushrocks/smartlog-destination-local": "^8.0.8",
-    "@pushrocks/smartshell": "^2.0.22",
+    "@pushrocks/smartshell": "^2.0.26",
-    "typedoc": "^0.14.2",
+    "typedoc": "^0.20.30",
-    "typescript": "^3.4.5"
+    "typescript": "^4.2.3"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "assets/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,19 +8,32 @@ a tool for better documentation
 * [docs (typedoc)](https://gitzone.gitlab.io/tsdoc/)
 
 ## Status for master
-[![build status](https://gitlab.com/gitzone/tsdoc/badges/master/build.svg)](https://gitlab.com/gitzone/tsdoc/commits/master)
+
-[![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://gitlab.com/gitzone/tsdoc/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/tsdoc.svg)](https://www.npmjs.com/package/@gitzone/tsdoc)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tsdoc/badge.svg)](https://snyk.io/test/npm/@gitzone/tsdoc)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/gitzone/tsdoc/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@gitzone/tsdoc)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+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 (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@gitzone/tsdoc)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@gitzone/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.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

ts/index.ts

@@ -3,4 +3,7 @@ early.start('tsdoc');
 import * as plugins from './tsdoc.plugins';
 import * as cli from './tsdoc.cli';
 early.stop();
-cli.run();
+
+export const runCli = async () => {
+  await cli.run();
+};

ts/tsdoc.classes.mkdocs.ts

@@ -1,67 +0,0 @@
-import * as plugins from './tsdoc.plugins';
-import * as paths from './tsdoc.paths';
-
-export class MkDocs {
-  public smartshellInstance = new plugins.smartshell.Smartshell({
-    executor: 'bash',
-    pathDirectories: [paths.binDir]
-  });
-
-  public static async isMkDocsDir(dirPathArg: string): Promise<boolean> {
-    const result = await plugins.smartfile.fs.fileExists(
-      plugins.path.join(dirPathArg, 'mkdocs.yml')
-    );
-    return result;
-  }
-
-  public static async handleCommand(argvArg) {
-    const mkdocsInstance = new MkDocs(paths.cwd);
-    switch (true) {
-      case argvArg.serve:
-        await mkdocsInstance.serve();
-        break;
-      case argvArg.publish:
-        await mkdocsInstance.publish();
-        break;
-      default:
-        await mkdocsInstance.compile();
-        break;
-    }
-  }
-
-  // Instance
-  public typedocDirectory: string;
-  constructor(dirPathArg) {
-    this.typedocDirectory = dirPathArg;
-  }
-
-  public async update() {
-    await this.smartshellInstance.exec(
-      `docker pull registry.gitlab.com/hosttoday/ht-docker-mkdocs`
-    );
-  }
-
-  public async compile() {
-    await this.update();
-    await this.smartshellInstance.exec(`rm -rf public/`);
-    await this.smartshellInstance.exec(
-      `docker run --rm -p 8000:8000 -v ${
-        paths.cwd
-      }:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs build`
-    );
-  }
-
-  public async serve() {
-    await this.update();
-    await this.smartshellInstance.exec(
-      `docker run --rm -p 8000:8000 -v ${
-        paths.cwd
-      }:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs`
-    );
-  }
-
-  public async publish() {
-    await this.compile();
-    await this.smartshellInstance.exec(`gitzone commit`);
-  }
-}

ts/tsdoc.classes.typedoc.ts

@@ -4,7 +4,7 @@ import * as paths from './tsdoc.paths';
 export class TypeDoc {
   public smartshellInstance = new plugins.smartshell.Smartshell({
     executor: 'bash',
-    pathDirectories: [paths.binDir]
+    pathDirectories: [paths.binDir],
   });
 
   // Static
@@ -21,9 +21,32 @@ export class TypeDoc {
     this.typedocDirectory = dirPathArg;
   }
 
-  public async compile() {
+  public async compile(options?: { publicSubdir?: string }) {
+    const data = {
+      compilerOptions: {
+        target: 'es2017',
+        module: 'commonjs',
+        esModuleInterop: true,
+        experimentalDecorators: true,
+      },
+      include: [],
+    };
+    if (plugins.smartfile.fs.isDirectory(plugins.path.join(paths.cwd, './ts'))) {
+      data.include.push(plugins.path.join(paths.cwd, './ts/**/*'));
+    }
+
+    if (plugins.smartfile.fs.isDirectory(plugins.path.join(paths.cwd, './ts_web'))) {
+      data.include.push(plugins.path.join(paths.cwd, './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 public/ ts/`
+      `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ts/index.ts`
     );
+    plugins.smartfile.fs.remove(paths.tsconfigFile);
   }
 }

ts/tsdoc.cli.ts

@@ -3,36 +3,30 @@ import * as paths from './tsdoc.paths';
 import { logger } from './tsdoc.logging';
 
 import { TypeDoc } from './tsdoc.classes.typedoc';
-import { MkDocs } from './tsdoc.classes.mkdocs';
 
 export const run = async () => {
   const tsdocCli = new plugins.smartcli.Smartcli();
-  tsdocCli.addCommand('typedoc').subscribe(async argvArg => {
-    const typeDocInstance = new TypeDoc(paths.cwd);
-    await typeDocInstance.compile();
-  });
 
-  tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {
+  tsdocCli.standardTask().subscribe(async (argvArg) => {
-    await MkDocs.handleCommand(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.trigger('typedoc');
         break;
-      case await MkDocs.isMkDocsDir(paths.cwd):
-        logger.log('ok', `Detected MkDocs compliant directory at ${paths.cwd}`);
-        tsdocCli.trigger('mkdocs');
-        break;
       default:
         logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
     }
   });
 
-  tsdocCli.addCommand('test').subscribe(argvArg => {
+  tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
+    const typeDocInstance = new TypeDoc(paths.cwd);
+    await typeDocInstance.compile({
+      publicSubdir: argvArg.publicSubdir,
+    });
+  });
+
+  tsdocCli.addCommand('test').subscribe((argvArg) => {
     tsdocCli.trigger('typedoc');
     process.on('exit', async () => {
       await plugins.smartfile.fs.remove(paths.publicDir);

ts/tsdoc.logging.ts

@@ -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

@@ -5,7 +5,9 @@ export const packageDir = plugins.path.join(__dirname, '../');
 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(packageDir, './public');
+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');