1.1.41

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: code.foss.global/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: code.foss.global/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

changelog.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 1.1.41
+fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions
+
+## 1.0.2
+- fix(core): update

npmextra.json

@@ -9,18 +9,18 @@
       "npmPackagename": "@git.zone/tsdoc",
       "license": "MIT",
       "projectDomain": "git.zone",
-      "description": "An advanced TypeScript documentation tool leveraging AI for enhanced insights and automated documentation generation.",
+      "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
       "keywords": [
         "TypeScript",
         "documentation generation",
         "AI-enhanced documentation",
-        "automated documentation",
-        "code analysis",
-        "type annotations",
-        "continuous integration documentation",
-        "markdown",
         "CLI tool",
-        "software development tool"
+        "code analysis",
+        "automated documentation",
+        "developer tools",
+        "API documentation",
+        "technical writing",
+        "code quality improvement"
       ]
     }
   },

package.json

@@ -1,42 +1,46 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.1.16",
+  "version": "1.1.41",
   "private": false,
-  "description": "An advanced TypeScript documentation tool leveraging AI for enhanced insights and automated documentation generation.",
-  "main": "dist_ts/index.js",
-  "typings": "dist_ts/index.d.ts",
+  "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
   "type": "module",
-  "author": "Lossless GmbH",
+  "exports": {
+    ".": "./dist_ts/index.js"
+  },
+  "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"
   },
   "scripts": {
-    "test": "(tstest test/) && (node ./cli.ts.js)",
-    "build": "(tsbuild --web --allowimplicitany)"
+    "test": "(tstest test/) && npm run testCli",
+    "testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.65",
+    "@git.zone/tsbuild": "^2.1.80",
     "@git.zone/tsrun": "^1.2.46",
-    "@git.zone/tstest": "^1.0.73",
-    "@push.rocks/tapbundle": "^5.0.4",
-    "@types/node": "^20.12.7"
+    "@git.zone/tstest": "^1.0.90",
+    "@push.rocks/tapbundle": "^5.0.23",
+    "@types/node": "^20.14.8"
   },
   "dependencies": {
     "@push.rocks/early": "^4.0.3",
-    "@push.rocks/npmextra": "^5.0.10",
+    "@push.rocks/npmextra": "^5.0.23",
     "@push.rocks/qenv": "^6.0.5",
-    "@push.rocks/smartai": "^0.0.8",
-    "@push.rocks/smartcli": "^4.0.6",
+    "@push.rocks/smartai": "^0.0.17",
+    "@push.rocks/smartcli": "^4.0.11",
     "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartfile": "^11.0.13",
+    "@push.rocks/smartfile": "^11.0.20",
+    "@push.rocks/smartgit": "^3.0.4",
     "@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"
+    "@push.rocks/smartlog": "^3.0.7",
+    "@push.rocks/smartlog-destination-local": "^9.0.2",
+    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartshell": "^3.0.5",
+    "typedoc": "^0.26.0",
+    "typescript": "^5.5.2"
   },
   "files": [
     "ts/**/*",
@@ -57,12 +61,20 @@
     "TypeScript",
     "documentation generation",
     "AI-enhanced documentation",
-    "automated documentation",
-    "code analysis",
-    "type annotations",
-    "continuous integration documentation",
-    "markdown",
     "CLI tool",
-    "software development tool"
-  ]
+    "code analysis",
+    "automated documentation",
+    "developer tools",
+    "API documentation",
+    "technical writing",
+    "code quality improvement"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/gitzone/tsdoc.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/gitzone/tsdoc/issues"
+  },
+  "homepage": "https://gitlab.com/gitzone/tsdoc#readme"
 }

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,85 +1,312 @@
 # @git.zone/tsdoc
-A TypeScript documentation tool with extensive features including AI-driven documentation enhancements.
+
+An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
 
 ## Install
