1.1.24

.gitignore

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

.gitlab-ci.yml

@@ -1,125 +0,0 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
-
-stages:
-- security
-- test
-- release
-- metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# test stage
-# ====================
-
-testLTS:
-  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
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install stable
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-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/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --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
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: metadata
-  script:
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - 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,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

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

cli.ts.js

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

npmextra.json

@@ -1,17 +1,38 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "gitzone",
       "gitrepo": "tsdoc",
       "shortDescription": "a tool for better documentation",
-      "npmPackagename": "@gitzone/tsdoc",
+      "npmPackagename": "@git.zone/tsdoc",
       "license": "MIT",
-      "projectDomain": "git.zone"
+      "projectDomain": "git.zone",
+      "description": "An advanced TypeScript documentation tool leveraging AI for enhanced insights and automated documentation generation, with capabilities for automated and enhanced documentation creation tailor-made for TypeScript projects.",
+      "keywords": [
+        "TypeScript",
+        "documentation",
+        "AI-enhanced documentation",
+        "automated documentation generation",
+        "code analysis",
+        "development tool",
+        "CLI utility",
+        "API documentation",
+        "developer productivity",
+        "code insights",
+        "integrated development environment tooling",
+        "code quality enhancement",
+        "project documentation",
+        "documentation automation"
+      ]
     }
   },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,47 +1,73 @@
 {
-  "name": "@gitzone/tsdoc",
+  "name": "@git.zone/tsdoc",
-  "version": "1.0.19",
+  "version": "1.1.24",
   "private": false,
-  "description": "a tool for better documentation",
+  "description": "An advanced TypeScript documentation tool leveraging AI for enhanced insights and automated documentation generation, with capabilities for automated and enhanced documentation creation tailor-made for TypeScript projects.",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"
   },
   "scripts": {
-    "test": "(tstest test/) && (node ./cli.ts.js) && rm -rf public/",
+    "test": "(tstest test/) && npm run testCli",
-    "build": "(tsbuild)",
+    "testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
-    "buildMkdocs": "(cd mkdocs/originalrepo && docker rmi -f mkdocs && docker build -t mkdocs .)",
+    "build": "(tsbuild --web --allowimplicitany)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@git.zone/tsbuild": "^2.1.65",
-    "@gitzone/tstest": "^1.0.24",
+    "@git.zone/tsrun": "^1.2.46",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@git.zone/tstest": "^1.0.73",
-    "@types/node": "^12.0.2",
+    "@push.rocks/tapbundle": "^5.0.4",
-    "tslint": "^5.11.0",
+    "@types/node": "^20.12.7"
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/early": "^3.0.3",
+    "@push.rocks/early": "^4.0.3",
-    "@pushrocks/smartcli": "^3.0.7",
+    "@push.rocks/npmextra": "^5.0.10",
-    "@pushrocks/smartfile": "^7.0.2",
+    "@push.rocks/qenv": "^6.0.5",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@push.rocks/smartai": "^0.0.8",
-    "@pushrocks/smartlog-destination-local": "^7.0.5",
+    "@push.rocks/smartcli": "^4.0.6",
-    "@pushrocks/smartshell": "^2.0.22",
+    "@push.rocks/smartdelay": "^3.0.5",
-    "typedoc": "^0.14.2",
+    "@push.rocks/smartfile": "^11.0.13",
-    "typescript": "^3.4.5"
+    "@push.rocks/smartinteract": "^2.0.15",
+    "@push.rocks/smartlog": "^3.0.1",
+    "@push.rocks/smartlog-destination-local": "^9.0.1",
+    "@push.rocks/smartpath": "^5.0.13",
+    "@push.rocks/smartshell": "^3.0.4",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.4.5"
   },
   "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"
+  ],
+  "keywords": [
+    "TypeScript",
+    "documentation",
+    "AI-enhanced documentation",
+    "automated documentation generation",
+    "code analysis",
+    "development tool",
+    "CLI utility",
+    "API documentation",
+    "developer productivity",
+    "code insights",
+    "integrated development environment tooling",
+    "code quality enhancement",
+    "project documentation",
+    "documentation automation"
   ]
 }

readme.hints.md

