1.1.7

.gitignore

@@ -8,13 +8,13 @@ pages/
 # installs
 node_modules/
 
-# caches and builds
+# caches
 .yarn/
 .cache/
-dist/
+.rpt2_cache
-dist_web/
-dist_serve/
-dist_ts_web/
 
-# custom
+# builds
-mkdocs/originalrepo
+dist/
+dist_*/
+
+# 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 command npm install -g typedoc typescript @gitzone/tsdoc
+    - npmci node install lts
+    - 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:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

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

cli.js

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

cli.ts.js

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

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "gitzone",
@@ -14,4 +15,4 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -1,28 +1,52 @@
 {
   "name": "@gitzone/tsdoc",
-  "version": "1.0.2",
+  "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/)",
+    "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.15",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^12.0.0",
+    "@types/node": "^14.14.32",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartcli": "^3.0.7",
+    "@pushrocks/early": "^3.0.6",
-    "typedoc": "^0.14.2"
+    "@pushrocks/smartcli": "^3.0.12",
-  }
+    "@pushrocks/smartfile": "^8.0.8",
+    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartlog-destination-local": "^8.0.8",
+    "@pushrocks/smartshell": "^2.0.26",
+    "typedoc": "^0.20.30",
+    "typescript": "^4.2.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 @@
+# @gitzone/tsdoc
+a tool for better documentation
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/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/@gitzone/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 (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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

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

ts/index.ts

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

ts/tsdoc.classes.typedoc.ts

@@ -1,2 +1,52 @@
 import * as plugins from './tsdoc.plugins';
+import * as paths from './tsdoc.paths';
 
+export class TypeDoc {
+  public smartshellInstance = new plugins.smartshell.Smartshell({
+    executor: 'bash',
+    pathDirectories: [paths.binDir],
+  });
+
+  // Static
+  public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
+    const result = await plugins.smartfile.fs.fileExists(
+      plugins.path.join(dirPathArg, 'mkdocs.yml')
+    );
+    return !result;
+  }
+
+  // Instance
+  public typedocDirectory: string;
+  constructor(dirPathArg) {
+    this.typedocDirectory = dirPathArg;
+  }
+
+  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 ${targetDir} ts/index.ts`
+    );
+    plugins.smartfile.fs.remove(paths.tsconfigFile);
+  }
+}

ts/tsdoc.cli.ts

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

ts/tsdoc.logging.ts

@@ -0,0 +1,15 @@
+import * as plugins from './tsdoc.plugins';
+
+export const logger = new plugins.smartlog.Smartlog({
+  logContext: {
+    company: 'Some Company',
+    companyunit: 'Some CompanyUnit',
+    containerName: 'Some Containername',
+    environment: 'local',
+    runtime: 'node',
+    zone: 'gitzone',
+  },
+  minimumLogLevel: 'silly',
+});
+
+logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

ts/tsdoc.paths.ts

@@ -0,0 +1,13 @@
+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(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,13 +1,18 @@
+// node native
+import * as path from 'path';
+
+export { path };
+
 // pushrocks scope
 import * as smartcli from '@pushrocks/smartcli';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
+import * as smartshell from '@pushrocks/smartshell';
 
-export {
+export { smartcli, smartfile, smartlog, smartlogDestinationLocal, smartshell };
-  smartcli
-};
 
 // third party scope
 import * as typedoc from 'typedoc';
 
-export {
+export { typedoc };
-  typedoc
-};