-To install `@git.zone/tsdoc`, use npm (Node Package Manager). First, ensure you have Node.js installed on your system. Then, open a terminal and execute the following command:
+
+To install `@git.zone/tsdoc`, you can either install it globally or use it with `npx`.
+
+### Global Installation
+
+You can install `@git.zone/tsdoc` globally on your system using npm:
 
 ```bash
-npm install @git.zone/tsdoc --save
+npm install -g @git.zone/tsdoc
 ```
 
-This command downloads and installs `@git.zone/tsdoc`, adding it to your project's dependencies.
+### Usage with npx
+
+If you prefer not to install it globally, you can use it with `npx`:
+
+```bash
+npx @git.zone/tsdoc <command>
+```
 
 ## Usage
-The usage section for `@git.zone/tsdoc` aims to guide you through leveraging the tool's capabilities for enhancing your TypeScript project documentation with AI-driven optimizations. Complete usage instructions exceed the space constraints here but include essential setup steps, examples, recommended practices, and how to integrate `@git.zone/tsdoc` into your project effectively.
 
-### Getting Started
-First, ensure you import `@git.zone/tsdoc` functionalities into your project. Start by importing necessary functions or classes provided by the module in your TypeScript file:
+`@git.zone/tsdoc` provides a comprehensive CLI tool and advanced AI-enhanced features to generate and enhance documentation for your TypeScript projects.
 
-```typescript
-import { runCli } from '@git.zone/tsdoc';
+### Using the CLI
+
+The primary interface for `@git.zone/tsdoc` is through its command-line tool. Below, we'll explore the different commands available and provide examples of how to use them.
+
+### Commands
+
+#### `tsdoc` - Auto-detect Documentation Format
+
+The standard command will automatically detect the documentation format of your project and generate the appropriate documentation.
+
+```bash
+tsdoc
 ```
 
-### Basic Documentation Generation
-`@git.zone/tsdoc` simplifies the generation of robust documentation for TypeScript projects. Initiate documentation generation by invoking the `runCli` method or through the CLI tool provided:
+### Example
 
 ```typescript
-// Programmatically
-await runCli();
-
-// Or using the CLI directly
-tsdoc generate
+// In a TypeScript project, run the above command.
 ```
 
-This process involves scanning for TypeScript annotations and comments to produce detailed documentation.
+#### `tsdoc typedoc` - Generate Documentation using TypeDoc
 
-### Advanced Features
-To get the most out of `@git.zone/tsdoc`, explore its AI-driven features designed to enhance the documentation further:
+The `typedoc` command will generate documentation compliant with the TypeDoc format.
 
-- **AI-Assisted Commenting**: Utilizes AI to suggest comments for complex code sections, improving understandability.
-- **Documentation Quality Analysis**: Employs AI algorithms to evaluate and suggest improvements for your project's documentation, aiming for clarity, completeness, and effectiveness.
+```bash
+tsdoc typedoc --publicSubdir docs
+```
 
-### Continuous Integration
-Integrate documentation generation into your continuous integration pipeline to automate the creation and updating of documentation with each code change. This approach ensures your documentation remains up-to-date and relevant.
-
-### Example: Documenting a TypeScript Module
-Consider a module that provides basic arithmetic operations. Here's how you might document it using `@git.zone/tsdoc`:
+### Example
 
 ```typescript