@@ -0,0 +1,5 @@
+* module needs to be installed globally
+* alternatively can be used through npx, if installed locally
+* cli parameters are concluded from ./ts/cli.ts
+* this module is not intended for API use.
+* Read carefully through the TypeScript files. Don't make stuff up.

readme.md

@@ -1,26 +1,108 @@
-# @gitzone/tsdoc
+# @git.zone/tsdoc
-a tool for better documentation
+An advanced TypeScript documentation tool that leverages AI for enhanced insights and automated documentation generation.
 
-## Availabililty and Links
+## Install
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsdoc)
+To install `@git.zone/tsdoc`, you have two options depending on your usage preference: globally for CLI use or locally within your project for use through NPX. To install globally, run:
-* [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
+```sh
-[![build status](https://gitlab.com/gitzone/tsdoc/badges/master/build.svg)](https://gitlab.com/gitzone/tsdoc/commits/master)
+npm install -g @git.zone/tsdoc
-[![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)
+
-[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tsdoc/badge.svg)](https://snyk.io/test/npm/@gitzone/tsdoc)
+For local installation within your project, use:
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+```sh
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+npm install --save @git.zone/tsdoc
+```
+
+You can then use the tool through NPX if installed locally:
+
+```sh
+npx tsdoc
+```
 
 ## Usage
+`@git.zone/tsdoc` is a tool designed to improve the process of generating documentation for TypeScript projects. It combines the capabilities of Typedoc with AI-powered features to automatically generate insights and enhance the quality of your API documentation without manual intervention.
 
-For further information read the linked docs at the top of this readme.
+To get started, after installation, navigate to the root directory of your TypeScript project where your `tsconfig.json` is located and run:
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+```typescript
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+import { runCli } from '@git.zone/tsdoc';
 
-[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+// Initialize and run the CLI
+runCli().then(() => {
+  console.log('Documentation generation complete!');
+}).catch((error) => {
+  console.error('Failed to generate documentation:', error);
+});
+```
+
+### Generating Documentation
+`@git.zone/tsdoc` provides a command-line interface to generate documentation directly from your TypeScript source files. The CLI uses information from your TypeScript configuration and the source files to create comprehensive documentation.
+
+Once `tsdoc` is installed globally, you can run the following command in the root of your TypeScript project:
+
+```sh
+tsdoc
+```
+
+This command analyzes your TypeScript project, extracts type information, and generates documentation pages as HTML or Markdown. You can customize the output format and specify additional options via command line parameters or by editing `tsdoc` configuration files.
+
+### Command Line Parameters
+The CLI tool reads options from `./ts/cli.ts`. Command line parameters allow you to customize the behavior of `tsdoc`. For more detailed usage, run:
+
+```sh
+tsdoc --help
+```
+
+This will display a list of available commands and options, such as specifying the output directory for the generated documentation or enabling/disabling certain features of the documentation generator.
+
+### Examples
+Below is an example of how to use `tsdoc` to generate documentation with custom options:
+
+```sh
+tsdoc --output docs/api --format html
+```
+This command generates HTML documentation for your project and places it in the `docs/api` directory.
+
+### Additional Features
+Beyond basic documentation generation, `tsdoc` integrates AI-powered analysis to enrich the documentation automatically. This feature helps by providing insights into complex types, documenting patterns used within your codebase, and suggesting improvements for better maintainability and readability of your documentation.
+
+**Note:** `tsdoc` is designed for use with projects adhering to modern TypeScript conventions. Ensure your project structure and TypeScript configuration are compatible for optimal results.
+
+### Integration with CI/CD
+`@git.zone/tsdoc` can be integrated into your CI/CD pipelines to automatically generate and update documentation as part of your build process. This ensures that your API documentation is always up-to-date with your codebase.
+
+Here's an example configuration snippet for a CI workflow:
+
+```yml
+steps:
+  - name: Install tsdoc
+    run: npm install -g @git.zone/tsdoc
+  
+  - name: Generate Documentation
+    run: tsdoc
+```
+
+Remember to replace placeholders and adjust paths as necessary depending on your CI provider and project configuration.
+
+### Conclusion
+`@git.zone/tsdoc` is a powerful tool that leverages the best of Typedoc and AI to streamline the documentation process for TypeScript projects. By automating the generation of insightful and comprehensive documentation, it enhances developer productivity and improves the quality of project documentation.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.aidoc.nonci.ts

@@ -0,0 +1,27 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as qenv from '@push.rocks/qenv';
+let testQenv = new qenv.Qenv('./', '.nogit/');
+
+import * as tsdocs from '../ts/index.js';
+
+let aidocs: tsdocs.AiDoc;
+
+tap.test('should create an AIdocs class', async () => {
+  aidocs = new tsdocs.AiDoc({
+    'OPENAI_TOKEN': await testQenv.getEnvVarOnDemand('OPENAI_TOKEN')
+  });
+  expect(aidocs).toBeInstanceOf(tsdocs.AiDoc);
+});
+
+tap.test('should start AIdocs', async () => {
+  await aidocs.start();
+  await aidocs.buildReadme('./');
+})
+
+tap.test('should start AIdocs', async () => {
+  await aidocs.start();
+  await aidocs.buildDescription('./');
+})
+
+
+tap.start();

test/test.ts

@@ -1,5 +1,5 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/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: '@git.zone/tsdoc',
+  version: '1.1.24',
+  description: 'An advanced TypeScript documentation tool leveraging AI for enhanced insights and automated documentation generation, with capabilities for automated and enhanced documentation creation tailor-made for TypeScript projects.'
+}

ts/aidocs_classes/description.ts

@@ -0,0 +1,73 @@
+import type { AiDoc } from '../classes.aidoc.js';
+import * as plugins from '../plugins.js';
+import { ProjectContext } from './projectcontext.js';
+
+interface IDescriptionInterface {
+  description: string;
+  keywords: string[];
+}
+
+export class Description {
+
+  // INSTANCE
+  private aiDocsRef: AiDoc;
+  private projectDir: string;
+
+  constructor(aiDocsRef: AiDoc, projectDirArg: string) {
+    this.aiDocsRef = aiDocsRef;
+    this.projectDir = projectDirArg;
+  }
+
+  public async build() {
+    // we can now assemble the directory structure.
+    const projectContext = new ProjectContext(this.projectDir);
+    const contextString = await projectContext.update();
+
+    let result = await this.aiDocsRef.openaiInstance.chat(
+      `
+        You create a json adhering the following interface:
+        {
+          description: string; // a sensible short, one sentence description of the project
+          keywords: string[]; // an array of tags that describe the project
+        }
+
+        The description should be based on what you understand from the project's files.
+        The keywords should be based on use cases you see from the files.
+        Don't be cheap about the way you think.
+
+        Important: Answer only in valid JSON.
+        You answer should be parseable with JSON.parse() without modifying anything.
+
+        Don't wrap the JSON in three ticks json!!!
+      `,
+      contextString,
+      []
+    );
+
+    console.log(result.message.content);
+    const resultObject: IDescriptionInterface = JSON.parse(result.message.content.replace('```json', '').replace('```', ''));
+    
+    const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;
+    const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
+
+    npmextraJsonContent.gitzone.module.description = resultObject.description;
+    npmextraJsonContent.gitzone.module.keywords = resultObject.keywords;
+
+    npmextraJson.contents = Buffer.from(JSON.stringify(npmextraJsonContent, null, 2));
+    await npmextraJson.write();
+
+    // do the same with packageJson
+    const packageJson = (await projectContext.gatherFiles()).smartfilePackageJSON;
+    const packageJsonContent = JSON.parse(packageJson.contents.toString());
+    packageJsonContent.description = resultObject.description;
+    packageJsonContent.keywords = resultObject.keywords;
+    packageJson.contents = Buffer.from(JSON.stringify(packageJsonContent, null, 2));
+    await packageJson.write();
+
+
+    console.log(`\n======================\n`);
+    console.log(JSON.stringify(resultObject, null, 2));
+    console.log(`\n======================\n`);
+    return result.message.content;
+  }
+}

ts/aidocs_classes/index.ts

@@ -0,0 +1,3 @@
+export * from './description.js';
+export * from './projectcontext.js';
+export * from './readme.js';

ts/aidocs_classes/projectcontext.ts

@@ -0,0 +1,80 @@
+import * as plugins from '../plugins.js';
+
+export class ProjectContext {
+  public static async fromDir(dirArg: string) {}
+
+  // INSTANCE
+  public projectDir: string;
+
+  constructor(projectDirArg: string) {
+    this.projectDir = projectDirArg;
+  }
+
+  public async gatherFiles() {
+    const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
+      plugins.path.join(this.projectDir, 'package.json'),
+      this.projectDir
+    );
+    const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath(
+      plugins.path.join(this.projectDir, 'readme.md'),
+      this.projectDir
+    );
+
+    const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath(
+      plugins.path.join(this.projectDir, 'readme.hints.md'),
+      this.projectDir
+    );
+    const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath(
+      plugins.path.join(this.projectDir, 'npmextra.json'),
+      this.projectDir
+    );
+    const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
+      this.projectDir,
+      'ts/**/*.ts'
+    );
+    const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
+      this.projectDir,
+      'test/**/*.ts'
+    );
+    return {
+      smartfilePackageJSON,
+      smartfilesReadme,
+      smartfilesReadmeHints,
+      smartfilesNpmextraJSON,
+      smartfilesMod,
+      smartfilesTest,
+    };
+  }
+
+  public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
+    return filesArg
+      .map((smartfile) => {
+        return `
+====== START OF FILE ${smartfile.relative} ======
+  
+${smartfile.contents.toString()}
+  
+====== END OF FILE ${smartfile.relative} ======
+        `;
+      })
+      .join('\n');
+  }
+
+  private async buildContext(dirArg: string) {
+    const files = await this.gatherFiles();
+    let context = await this.convertFilesToContext([
+      files.smartfilePackageJSON,
+      files.smartfilesReadme,
+      files.smartfilesReadmeHints,
+      files.smartfilesNpmextraJSON,
+      ...files.smartfilesMod,
+      ...files.smartfilesTest,
+    ]);
+    return context;
+  }
+
+  public async update() {
+    const result = await this.buildContext(this.projectDir);
+    return result;
+  }
+}

ts/aidocs_classes/readme.ts

@@ -0,0 +1,86 @@
+import type { AiDoc } from '../classes.aidoc.js';
+import * as plugins from '../plugins.js';
+import { ProjectContext } from './projectcontext.js';
+
+export class Readme {
+
+  // INSTANCE
+  private aiDocsRef: AiDoc;
+  private projectDir: string;
+
+  constructor(aiDocsRef: AiDoc, projectDirArg: string) {
+    this.aiDocsRef = aiDocsRef;
+    this.projectDir = projectDirArg;
+  }
+
+  public async build() {
+    let finalReadmeString = ``;
+
+    // we can now assemble the directory structure.
+    const projectContext = new ProjectContext(this.projectDir);
+    const contextString = await projectContext.update();
+
+    // lets first check legal before introducung any cost
+    const npmExtraJson = JSON.parse(((await projectContext.gatherFiles()).smartfilesNpmextraJSON).contents.toString());
+    const legalInfo = npmExtraJson?.tsdoc?.legal
+    if (!legalInfo) {
+      const error = new Error(`No legal information found in npmextra.json`);
+      console.log(error);
+    }
+
+    let result = await this.aiDocsRef.openaiInstance.chat(
+      `
+You create markdown readmes for npm projects. You only output the markdown readme.
+
+The Readme should follow the following template:
+
+# Project Name
+[
+  The name is the module name of package.json
+  The description is in the description field of package.json
+]
+
+## Install
+[
+  Write a short text on how to install the project
+]
+
+## Usage
+[ 
+  Give code examples here.
+  Construct sensible scenarios for the user.
+  Make sure to show a complete set of features of the module.
+  Don't omit use cases.
+  It does not matter how much time you need.
+  ALWAYS USE ESM SYNTAX AND TYPESCRIPT.
+  DON'T CHICKEN OUT. Write at least 4000 words. More if necessary.
+  If there is already a readme, take the Usage section as base. Remove outdated content, and expand and improve upon the valid parts.
+  Super important: Check for completenes.
+  Don't include any licensing information. This will be added in a later step.
+  Avoid "in conclusions".
+
+  Good to know:
+  * npmextra.json contains overall module information.
+  * readme.hints.md provides valuable hints about module ideas.
+]
+      `,
+      contextString,
+      []
+    );
+    
+
+    finalReadmeString += result.message.content + '\n' + legalInfo;
+
+    
+
+    console.log(`\n======================\n`);
+    console.log(result.message.content);
+    console.log(`\n======================\n`);
+
+    const readme = (await projectContext.gatherFiles()).smartfilesReadme;
+    readme.contents = Buffer.from(finalReadmeString);
+    await readme.write();
+
+    return result.message.content;
+  }
+}

ts/classes.aidoc.ts

@@ -0,0 +1,82 @@
+import * as plugins from './plugins.js';
+
+import * as aiDocsClasses from './aidocs_classes/index.js';
+
+export class AiDoc {
+  private openaiToken: string;
+
+  public npmextraKV: plugins.npmextra.KeyValueStore;
+  public qenvInstance: plugins.qenv.Qenv;
+  public smartinteractInstance: plugins.smartinteract.SmartInteract;
+  public openaiInstance: plugins.smartai.OpenAiProvider;
+
+  argvArg: any;
+
+  constructor(argvArg?: any) {
+    this.argvArg = argvArg;
+  }
+
+  private printSanitizedToken() {
+    // Check if the token length is greater than the sum of startLength and endLength
+    let printToken: string;
+    if (this.openaiToken.length > 6) {
+      // Extract the beginning and end parts of the token
+      const start = this.openaiToken.substring(0, 3);
+      const end = this.openaiToken.substring(this.openaiToken.length - 3);
+      printToken = `${start}...${end}`;
+    } else {
+      // If the token is not long enough, return it as is
+      printToken = this.openaiToken;
+    }
+    console.log(`OpenAI Token on record: ${printToken}`);
+  }
+
+  public async start() {
+    // lets care about prerequisites
+    this.smartinteractInstance = new plugins.smartinteract.SmartInteract();
+    this.qenvInstance = new plugins.qenv.Qenv();
+    if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
+      this.npmextraKV = new plugins.npmextra.KeyValueStore({
+        typeArg: 'userHomeDir',
+        identityArg: 'tsdoc',
+        mandatoryKeys: ['OPENAI_TOKEN'],
+      });
+
+      const missingKeys = this.npmextraKV.getMissingMandatoryKeys();
+      if (missingKeys.length > 0) {
+        // lets try argv
+        if (this.argvArg?.OPENAI_TOKEN) {
+          this.openaiToken = this.argvArg.OPENAI_TOKEN;
+        } else {
+          // lets try smartinteract
+          // wait for a second until OpenAI fixes punycode problem...
+          await plugins.smartdelay.delayFor(1000);
+          const answerObject = await this.smartinteractInstance.askQuestion({
+            type: 'input',
+            message: `Please provide your OpenAI token`,
+            name: 'OPENAI_TOKEN',
+            default: '',
+          });
+          this.openaiToken = answerObject.value;
+        }
+
+        this.printSanitizedToken();
+        await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
+      }
+    }
+
+    // lets assume we have an OPENAI_Token now
+    this.openaiInstance = new plugins.smartai.OpenAiProvider(this.openaiToken);
+    await this.openaiInstance.start();
+  }
+
+  public async buildReadme(projectDirArg: string) {
+    const readmeInstance = new aiDocsClasses.Readme(this, projectDirArg);
+    return await readmeInstance.build();
+  }
+
+  public async buildDescription(projectDirArg: string) {
+    const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg);
+    return await descriptionInstance.build();
+  }
+}

ts/classes.typedoc.ts

@@ -0,0 +1,58 @@
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+
+export class TypeDoc {
+  public smartshellInstance = new plugins.smartshell.Smartshell({
+    executor: 'bash',
+    pathDirectories: [paths.binDir],
+  });
+
+  // Static
+  public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
+    return true;
+  }
+
+  // Instance
+  public typedocDirectory: string;
+  constructor(dirPathArg) {
+    this.typedocDirectory = dirPathArg;
+  }
+
+  public async compile(options?: { publicSubdir?: string }) {
+    const data = {
+      "compilerOptions": {
+        "experimentalDecorators": true,
+        "useDefineForClassFields": false,
+        "target": "ES2022",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "esModuleInterop": true,
+        "verbatimModuleSyntax": true,
+        "skipLibCheck": true,
+      },
+      include: [],
+    };
+    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} ${startDirectory}/index.ts`
+    );
+    plugins.smartfile.fs.remove(paths.tsconfigFile);
+  }
+}

