1.0.24

.gitignore

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

.gitlab-ci.yml

@@ -4,13 +4,13 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
   - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
+  key: "$CI_BUILD_STAGE"
 
 stages:
-  - security
+- security
-  - test
+- test
-  - release
+- release
-  - metadata
+- metadata
 
 # ====================
 # security stage
@@ -19,35 +19,20 @@ mirror:
   stage: security
   script:
   - npmci git mirror
-  only:
-    - tags
   tags:
-    - lossless
   - docker
   - notpriv
 
-auditProductionDependencies:
+snyk:
-  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 -g snyk
     - 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=dev
   tags:
   - docker
-  allow_failure: true
+  - notpriv
 
 # ====================
 # test stage
@@ -63,6 +48,7 @@ testStable:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
 
 testBuild:
   stage: test
@@ -74,6 +60,7 @@ testBuild:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
 
 release:
   stage: release
@@ -83,7 +70,6 @@ release:
   only:
   - tags
   tags:
-    - lossless
   - docker
   - notpriv
 
@@ -93,15 +79,11 @@ release:
 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
 
@@ -112,20 +94,20 @@ trigger:
   only:
   - tags
   tags:
-    - lossless
   - docker
   - notpriv
 
 pages:
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   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:

.snyk

@@ -0,0 +1,13 @@
+# 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