-/**
- * A simple arithmetic calculator class.
- */
-export class Calculator {
-  /**
-   * Adds two numbers.
-   * @param a The first number.
-   * @param b The second number.
-   * @returns The sum of `a` and `b`.
-   */
-  add(a: number, b: number): number {
-    return a + b;
+import * as plugins from '@push.rocks/smartfile';
+
+const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json');
+const outputPath = plugins.path.join(__dirname, 'docs');
+
+await plugins.smartshellInstance.exec(
+  `typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
+);
+```
+
+#### `tsdoc aidoc` - Generate AI-Enhanced Documentation
+
+The `aidoc` command will use AI to generate an enhanced README and update your project description.
+
+```bash
+tsdoc aidoc
+```
+
+### Example
+
+```typescript
+import { AiDoc } from '@git.zone/tsdoc';
+
+(async () => {
+  const aidoc = new AiDoc();
+  await aidoc.start();
+  await aidoc.buildReadme('./');
+  await aidoc.buildDescription('./');
+})();
+```
+
+#### `tsdoc test` - Test Your Documentation Setup
+
+The `test` command will test your current documentation setup, ensuring everything is configured correctly.
+
+```bash
+tsdoc test
+```
+
+### Example
+
+```typescript
+import * as plugins from '@git.zone/tsdoc';
+
+await plugins.runCli().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+```
+
+## Features in Depth
+
+### Using Plugins
+
+`@git.zone/tsdoc` extensively uses plugins to extend its capabilities.
+
+### Available Plugins
+
+- **npmextra**: Manage npm project-related configurations.
+- **qenv**: Environment variable management.
+- **smartai**: AI integration.
+- **smartcli**: CLI helper.
+- **smartdelay**: Simple delay utility.
+- **smartfile**: File system utilities.
+- **smartinteract**: Interaction helper.
+- **smartlog**: Logging utility.
+- **smartlogDestinationLocal**: Local file destination for logging.
+- **smartpath**: Path utilities.
+- **smartshell**: Shell command execution.
+- **typedoc**: Documentation generation.
+
+### Example Usage of Plugins
+
+#### Path Management
+
+```typescript
+import * as path from 'path';
+
+const packageDir = path.join(__dirname, '../');
+const cwd = process.cwd();
+const binDir = path.join(packageDir, './node_modules/.bin');
+const assetsDir = path.join(packageDir, './assets');
+const publicDir = path.join(cwd, './public');
+const tsDir = path.join(cwd, './ts');
+const tsconfigFile = path.join(assetsDir, './tsconfig.json');
+const typedocOptionsFile = path.join(assetsDir, './typedoc.json');
+```
+
+#### Logging
+
+```typescript
+import * as plugins from './plugins';
+
+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());
+```
+
+## Advanced Usage
+
+### Using `TypeDoc` Class
+
+The `TypeDoc` class provides utility methods to compile TypeScript documentation.
+
+```typescript
+import { TypeDoc } from '@git.zone/tsdoc/classes.typedoc';
+
+const typeDocInstance = new TypeDoc(paths.cwd);
+
+await typeDocInstance.compile({
+  publicSubdir: 'docs',
+});
+```
+
+### Using `AiDoc` Class
+
+The `AiDoc` class integrates with AI services to enhance your documentation.
+
+#### Initializing and Using AI
+
+```typescript
+import { AiDoc } from '@git.zone/tsdoc';
+
+const aiDoc = new AiDoc({ OPENAI_TOKEN: 'your-openai-token' });
+
+await aiDoc.start();
+await aiDoc.buildReadme('./');
+await aiDoc.buildDescription('./');
+```
+
+#### Retrieving AI Tokens
+
+```typescript
+import * as plugins from '@git.zone/tsdoc/plugins';
+
+const qenv = new plugins.qenv.Qenv();
+const openaiToken = await qenv.getEnvVarOnDemand('OPENAI_TOKEN');
+```
+
+### Testing
+
+The provided tests demonstrate how to verify the functionality of the `@git.zone/tsdoc` tool.
+
+#### Example Test Script
+
+```typescript
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as tsdoc from '../ts/index';
+
+tap.test('should create AiDoc instance', async () => {
+  const aidoc = new tsdoc.AiDoc({ OPENAI_TOKEN: 'dummy-token' });
+  expect(aidoc).toBeInstanceOf(tsdoc.AiDoc);
+});
+
+tap.test('should start AiDoc', async () => {
+  const aidoc = new tsdoc.AiDoc({ OPENAI_TOKEN: 'dummy-token' });
+  await aidoc.start();
+  await aidoc.buildReadme('./');
+  await aidoc.buildDescription('./');
+});
+
+tap.start();
+```
+
+### Internals
+
+The `@git.zone/tsdoc` consists of several internal classes and utilities that streamline its functionality.
+
+#### File Paths Management
+
+Located in `ts/paths.ts`, the file defines various directories and file paths used by the tool.
+
+```typescript
+import * as plugins from './plugins';
+
+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');
+export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');
+export const typedocOptionsFile = plugins.path.join(assetsDir, './typedoc.json');
+```
+
+#### Utility Commands
+
+Define utility commands that streamline various processes.
+
+##### Example: SmartCLI Usage
+
+```typescript
+// Import required modules and plugins
+import * as plugins from './plugins';
+import * as paths from './paths';
+
+// TypeDoc and AiDoc classes
+import { TypeDoc } from './classes.typedoc';
+import { AiDoc } from './classes.aidoc';
+
+// Export a run function
+export const run = async () => {
+  const tsdocCli = new plugins.smartcli.Smartcli();
+
+  tsdocCli.standardCommand().subscribe(async (argvArg) => {
+    switch (true) {
+      case await TypeDoc.isTypeDocDir(paths.cwd):
+        tsdocCli.triggerCommand('typedoc', argvArg);
+        break;
+      default:
+        console.error(`Cannot determine docs format at ${paths.cwd}`);
     }
+  });
 
-  /**
-   * Subtracts the second number from the first.
-   * @param a The first number.
-   * @param b The second number.
-   * @returns The difference of `a` and `b`.
-   */
-  subtract(a: number, b: number): number {
-    return a - b;
-  }
-}
+  tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
+    const typeDocInstance = new TypeDoc(paths.cwd);
+    await typeDocInstance.compile({
+      publicSubdir: argvArg.publicSubdir,
+    });
+  });
+
+  tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
+    const aidocInstance = new AiDoc(argvArg);
+    await aidocInstance.start();
+    await aidocInstance.buildReadme(paths.cwd);
+    await aidocInstance.buildDescription(paths.cwd);
+  });
+
+  tsdocCli.startParse();
+};
 ```
 
-By including detailed comments and utilizing TypeScript's type system, you provide `@git.zone/tsdoc` with the information needed to generate comprehensive documentation for each method, including parameters and return types.
+By leveraging these functionalities, you can configure and extend `@git.zone/tsdoc` to fit your specific documentation generation needs.
 
-### Conclusion
-Incorporating `@git.zone/tsdoc` into your TypeScript project not only streamlines the documentation process but leverages AI to enhance the quality and effectiveness of your project's documentation. Follow the suggested practices and explore the advanced features to fully utilize this powerful tool.
+### Further Enhancements
 
-For further information and more detailed instructions on using the advanced features of `@git.zone/tsdoc`, please consult the official documentation.
-
-(Note: This usage section is a foundational guide; please refer to the full documentation of `@git.zone/tsdoc` for detailed instructions and advanced usage scenarios.)
+The `@git.zone/tsdoc` tool is designed to be extensible. Explore the source files and plugins to add more functionality or integrate with other tools as needed. This README provides an extensive overview of the commands and features but it's always beneficial to dive into the source code to understand the intricacies and potential customizations. Happy documenting!
 
 ## License and Legal Information
 

test/test.aidoc.nonci.ts

@@ -8,20 +8,32 @@ let aidocs: tsdocs.AiDoc;
 
 tap.test('should create an AIdocs class', async () => {
   aidocs = new tsdocs.AiDoc({
-    'OPENAI_TOKEN': await testQenv.getEnvVarOnDemand('OPENAI_TOKEN')
+    OPENAI_TOKEN: await testQenv.getEnvVarOnDemand('OPENAI_TOKEN'),
   });
   expect(aidocs).toBeInstanceOf(tsdocs.AiDoc);
 });
 
 tap.test('should start AIdocs', async () => {
   await aidocs.start();
+});
+
+tap.skip.test('should start AIdocs', async () => {
   await aidocs.buildReadme('./');
-})
+});
 
-tap.test('should start AIdocs', async () => {
-  await aidocs.start();
+tap.skip.test('should start AIdocs', async () => {
   await aidocs.buildDescription('./');
-})
+});
 
+tap.test('should build commit object', async () => {
+  const commitObject = await aidocs.buildNextCommitObject('./');
+  console.log(commitObject);
+  expect(commitObject).not.toBeUndefined();
+  expect(commitObject).toHaveProperty('recommendedNextVersion');
+  expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
+  expect(commitObject).toHaveProperty('recommendedNextVersionScope');
+  expect(commitObject).toHaveProperty('recommendedNextVersionMessage');
+
+})
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '1.1.16',
-  description: 'An advanced TypeScript documentation tool leveraging AI for enhanced insights and automated documentation generation.'
+  version: '1.1.41',
+  description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
 }