ts/cli.ts

@@ -0,0 +1,49 @@
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+import { logger } from './logging.js';
+
+import { TypeDoc } from './classes.typedoc.js';
+import { AiDoc } from './classes.aidoc.js';
+
+export const run = async () => {
+  const tsdocCli = new plugins.smartcli.Smartcli();
+
+  tsdocCli.standardCommand().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.triggerCommand('typedoc', argvArg);
+        break;
+      default:
+        logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
+    }
+  });
+
+  tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
+    const typeDocInstance = new TypeDoc(paths.cwd);
+    await typeDocInstance.compile({
+      publicSubdir: argvArg.publicSubdir,
+    });
+  });
+
+  tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
+    logger.log('info', `Generating new readme...`);
+    logger.log('info', `This may take some time...`);
+    const aidocInstance = new AiDoc();
+    await aidocInstance.start();
+    aidocInstance.buildReadme(paths.cwd);
+    logger.log('info', `Generating new keywords...`);
+    logger.log('info', `This may take some time...`);
+    aidocInstance.buildDescription(paths.cwd);
+  })
+
+  tsdocCli.addCommand('test').subscribe((argvArg) => {
+    tsdocCli.triggerCommand('typedoc', argvArg);
+    process.on('exit', async () => {
+      await plugins.smartfile.fs.remove(paths.publicDir);
+    });
+  });
+
+  tsdocCli.startParse();
+};

