fix(core): update

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '1.1.14',
+  version: '1.1.15',
   description: 'a tool for better documentation'
 }

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,73 @@
+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 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,
+      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.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,84 @@
+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".
+
+  npmextra.json has a tsdocs section that provides valuable information 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,80 @@
+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
+          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

@@ -1,5 +1,5 @@
-import * as plugins from './tsdoc.plugins.js';
-import * as paths from './tsdoc.paths.js';
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
 
 export class TypeDoc {
   public smartshellInstance = new plugins.smartshell.Smartshell({

ts/cli.ts

@@ -1,9 +1,9 @@
-import * as plugins from './tsdoc.plugins.js';
-import * as paths from './tsdoc.paths.js';
-import { logger } from './tsdoc.logging.js';
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+import { logger } from './logging.js';
 
-import { TypeDoc } from './tsdoc.classes.typedoc.js';
-import { AiDocs } from './tsdoc.classes.aidocs.js';
+import { TypeDoc } from './classes.typedoc.js';
+import { AiDoc } from './classes.aidoc.js';
 
 export const run = async () => {
   const tsdocCli = new plugins.smartcli.Smartcli();
@@ -28,7 +28,7 @@ export const run = async () => {
   });
 
   tsdocCli.addCommand('aidocs').subscribe(async (argvArg) => {
-    const aidocs = new AiDocs();
+    const aidocs = new AiDoc();
   })
 
   tsdocCli.addCommand('test').subscribe((argvArg) => {

ts/index.ts

@@ -1,7 +1,7 @@
 import * as early from '@push.rocks/early';
 early.start('tsdoc');
-import * as plugins from './tsdoc.plugins.js';
-import * as cli from './tsdoc.cli.js';
+import * as plugins from './plugins.js';
+import * as cli from './cli.js';
 early.stop();
 
 export const runCli = async () => {
@@ -9,4 +9,4 @@ export const runCli = async () => {
 };
 
 // exports
-export * from './tsdoc.classes.aidocs.js';
+export * from './classes.aidoc.js';

ts/logging.ts

@@ -1,4 +1,4 @@
-import * as plugins from './tsdoc.plugins.js';
+import * as plugins from './plugins.js';
 
 export const logger = new plugins.smartlog.Smartlog({
   logContext: {

ts/paths.ts

@@ -1,4 +1,4 @@
-import * as plugins from './tsdoc.plugins.js';
+import * as plugins from './plugins.js';
 
 // dirs
 export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');

ts/plugins.ts

@@ -8,6 +8,7 @@ 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';
@@ -15,7 +16,7 @@ import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-loca
 import * as smartpath from '@push.rocks/smartpath';
 import * as smartshell from '@push.rocks/smartshell';
 
-export { npmextra, qenv, smartai, smartcli, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
+export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
 
 // third party scope
 import * as typedoc from 'typedoc';

ts/tsdoc.classes.aidocs.ts

@@ -1,44 +0,0 @@
-import * as plugins from './tsdoc.plugins.js';
-
-export class AiDocs {
-  private openaiToken: string;
-
-  public npmextraKV: plugins.npmextra.KeyValueStore;
-  public qenvInstance: plugins.qenv.Qenv;
-  public smartinteractInstance: plugins.smartinteract.SmartInteract;
-  public openaiInstance: plugins.smartai.OpenAiProvider;
-
-  constructor() {}
-
-  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) {
-        const answerObject = await this.smartinteractInstance.askQuestion({
-          type: 'input',
-          message: `Please provide your OpenAI token`,
-          name: 'OPENAI_TOKEN',
-          default: '',
-        });
-        this.openaiToken = answerObject.value
-        await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
-      }
-    }
-
-    // lets assume we have an OPENAI_Token now
-    // we can now assemble the directory structure.
-    const smartfilesMod = plugins.smartfile.fs.fileTreeToObject(process.cwd(), 'ts/**/*.ts');
-    const smartfilesTest = plugins.smartfile.fs.fileTreeToObject(process.cwd(), 'test/**/*.ts');
-    console.log(smartfilesMod);
-    console.log(smartfilesTest);
-  }
-}