1.1.34

.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

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.1.29",
+  "version": "1.1.34",
   "private": false,
   "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
-  "main": "dist_ts/index.js",
-  "typings": "dist_ts/index.d.ts",
   "type": "module",
-  "author": "Lossless GmbH",
+  "exports": {
+    ".": "./dist_ts/index.js"
+  },
+  "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"
@@ -14,30 +15,32 @@
   "scripts": {
     "test": "(tstest test/) && npm run testCli",
     "testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
-    "build": "(tsbuild --web --allowimplicitany)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.76",
+    "@git.zone/tsbuild": "^2.1.80",
     "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tstest": "^1.0.90",
     "@push.rocks/tapbundle": "^5.0.23",
-    "@types/node": "^20.12.12"
+    "@types/node": "^20.14.8"
   },
   "dependencies": {
     "@push.rocks/early": "^4.0.3",
-    "@push.rocks/npmextra": "^5.0.13",
+    "@push.rocks/npmextra": "^5.0.23",
     "@push.rocks/qenv": "^6.0.5",
     "@push.rocks/smartai": "^0.0.17",
-    "@push.rocks/smartcli": "^4.0.10",
+    "@push.rocks/smartcli": "^4.0.11",
     "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartfile": "^11.0.14",
+    "@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": "^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.25.13",
+    "typedoc": "^0.26.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "files": [
     "ts/**/*",
@@ -65,5 +68,13 @@
     "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.md

@@ -1,4 +1,5 @@
 # @git.zone/tsdoc
+
 An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
 
 ## Install
@@ -62,7 +63,7 @@ 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`
+  `typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
 );
 ```
 
@@ -243,7 +244,7 @@ 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');
@@ -273,7 +274,7 @@ import { AiDoc } from './classes.aidoc';
 export const run = async () => {
   const tsdocCli = new plugins.smartcli.Smartcli();
 
-  tsdocCli.standardCommand().subscribe(async argvArg => {
+  tsdocCli.standardCommand().subscribe(async (argvArg) => {
     switch (true) {
       case await TypeDoc.isTypeDocDir(paths.cwd):
         tsdocCli.triggerCommand('typedoc', argvArg);
@@ -283,14 +284,14 @@ export const run = async () => {
     }
   });
 
-  tsdocCli.addCommand('typedoc').subscribe(async argvArg => {
+  tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
     const typeDocInstance = new TypeDoc(paths.cwd);
     await typeDocInstance.compile({
-      publicSubdir: argvArg.publicSubdir
+      publicSubdir: argvArg.publicSubdir,
     });
   });
 
-  tsdocCli.addCommand('aidoc').subscribe(async argvArg => {
+  tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
     const aidocInstance = new AiDoc(argvArg);
     await aidocInstance.start();
     await aidocInstance.buildReadme(paths.cwd);

test/test.aidoc.nonci.ts

@@ -8,20 +8,31 @@ 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 () => {
+tap.skip.test('should start AIdocs', async () => {
-  await aidocs.start();
   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('message');
+  expect(commitObject).toHaveProperty('recommendedNextVersion');
+  expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
+
+})
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '1.1.29',
+  version: '1.1.34',
   description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
 }

ts/aidocs_classes/commit.ts

@@ -0,0 +1,98 @@
+import * as plugins from '../plugins.js';
+import { AiDoc } from '../classes.aidoc.js';
+import { ProjectContext } from './projectcontext.js';
+
+export interface INextCommitObject {
+  recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
+  recommendedNextVersion: string; // the recommended next version of the project
+  message: string; // the commit message. use conventional commits format
+  changelog?: string; // the changelog
+}
+
+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();
+    console.log(diffString);
+    const projectContext = new ProjectContext(this.projectDir);
+    let contextString = await projectContext.update();
+    contextString = `
+${contextString}
+
+Here is the diff:
+${diffString}
+    `
+
+    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: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
+  recommendedNextVersion: string; // the recommended next version of the project
+  message: string; // the commit message. use conventional commits format
+}
+
+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 {{nextDescription}} placeholders.
+      `,
+      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

@@ -45,7 +45,7 @@ Don't wrap the JSON in three ticks json!!!
 
     console.log(result.message);
     const resultObject: IDescriptionInterface = JSON.parse(
-      result.message.replace('```json', '').replace('```', '')
+      result.message.replace('```json', '').replace('```', ''),
     );
 
     const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;

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,28 +13,28 @@ 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
+      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,
@@ -47,10 +47,10 @@ export class ProjectContext {
   }
 
   public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
-    console.log(`Using the following files for the documentation:`)
+    console.log(`Using the following files for the documentation:`);
-    filesArg.map(fileArg => {
+    filesArg.map((fileArg) => {
       console.log(`  -> ${fileArg.relative}`);
-    })
+    });
     return filesArg
       .map((smartfile) => {
         return `

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,8 +20,10 @@ 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 npmExtraJson = JSON.parse(
-    const legalInfo = npmExtraJson?.tsdoc?.legal
+      (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);
@@ -68,11 +69,8 @@ The Readme should follow the following template:
       userMessage: contextString,
     });
 
-
     finalReadmeString += result.message + '\n' + legalInfo;
 
-    
-
     console.log(`\n======================\n`);
     console.log(result.message);
     console.log(`\n======================\n`);

ts/classes.aidoc.ts

@@ -84,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": {
+      compilerOptions: {
-        "experimentalDecorators": true,
+        experimentalDecorators: true,
-        "useDefineForClassFields": false,
+        useDefineForClassFields: false,
-        "target": "ES2022",
+        target: 'ES2022',
-        "module": "NodeNext",
+        module: 'NodeNext',
-        "moduleResolution": "NodeNext",
+        moduleResolution: 'NodeNext',
-        "esModuleInterop": true,
+        esModuleInterop: true,
-        "verbatimModuleSyntax": true,
+        verbatimModuleSyntax: true,
-        "skipLibCheck": 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

@@ -36,7 +36,7 @@ export const run = async () => {
     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';