1.1.11

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,4 +1,4 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
-const cliTool = require('./dist_ts/index');
+const cliTool = await import('./dist_ts/index.js');
 cliTool.runCli();

cli.ts.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
-require('@gitzone/tsrun');
+
-const cliTool = require('./ts/index');
+import * as tsrun from '@gitzone/tsrun';
-cliTool.runCli();
+tsrun.runPath('./cli.child.js', import.meta.url);

package.json

@@ -1,10 +1,11 @@
 {
   "name": "@gitzone/tsdoc",
-  "version": "1.1.3",
+  "version": "1.1.11",
   "private": false,
   "description": "a tool for better documentation",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "bin": {
@@ -12,27 +13,24 @@
   },
   "scripts": {
     "test": "(tstest test/) && (node ./cli.ts.js)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany)"
-    "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.65",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tstest": "^1.0.73",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^14.14.9",
+    "@types/node": "^18.7.18"
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/early": "^3.0.6",
+    "@pushrocks/early": "^4.0.3",
-    "@pushrocks/smartcli": "^3.0.12",
+    "@pushrocks/smartcli": "^4.0.6",
-    "@pushrocks/smartfile": "^8.0.8",
+    "@pushrocks/smartfile": "^10.0.5",
-    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartlog": "^3.0.1",
     "@pushrocks/smartlog-destination-local": "^8.0.8",
-    "@pushrocks/smartshell": "^2.0.26",
+    "@pushrocks/smartpath": "^5.0.5",
-    "typedoc": "^0.19.2",
+    "@pushrocks/smartshell": "^2.0.30",
-    "typescript": "^4.1.2"
+    "typedoc": "^0.23.14",
+    "typescript": "^4.8.3"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -25,6 +25,7 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 
 ## Usage
 
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 

test/test.ts

@@ -1,5 +1,5 @@
 import { expect, tap } from '@pushrocks/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: '@gitzone/tsdoc',
+  version: '1.1.11',
+  description: 'a tool for better documentation'
+}

ts/index.ts

@@ -1,6 +1,9 @@
 import * as early from '@pushrocks/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();
+};

ts/tsdoc.classes.typedoc.ts

@@ -1,5 +1,5 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
-import * as paths from './tsdoc.paths';
+import * as paths from './tsdoc.paths.js';
 
 export class TypeDoc {
   public smartshellInstance = new plugins.smartshell.Smartshell({
@@ -9,10 +9,7 @@ export class TypeDoc {
 
   // Static
   public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
-    const result = await plugins.smartfile.fs.fileExists(
+    return true;
-      plugins.path.join(dirPathArg, 'mkdocs.yml')
-    );
-    return !result;
   }
 
   // Instance
@@ -21,26 +18,39 @@ export class TypeDoc {
     this.typedocDirectory = dirPathArg;
   }
 
-  public async compile(options?: {
+  public async compile(options?: { publicSubdir?: string }) {
-    publicSubdir?: string;
-  }) {
     const data = {
       compilerOptions: {
-        target: 'es2017',
+        "experimentalDecorators": true,
-        module: 'commonjs',
+        "useDefineForClassFields": false,
-        esModuleInterop: true,
+        "target": "ES2022",
-        experimentalDecorators: true,
+        "module": "ES2022",
+        "moduleResolution": "nodenext",
+        "skipLibCheck": true,
+        "allowSyntheticDefaultImports": true,
       },
       include: [],
     };
-    data.include = [plugins.path.join(paths.cwd, './ts/**/*')];
+    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}`
+      `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`
     );
     plugins.smartfile.fs.remove(paths.tsconfigFile);
   }

ts/tsdoc.cli.ts

@@ -1,8 +1,8 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
-import * as paths from './tsdoc.paths';
+import * as paths from './tsdoc.paths.js';
-import { logger } from './tsdoc.logging';
+import { logger } from './tsdoc.logging.js';
 
-import { TypeDoc } from './tsdoc.classes.typedoc';
+import { TypeDoc } from './tsdoc.classes.typedoc.js';
 
 export const run = async () => {
   const tsdocCli = new plugins.smartcli.Smartcli();
@@ -22,7 +22,7 @@ export const run = async () => {
   tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
     const typeDocInstance = new TypeDoc(paths.cwd);
     await typeDocInstance.compile({
-      publicSubdir: argvArg.publicSubdir
+      publicSubdir: argvArg.publicSubdir,
     });
   });
 

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: {

ts/tsdoc.paths.ts

@@ -1,7 +1,7 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './tsdoc.plugins.js';
 
 // dirs
-export const packageDir = plugins.path.join(__dirname, '../');
+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');

ts/tsdoc.plugins.ts

@@ -8,9 +8,10 @@ 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 smartpath from '@pushrocks/smartpath';
 import * as smartshell from '@pushrocks/smartshell';
 
-export { smartcli, smartfile, smartlog, smartlogDestinationLocal, smartshell };
+export { smartcli, smartfile, smartlog, smartlogDestinationLocal, smartpath, smartshell };
 
 // third party scope
 import * as typedoc from 'typedoc';

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}

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"
-}