ts/aidocs_classes/commit.ts

@@ -0,0 +1,101 @@
+import * as plugins from '../plugins.js';
+import { AiDoc } from '../classes.aidoc.js';
+import { ProjectContext } from './projectcontext.js';
+
+export interface INextCommitObject {
+  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
+  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
+  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
+  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
+  changelog?: string; // the changelog for the next version
+}
+
+export class Commit {
+  private aiDocsRef: AiDoc;
+  private projectDir: string;
+
+  constructor(aiDocsRef: AiDoc, projectDirArg: string) {
+    this.aiDocsRef = aiDocsRef;
+    this.projectDir = projectDirArg;
+  }
+
+  public async buildNextCommitObject(): Promise<INextCommitObject> {
+    const smartgitInstance = new plugins.smartgit.Smartgit();
+    await smartgitInstance.init();
+    const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(smartgitInstance, this.projectDir);
+    const diffString = await gitRepo.getUncommittedDiff();
+    const projectContext = new ProjectContext(this.projectDir);
+    let contextString = await projectContext.update();
+    contextString = `
+${contextString}
+
+Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
+
+${diffString || 'No changes.'}
+    `
+
+    let result = await this.aiDocsRef.openaiInstance.chat({
+      systemMessage: `
+You create a commit message for a git commit.
+The commit message should be based on the files in the project.
+You should not include any licensing information.
+You should not include any personal information.
+
+Important: Answer only in valid JSON.
+
+Your answer should be parseable with JSON.parse() without modifying anything.
+
+Here is the structure of the JSON you should return:
+{
+  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
+  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
+  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
+  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
+}
+
+You are being given the files of the project. You should use them to create the commit message.
+Also you are given a diff
+
+`,
+      messageHistory: [],
+      userMessage: contextString,
+    });
+
+    // console.log(result.message);
+    const resultObject: INextCommitObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
+
+    // lets build the changelog based on that
+    const commitMessages = await gitRepo.getAllCommitMessages();
+    const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
+    let previousChangelog: plugins.smartfile.SmartFile;
+    if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
+      previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
+    }
+    let result2 = await this.aiDocsRef.openaiInstance.chat({
+      messageHistory: [],
+      systemMessage: `
+You are building a changelog file for the projext.
+Omit commits and versions that lack relevant changes.
+
+You are given
+* the previous changelog file (if available)
+* the commit messages of the project
+
+Only return the changelog file, so it can be written directly to changelog.md
+
+For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextVersionMessage}} placeholders.
+Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
+      `,
+      userMessage: `
+The previous changelog file is:
+${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
+
+Here are the commit messages so far:
+
+${commitMessages.join('\n\n')}
+`
+    })
+    resultObject.changelog = result2.message;
+    return resultObject;
+  }
+}