ts/index.ts

@@ -1,6 +1,12 @@
-import * as early from '@pushrocks/early';
+import * as early from '@push.rocks/early';
 early.start('tsdoc');
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './plugins.js';
-import * as cli from './tsdoc.cli';
+import * as cli from './cli.js';
 early.stop();
-cli.run();
+
+export const runCli = async () => {
+  await cli.run();
+};
+
+// exports
+export * from './classes.aidoc.js';

ts/logging.ts

@@ -1,4 +1,4 @@
-import * as plugins from './tsdoc.plugins';
+import * as plugins from './plugins.js';
 
 export const logger = new plugins.smartlog.Smartlog({
   logContext: {
@@ -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/paths.ts

@@ -0,0 +1,13 @@
+import * as plugins from './plugins.js';
+
+// dirs
+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');
+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/plugins.ts

@@ -0,0 +1,24 @@
+// node native
+import * as path from 'path';
+
+export { path };
+
+// pushrocks scope
+import * as npmextra from '@push.rocks/npmextra';
+import * as qenv from '@push.rocks/qenv';
+import * as smartai from '@push.rocks/smartai';
+import * as smartcli from '@push.rocks/smartcli';
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartinteract from '@push.rocks/smartinteract';
+import * as smartlog from '@push.rocks/smartlog';
+import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartshell from '@push.rocks/smartshell';
+
+export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
+
+// third party scope
+import * as typedoc from 'typedoc';
+
+export { typedoc };

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

@@ -1,29 +0,0 @@
-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() {
-    await this.smartshellInstance.exec(
-      `typedoc --tsconfig ${paths.tsconfigFile} --out public/ ts/`
-    );
-  }
-}

ts/tsdoc.cli.ts

@@ -1,43 +0,0 @@
-import * as plugins from './tsdoc.plugins';
-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 => {
-    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.trigger('typedoc');
-    process.on('exit', async () => {
-      await plugins.smartfile.fs.remove(paths.publicDir);
-    });
-  });
-
-  tsdocCli.startParse();
-};

ts/tsdoc.paths.ts

@@ -1,11 +0,0 @@
-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');

ts/tsdoc.plugins.ts

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

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

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