1.0.22

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -38,19 +38,7 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
-  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
@@ -60,6 +48,18 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+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
   - notpriv
 
 release:
@@ -78,19 +78,11 @@ release:
 # ====================
 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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm install
-        --env SOURCE_CODE="$PWD"
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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
@@ -106,13 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv

assets/tsconfig.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitzone/tsdoc",
-  "version": "1.0.7",
+  "version": "1.0.22",
   "private": false,
   "description": "a tool for better documentation",
   "main": "dist/index.js",
@@ -13,25 +13,35 @@
   "scripts": {
     "test": "(tstest test/) && (node ./cli.ts.js) && rm -rf public/",
     "build": "(tsbuild)",
-    "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.17",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.0.0",
+    "@types/node": "^12.7.12",
-    "tslint": "^5.11.0",
+    "tslint": "^5.20.0",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
     "@pushrocks/early": "^3.0.3",
     "@pushrocks/smartcli": "^3.0.7",
-    "@pushrocks/smartfile": "^7.0.2",
+    "@pushrocks/smartfile": "^7.0.6",
     "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartlog-destination-local": "^7.0.5",
+    "@pushrocks/smartlog-destination-local": "^8.0.2",
-    "@pushrocks/smartshell": "^2.0.13",
+    "@pushrocks/smartshell": "^2.0.25",
-    "typedoc": "^0.14.2",
+    "typedoc": "^0.15.0",
-    "typescript": "^3.4.5"
+    "typescript": "^3.6.4"
-  }
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -21,6 +21,6 @@ a tool for better documentation
 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/tsdoc.classes.mkdocs.ts

@@ -14,25 +14,50 @@ export class MkDocs {
     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) {
+  constructor(dirPathArg: string) {
     this.typedocDirectory = dirPathArg;
   }
 
-  public async update () {
+  public async update() {
-    await this.smartshellInstance.exec(`docker pull registry.gitlab.com/hosttoday/ht-docker-mkdocs`);
+    await this.smartshellInstance.exec(
+      `docker pull registry.gitlab.com/hosttoday/ht-docker-mkdocs`
+    );
   }
 
-  public async compile () {
+  public async compile() {
     await this.update();
     await this.smartshellInstance.exec(`rm -rf public/`);
-    await this.smartshellInstance.exec(`docker run --rm -it -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs build`);
+    await this.smartshellInstance.exec(
-    await this.smartshellInstance.exec(`gitzone commit`);
+      `docker run --rm -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs build`
+    );
   }
 
-  public async serve () {
+  public async serve() {
     await this.update();
-    await this.smartshellInstance.exec(`docker run --rm -it -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs`);
+    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 runAdditionalTasks() {
+    const packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(this.cwd, 'package.json'));
+    if (packageJson.scripts.tsdoc) {
+      this.smartshellInstance.exec('npm run tsdoc');
+    }
+  }
+}

ts/tsdoc.classes.typedoc.ts

@@ -21,7 +21,9 @@ export class TypeDoc {
     this.typedocDirectory = dirPathArg;
   }
 
-  public async compile () {
+  public async compile() {
-    await this.smartshellInstance.exec(`typedoc --module "commonjs" --target "ES2016" --out public/ ts/`);
+    await this.smartshellInstance.exec(
+      `typedoc --tsconfig ${paths.tsconfigFile} --out public/ ts/`
+    );
   }
 }

ts/tsdoc.cli.ts

@@ -4,30 +4,24 @@ 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.addCommand('typedoc').subscribe(async argvArg => {
-
-  });
-
-  tsdocCli.addCommand('mkdocs').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');
+  tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {
-        const typeDocInstance = new TypeDoc(paths.cwd);
+    await MkDocs.handleCommand(argvArg);
-        await typeDocInstance.compile();
+  });
-        break;
+
-      case await MkDocs.isMkDocsDir(paths.cwd):
+  tsdocCli.addCommand('test').subscribe(argvArg => {
-      logger.log('ok', `Detected MkDocs compliant directory at ${paths.cwd}`);
+    process.on('exit', async () => {
-        break;
+      await plugins.smartfile.fs.remove(paths.publicDir);
-      default:
+    });
-        logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
-    }
   });
 
   tsdocCli.startParse();

ts/tsdoc.paths.ts

@@ -1,5 +1,11 @@
 import * as plugins from './tsdoc.plugins';
 
+// dirs
 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');
+
+// files
+export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');