ts/aidocs_classes/description.ts

@@ -8,7 +8,6 @@ interface IDescriptionInterface {
 }
 
 export class Description {
-
   // INSTANCE
   private aiDocsRef: AiDoc;
   private projectDir: string;
@@ -23,29 +22,31 @@ export class Description {
     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:
-        {
+    let result = await this.aiDocsRef.openaiInstance.chat({
+      systemMessage: `
+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.
+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.
+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!!!
+Don't wrap the JSON in three ticks json!!!
     `,
-      contextString,
-      []
-    );
+      messageHistory: [],
+      userMessage: contextString,
+    });
 
-    console.log(result.message.content);
-    const resultObject: IDescriptionInterface = JSON.parse(result.message.content.replace('```json', '').replace('```', ''));
+    console.log(result.message);
+    const resultObject: IDescriptionInterface = JSON.parse(
+      result.message.replace('```json', '').replace('```', ''),
+    );
 
     const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;
     const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
@@ -64,10 +65,9 @@ export class Description {
     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;
+    return result.message;
   }
 }

ts/aidocs_classes/index.ts

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

ts/aidocs_classes/projectcontext.ts

@@ -13,27 +13,33 @@ export class ProjectContext {
   public async gatherFiles() {
     const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
       plugins.path.join(this.projectDir, 'package.json'),
-      this.projectDir
+      this.projectDir,
     );
     const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath(
       plugins.path.join(this.projectDir, 'readme.md'),
-      this.projectDir
+      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
+      this.projectDir,
     );
     const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
       this.projectDir,
-      'ts/**/*.ts'
+      'ts*/**/*.ts',
     );
     const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
       this.projectDir,
-      'test/**/*.ts'
+      'test/**/*.ts',
     );
     return {
       smartfilePackageJSON,
       smartfilesReadme,
+      smartfilesReadmeHints,
       smartfilesNpmextraJSON,
       smartfilesMod,
       smartfilesTest,
@@ -41,6 +47,10 @@ export class ProjectContext {
   }
 
   public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
+    console.log(`Using the following files for the documentation:`);
+    filesArg.map((fileArg) => {
+      console.log(`  -> ${fileArg.relative}`);
+    });
     return filesArg
       .map((smartfile) => {
         return `
@@ -59,10 +69,12 @@ ${smartfile.contents.toString()}
     let context = await this.convertFilesToContext([
       files.smartfilePackageJSON,
       files.smartfilesReadme,
+      files.smartfilesReadmeHints,
       files.smartfilesNpmextraJSON,
       ...files.smartfilesMod,
       ...files.smartfilesTest,
     ]);
+    // console.log(context);
     return context;
   }
 

ts/aidocs_classes/readme.ts

@@ -3,7 +3,6 @@ import * as plugins from '../plugins.js';
 import { ProjectContext } from './projectcontext.js';
 
 export class Readme {
-
   // INSTANCE
   private aiDocsRef: AiDoc;
   private projectDir: string;
@@ -21,15 +20,17 @@ export class Readme {
     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
+    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(
-      `
+    let result = await this.aiDocsRef.openaiInstance.chat({
+      systemMessage: `
 You create markdown readmes for npm projects. You only output the markdown readme.
 
 The Readme should follow the following template:
@@ -59,26 +60,25 @@ The Readme should follow the following template:
   Don't include any licensing information. This will be added in a later step.
   Avoid "in conclusions".
 
-  npmextra.json has a tsdocs section that provides valuable information about module ideas.
+  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;
-
+      messageHistory: [],
+      userMessage: contextString,
+    });
 
+    finalReadmeString += result.message + '\n' + legalInfo;
 
     console.log(`\n======================\n`);
-    console.log(result.message.content);
+    console.log(result.message);
     console.log(`\n======================\n`);
 
     const readme = (await projectContext.gatherFiles()).smartfilesReadme;
     readme.contents = Buffer.from(finalReadmeString);
     await readme.write();
 
-    return result.message.content;
+    return result.message;
   }
 }

ts/classes.aidoc.ts

@@ -7,7 +7,7 @@ export class AiDoc {
 
   public npmextraKV: plugins.npmextra.KeyValueStore;
   public qenvInstance: plugins.qenv.Qenv;
-  public smartinteractInstance: plugins.smartinteract.SmartInteract;
+  public aidocInteract: plugins.smartinteract.SmartInteract;
   public openaiInstance: plugins.smartai.OpenAiProvider;
 
   argvArg: any;
@@ -33,7 +33,7 @@ export class AiDoc {
 
   public async start() {
     // lets care about prerequisites
-    this.smartinteractInstance = new plugins.smartinteract.SmartInteract();
+    this.aidocInteract = new plugins.smartinteract.SmartInteract();
     this.qenvInstance = new plugins.qenv.Qenv();
     if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
       this.npmextraKV = new plugins.npmextra.KeyValueStore({
@@ -42,16 +42,18 @@ export class AiDoc {
         mandatoryKeys: ['OPENAI_TOKEN'],
       });
 
-      const missingKeys = this.npmextraKV.getMissingMandatoryKeys();
+      const missingKeys = await 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
-          const answerObject = await this.smartinteractInstance.askQuestion({
+          // wait for a second until OpenAI fixes punycode problem...
+          await plugins.smartdelay.delayFor(1000);
+          const answerObject = await this.aidocInteract.askQuestion({
             type: 'input',
-            message: `Please provide your OpenAI token`,
+            message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
             name: 'OPENAI_TOKEN',
             default: '',
           });
@@ -59,12 +61,17 @@ export class AiDoc {
         }
 
         this.printSanitizedToken();
-        // await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
+        await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
       }
     }
+    if (!this.openaiToken) {
+      this.openaiToken = await this.npmextraKV.readKey('OPENAI_TOKEN');
+    }
 
     // lets assume we have an OPENAI_Token now
-    this.openaiInstance = new plugins.smartai.OpenAiProvider(this.openaiToken);
+    this.openaiInstance = new plugins.smartai.OpenAiProvider({
+      openaiToken: this.openaiToken,
+    });
     await this.openaiInstance.start();
   }
 
@@ -77,4 +84,14 @@ export class AiDoc {
     const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg);
     return await descriptionInstance.build();
   }
+
+  public async buildNextCommitObject(projectDirArg: string) {
+    const commitInstance = new aiDocsClasses.Commit(this, projectDirArg);
+    return await commitInstance.buildNextCommitObject();
+  }
+
+  public async getProjectContext(projectDirArg: string) {
+    const projectContextInstance = new aiDocsClasses.ProjectContext(projectDirArg);
+    return await projectContextInstance.gatherFiles();
+  }
 }

ts/classes.typedoc.ts

@@ -20,15 +20,15 @@ export class TypeDoc {
 
   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,
+      compilerOptions: {
+        experimentalDecorators: true,
+        useDefineForClassFields: false,
+        target: 'ES2022',
+        module: 'NodeNext',
+        moduleResolution: 'NodeNext',
+        esModuleInterop: true,
+        verbatimModuleSyntax: true,
+        skipLibCheck: true,
       },
       include: [],
     };
@@ -51,7 +51,7 @@ export class TypeDoc {
       targetDir = plugins.path.join(targetDir, options.publicSubdir);
     }
     await this.smartshellInstance.exec(
-      `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`
+      `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`,
     );
     plugins.smartfile.fs.remove(paths.tsconfigFile);
   }

ts/cli.ts

@@ -27,9 +27,16 @@ export const run = async () => {
     });
   });
 
-  tsdocCli.addCommand('aidocs').subscribe(async (argvArg) => {
-    const aidocs = new AiDoc();
-  })
+  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);

ts/paths.ts

@@ -1,7 +1,10 @@
 import * as plugins from './plugins.js';
 
 // dirs
-export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
+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/plugins.ts

@@ -10,13 +10,27 @@ 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 smartgit from '@push.rocks/smartgit';
 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 };
+export {
+  npmextra,
+  qenv,
+  smartai,
+  smartcli,
+  smartdelay,
+  smartfile,
+  smartgit,
+  smartinteract,
+  smartlog,
+  smartlogDestinationLocal,
+  smartpath,
+  smartshell,
+};
 
 // third party scope
 import * as typedoc from 'typedoc';