@@ -1,29 +0,0 @@
-{
-  "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

@@ -1,26 +0,0 @@
-{
-  "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

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

cli.js

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

cli.ts.js

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

npmextra.json

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

package.json

@@ -1,52 +1,47 @@
 {
   "name": "@gitzone/tsdoc",
-  "version": "1.1.3",
+  "version": "1.0.24",
   "private": false,
   "description": "a tool for better documentation",
-  "main": "dist_ts/index.js",
+  "main": "dist/index.js",
-  "typings": "dist_ts/index.d.ts",
+  "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"
   },
   "scripts": {
-    "test": "(tstest test/) && (node ./cli.ts.js)",
+    "test": "(tstest test/) && (node ./cli.ts.js) && rm -rf public/",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild)",
-    "buildMkdocs": "(cd mkdocs/originalrepo && docker rmi -f mkdocs && docker build -t mkdocs .)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^14.14.9",
+    "@types/node": "^12.7.12",
-    "tslint": "^6.1.3",
+    "tslint": "^5.20.0",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/early": "^3.0.6",
+    "@pushrocks/early": "^3.0.3",
-    "@pushrocks/smartcli": "^3.0.12",
+    "@pushrocks/smartcli": "^3.0.7",
-    "@pushrocks/smartfile": "^8.0.8",
+    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartlog-destination-local": "^8.0.8",
+    "@pushrocks/smartlog-destination-local": "^8.0.2",
-    "@pushrocks/smartshell": "^2.0.26",
+    "@pushrocks/smartshell": "^2.0.25",
-    "typedoc": "^0.19.2",
+    "typedoc": "^0.15.0",
-    "typescript": "^4.1.2"
+    "typescript": "^3.6.4"
   },
   "files": [
-    "ts/**/*",
+    "ts/*",
-    "ts_web/**/*",
+    "ts_web/*",
-    "dist/**/*",
+    "dist/*",
-    "dist_*/**/*",
+    "dist_web/*",
-    "dist_ts/**/*",
+    "dist_ts_web/*",
-    "dist_ts_web/**/*",
+    "assets/*",
-    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
-  ],
-  "browserslist": [
-    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,28 +8,16 @@ 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)
-Status Category | Status Badge
+[![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://gitlab.com/gitzone/tsdoc/commits/master)
--- | --
+[![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/tsdoc.svg)](https://www.npmjs.com/package/@gitzone/tsdoc)
-GitLab Pipelines | [![pipeline status](https://gitlab.com/gitzone/tsdoc/badges/master/pipeline.svg)](https://lossless.cloud)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tsdoc/badge.svg)](https://snyk.io/test/npm/@gitzone/tsdoc)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://lossless.cloud)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.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)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/gitzone/tsdoc)](https://lossless.cloud)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-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
 
-
-## 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)

ts/tsdoc.classes.mkdocs.ts

@@ -0,0 +1,63 @@
+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: string) {
+    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.tsdoc.ts

@@ -0,0 +1,62 @@
+import * as plugins from './tsdoc.plugins';
+import { MkDocs } from './tsdoc.classes.mkdocs';
+import { TypeDoc } from './tsdoc.classes.typedoc';
+import { logger } from './tsdoc.logging';
+
+export type TDirectoryType = 'mkdocs' | 'typedoc';
+
+export class TsDoc {
+  public smartshellInstance = new plugins.smartshell.Smartshell({
+    executor: 'bash'
+  });
+  
+  public mkdocs: MkDocs;
+  public typedoc: TypeDoc;
+
+  public cwd: string;
+  public cwdDirType: TDirectoryType;
+
+  constructor(cwdArg: string) {
+    this.cwd = cwdArg;
+    this.mkdocs = new MkDocs(this.cwd);
+    this.typedoc = new TypeDoc(this.cwd);
+  }
+
+  public async buildDirectory() {
+    await this.detectDirectoryType();
+    if (this.cwdDirType === 'mkdocs') {
+      await this.mkdocs.compile();
+    } else if (this.cwdDirType === 'typedoc') {
+      await this.typedoc.compile();
+    }
+    await this.runAdditionalTasks();
+  }
+
+  private async detectDirectoryType () {
+    logger.log('warn', `Auto detecting environment!`);
+    switch (true) {
+      case await TypeDoc.isTypeDocDir(this.cwd):
+        logger.log('ok', `Detected TypeDoc compliant directory at ${this.cwd}`);
+        this.cwdDirType = 'typedoc';
+        break;
+      case await MkDocs.isMkDocsDir(this.cwd):
+        logger.log('ok', `Detected MkDocs compliant directory at ${this.cwd}`);
+        this.cwdDirType = 'mkdocs';
+        break;
+      default:
+        logger.log('error', `Cannot determine docs format at ${this.cwd}`);
+    }
+
+
+  }
+
+  /**
+   * runs additional tasks from package.json
+   */
+  public async runAdditionalTasks() {
+    const packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(this.cwd, 'package.json'));
+    if (packageJson.scripts.tsdoc) {
+      await this.smartshellInstance.exec('npm run tsdoc');
+    }
+  }
+}

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,27 +21,13 @@ export class TypeDoc {
     this.typedocDirectory = dirPathArg;
   }
 
-  public async compile(options?: {
+  public async compile() {
-    publicSubdir?: string;
+    let tsDir: 'ts' | 'ts_web';
-  }) {
+    plugins.smartfile.fs.isDirectory(plugins.path.join(this.typedocDirectory, 'ts')) ? tsDir = 'ts' : null;
-    const data = {
+    plugins.smartfile.fs.isDirectory(plugins.path.join(this.typedocDirectory, 'ts_web')) ? tsDir = 'ts_web' : null;
-      compilerOptions: {
+
-        target: 'es2017',
-        module: 'commonjs',
-        esModuleInterop: true,
-        experimentalDecorators: true,
-      },
-      include: [],
-    };
-    data.include = [plugins.path.join(paths.cwd, './ts/**/*')];
-    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}`
+      `typedoc --tsconfig ${paths.tsconfigFile} --out public/ ${tsDir}`
     );
-    plugins.smartfile.fs.remove(paths.tsconfigFile);
   }
 }

ts/tsdoc.cli.ts

@@ -3,31 +3,22 @@ import * as paths from './tsdoc.paths';
 import { logger } from './tsdoc.logging';
 
 import { TypeDoc } from './tsdoc.classes.typedoc';
+import { MkDocs } from './tsdoc.classes.mkdocs';
+import { TsDoc } from './tsdoc.classes.tsdoc';
 
 export const run = async () => {
   const tsdocCli = new plugins.smartcli.Smartcli();
 
-  tsdocCli.standardTask().subscribe(async (argvArg) => {
+  tsdocCli.standardTask().subscribe(async argvArg => {
-    logger.log('warn', `Auto detecting environment!`);
+    const tsdoc = new TsDoc(paths.cwd);
-    switch (true) {
+    await tsdoc.buildDirectory();
-      case await TypeDoc.isTypeDocDir(paths.cwd):
-        logger.log('ok', `Detected TypeDoc compliant directory at ${paths.cwd}`);
-        tsdocCli.trigger('typedoc');
-        break;
-      default:
-        logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
-    }
   });
 
-  tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
+  tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {
-    const typeDocInstance = new TypeDoc(paths.cwd);
+    await MkDocs.handleCommand(argvArg);
-    await typeDocInstance.compile({
-      publicSubdir: argvArg.publicSubdir
-    });
   });
 
-  tsdocCli.addCommand('test').subscribe((argvArg) => {
+  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,9 +5,7 @@ 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(cwd, './public');
+export const publicDir = plugins.path.join(packageDir, './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');