@rxap/plugin-llm 20.0.0-dev.1

package/generators.json

@@ -0,0 +1,36 @@
+{
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/generator",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the package in the workspace"
+    },
+    "documentation": {
+      "factory": "./src/generators/documentation/generator",
+      "schema": "./src/generators/documentation/schema.json",
+      "description": "Automatically generate the documenation for all exported typescript symboles"
+    },
+    "package-description": {
+      "factory": "./src/generators/package-description/generator",
+      "schema": "./src/generators/package-description/schema.json",
+      "description": "Generates a package description based on the source code"
+    }
+  },
+  "schematics": {
+    "init": {
+      "factory": "./src/generators/init/index",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the package in the workspace"
+    },
+    "documentation": {
+      "factory": "./src/generators/documentation/index",
+      "schema": "./src/generators/documentation/schema.json",
+      "description": "Automatically generate the documenation for all exported typescript symboles"
+    },
+    "package-description": {
+      "factory": "./src/generators/package-description/index",
+      "schema": "./src/generators/package-description/schema.json",
+      "description": "Generates a package description based on the source code"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "version": "20.0.0-dev.1",
+  "name": "@rxap/plugin-llm",
+  "description": "This npm package provides tools for generating documentation and package descriptions using large language models (LLMs). It includes functionality for cleaning JSDoc comments, counting tokens, composing context for LLM prompts, and integrating with services like OpenAI. The package also offers generators for automatically adding documentation to TypeScript code and creating package descriptions based on project source code.\n",
+  "license": "GPL-3.0-or-later",
+  "dependencies": {
+    "@nx/devkit": "20.4.2",
+    "@rxap/workspace-ts-morph": "^19.1.9-dev.13",
+    "@rxap/workspace-utilities": "^19.6.1-dev.12",
+    "colors": "1.4.0",
+    "openai": "^4.82.0",
+    "tiktoken": "^1.0.20",
+    "ts-morph": "18.0.0",
+    "tslib": "^2.3.0",
+    "xml2js": "^0.6.2"
+  },
+  "author": {
+    "name": "Merzough Münker",
+    "email": "mmuenker@digitaix.com"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/rxap/packages/-/issues",
+    "email": "incoming+rxap-packages-14898188-issue-@incoming.gitlab.com"
+  },
+  "generators": "./generators.json",
+  "gitHead": "969f0867a1da05a157f626d5bdd316bd0a67494a",
+  "homepage": "https:/gitlab.com/rxap/packages/packages/plugin/llm",
+  "keywords": [
+    "nx",
+    "nx-plugin",
+    "packages",
+    "plugin",
+    "plugin-llm",
+    "rxap"
+  ],
+  "main": "./src/index.js",
+  "publishConfig": {
+    "access": "public",
+    "directory": "../../../dist/packages/plugin/llm"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/rxap/packages.git",
+    "directory": "packages/plugin/llm"
+  },
+  "schematics": "./generators.json",
+  "type": "commonjs",
+  "types": "./src/index.d.ts"
+}

package/src/generators/documentation/generator.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { DocumentationGeneratorSchema } from './schema';
+export declare function documentationGenerator(tree: Tree, options: DocumentationGeneratorSchema): Promise<void>;
+export default documentationGenerator;

package/src/generators/documentation/generator.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentationGenerator = documentationGenerator;
+const tslib_1 = require("tslib");
+const workspace_ts_morph_1 = require("@rxap/workspace-ts-morph");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const path_1 = require("path");
+const ts_morph_1 = require("ts-morph");
+const add_js_doc_1 = require("../../lib/add-js-doc");
+const cleanup_js_doc_1 = require("../../lib/cleanup-js-doc");
+const clear_all_js_docs_1 = require("../../lib/clear-all-js-docs");
+const clear_js_doc_1 = require("../../lib/clear-js-doc");
+const completion_1 = require("../../lib/completion");
+const compose_context_1 = require("../../lib/compose-context");
+const model_1 = require("../../lib/model");
+function generateTsDoc(_a) {
+    return tslib_1.__awaiter(this, arguments, void 0, function* ({ context, target, question, node, systemPrompt, options }) {
+        // console.log(`${question}`.blue);
+        try {
+            const jsDoc = yield (0, completion_1.completion)(systemPrompt, [context, target, question].join('\n\n'), options);
+            // console.log(jsDoc.grey);
+            (0, clear_js_doc_1.clearJsDoc)(node);
+            (0, add_js_doc_1.addJsDoc)(node, (0, cleanup_js_doc_1.cleanupJsDoc)(jsDoc));
+        }
+        catch (e) {
+            console.log(`${e.message}`.red, e.stack);
+            return false;
+        }
+        return true;
+    });
+}
+function documentationGenerator(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { model = 'anthropic/claude-3-5-sonnet', apiKey, orgId, projectId, baseUrl } = options;
+        if (model && !Object.keys(model_1.tokenLimits).includes(model)) {
+            throw new Error(`The model '${model}' is not supported in the documentation generator`);
+        }
+        // relative path form the workspace root
+        const cwd = (0, node_path_1.relative)(tree.root, process.cwd());
+        const path = options.path ? (0, path_1.join)(cwd, options.path) : cwd;
+        console.log(`base path: ${path}`.grey);
+        const systemPrompt = (0, node_fs_1.readFileSync)((0, path_1.join)(__dirname, 'system-prompts', 'generic.txt'), 'utf-8');
+        const operation = (project) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const failed = [];
+            for (const sourceFile of project.getSourceFiles()) {
+                if (sourceFile.getFilePath().match(/\.(spec|cy|stories|d|test)\.ts$/)) {
+                    continue;
+                }
+                console.log(`PROCESS`.grey + ' ' + `${sourceFile.getFilePath()}`.cyan);
+                const context = (0, compose_context_1.composeContext)(sourceFile);
+                // console.log('CONTEXT'.bgGreen + '\n' + `${context}`.grey);
+                let target = `<sourceFile path="${sourceFile.getFilePath()}">\n`;
+                target += (0, clear_all_js_docs_1.clearAllJsDocs)(sourceFile).getFullText();
+                target += '</sourceFile>\n';
+                // console.log('TARGET'.bgGreen + '\n' + `${target}`.grey);
+                for (const functionDeclaration of sourceFile.getFunctions()) {
+                    console.log(`PROCESS`.grey + ' ' + `function ${functionDeclaration.getName()}`.green);
+                    const question = `TASK: create the TSDoc documentation for the function \`${functionDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                    const success = yield generateTsDoc({
+                        systemPrompt,
+                        question,
+                        target,
+                        context,
+                        node: functionDeclaration,
+                        options: { model: model, apiKey, orgId, projectId, baseUrl },
+                    });
+                    if (!success) {
+                        failed.push(`${sourceFile.getFilePath()}#function:${functionDeclaration.getName()}`);
+                    }
+                }
+                for (const interfaceDeclaration of sourceFile.getInterfaces()) {
+                    console.log(`PROCESS`.grey + ' ' + `interface ${interfaceDeclaration.getName()}`.green);
+                    let question = `TASK: create the TSDoc documentation for the interface \`${interfaceDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                    const success = yield generateTsDoc({
+                        systemPrompt,
+                        question,
+                        target,
+                        context,
+                        node: interfaceDeclaration,
+                        options: { model: model, apiKey, orgId, projectId, baseUrl },
+                    });
+                    if (!success) {
+                        failed.push(`${sourceFile.getFilePath()}#interface:${interfaceDeclaration.getName()}`);
+                    }
+                    for (const method of interfaceDeclaration.getMethods()) {
+                        console.log(`PROCESS`.grey + ' ' + `method ${interfaceDeclaration.getName()}::${method.getName()}`.green);
+                        question = `TASK: create the TSDoc documentation for the method \`${method.getName()}\` of interface \`${interfaceDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                        const success = yield generateTsDoc({
+                            systemPrompt,
+                            question,
+                            target,
+                            context,
+                            node: method,
+                            options: { model: model, apiKey, orgId, projectId, baseUrl },
+                        });
+                        if (!success) {
+                            failed.push(`${sourceFile.getFilePath()}#method:${interfaceDeclaration.getName()}::${method.getName()}`);
+                        }
+                    }
+                    for (const property of interfaceDeclaration.getProperties()) {
+                        console.log(`PROCESS`.grey + ' ' + `interface ${interfaceDeclaration.getName()}::${property.getName()}`.green);
+                        question = `TASK: create the TSDoc documentation for the method \`${property.getName()}\` of interface \`${interfaceDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                        const success = yield generateTsDoc({
+                            systemPrompt,
+                            question,
+                            target,
+                            context,
+                            node: property,
+                            options: { model: model, apiKey, orgId, projectId, baseUrl },
+                        });
+                        if (!success) {
+                            failed.push(`${sourceFile.getFilePath()}#method:${interfaceDeclaration.getName()}::${property.getName()}`);
+                        }
+                    }
+                }
+                for (const typeDeclaration of sourceFile.getTypeAliases()) {
+                    console.log(`PROCESS`.grey + ' ' + `type ${typeDeclaration.getName()}`.green);
+                    const question = `TASK: create the TSDoc documentation for the type \`${typeDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                    const success = yield generateTsDoc({
+                        systemPrompt,
+                        question,
+                        target,
+                        context,
+                        node: typeDeclaration,
+                        options: { model: model, apiKey, orgId, projectId, baseUrl },
+                    });
+                    if (!success) {
+                        failed.push(`${sourceFile.getFilePath()}#type:${typeDeclaration.getName()}`);
+                    }
+                }
+                for (const classDeclaration of sourceFile.getClasses()) {
+                    console.log(`PROCESS`.grey + ' ' + `class ${classDeclaration.getName()}`.green);
+                    let question = `TASK: create the TSDoc documentation for the class \`${classDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                    const success = yield generateTsDoc({
+                        systemPrompt,
+                        question,
+                        target,
+                        context,
+                        node: classDeclaration,
+                        options: { model: model, apiKey, orgId, projectId, baseUrl },
+                    });
+                    if (!success) {
+                        failed.push(`${sourceFile.getFilePath()}#class:${classDeclaration.getName()}`);
+                    }
+                    for (const method of classDeclaration.getMethods().filter(method => !method.getScope() || method.getScope() === ts_morph_1.Scope.Public)) {
+                        console.log(`PROCESS`.grey + ' ' + `method ${classDeclaration.getName()}::${method.getName()}`.green);
+                        question = `TASK: create the TSDoc documentation for the method \`${method.getName()}\` of class \`${classDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                        const success = yield generateTsDoc({
+                            systemPrompt,
+                            question,
+                            target,
+                            context,
+                            node: method,
+                            options: { model: model, apiKey, orgId, projectId, baseUrl },
+                        });
+                        if (!success) {
+                            failed.push(`${sourceFile.getFilePath()}#method:${classDeclaration.getName()}::${method.getName()}`);
+                        }
+                    }
+                    for (const property of classDeclaration.getProperties().filter(property => !property.getScope() || property.getScope() === ts_morph_1.Scope.Public)) {
+                        console.log(`PROCESS`.grey + ' ' + `method ${classDeclaration.getName()}::${property.getName()}`.green);
+                        question = `TASK: create the TSDoc documentation for the property \`${property.getName()}\` of class \`${classDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                        const success = yield generateTsDoc({
+                            systemPrompt,
+                            question,
+                            target,
+                            context,
+                            node: property,
+                            options: { model: model, apiKey, orgId, projectId, baseUrl },
+                        });
+                        if (!success) {
+                            failed.push(`${sourceFile.getFilePath()}#method:${classDeclaration.getName()}::${property.getName()}`);
+                        }
+                    }
+                }
+            }
+            if (failed.length > 0) {
+                console.log('Some documentation generation failed:'.bgRed);
+                console.log(`${failed.map(item => ' - ' + item).join('\n')}`.red);
+            }
+        });
+        yield (0, workspace_ts_morph_1.TsMorphTransform)(tree, path, operation);
+    });
+}
+exports.default = documentationGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/documentation/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/llm/src/generators/documentation/generator.ts"],"names":[],"mappings":";;AAyDA,wDA8LC;;AAtPD,iEAGkC;AAClC,qCAAuC;AACvC,yCAAqC;AACrC,+BAA4B;AAC5B,uCAIkB;AAElB,qDAAgD;AAChD,6DAAwD;AACxD,mEAA6D;AAC7D,yDAAoD;AACpD,qDAG8B;AAC9B,+DAA2D;AAC3D,2CAGyB;AAWzB,SAAe,aAAa;iEAAC,EAAG,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAwB;QAE5G,mCAAmC;QACnC,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,IAAA,uBAAU,EAAC,YAAY,EAAE,CAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;YAElG,2BAA2B;YAE3B,IAAA,yBAAU,EAAC,IAAI,CAAC,CAAC;YACjB,IAAA,qBAAQ,EAAC,IAAI,EAAE,IAAA,6BAAY,EAAC,KAAK,CAAC,CAAC,CAAC;QAEtC,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IAEd,CAAC;CAAA;AAED,SAAsB,sBAAsB,CAC1C,IAAU,EACV,OAAqC;;QAGrC,MAAM,EAAC,KAAK,GAAG,6BAA6B,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE5F,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,cAAc,KAAK,mDAAmD,CAAC,CAAC;QAC1F,CAAC;QAED,wCAAwC;QACxC,MAAM,GAAG,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAE1D,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,YAAY,GAAG,IAAA,sBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC;QAE7F,MAAM,SAAS,GAAkC,CAAO,OAAgB,EAAE,EAAE;YAC1E,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;gBAClD,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,EAAE,CAAC;oBACtE,SAAS;gBACX,CAAC;gBAED,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,GAAG,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;gBAEvE,MAAM,OAAO,GAAG,IAAA,gCAAc,EAAC,UAAU,CAAC,CAAC;gBAE3C,6DAA6D;gBAE7D,IAAI,MAAM,GAAG,qBAAsB,UAAU,CAAC,WAAW,EAAG,MAAM,CAAC;gBACnE,MAAM,IAAI,IAAA,kCAAc,EAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;gBACnD,MAAM,IAAI,iBAAiB,CAAC;gBAE5B,2DAA2D;gBAE3D,KAAK,MAAM,mBAAmB,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;oBAC5D,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,YAAY,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;oBACtF,MAAM,QAAQ,GAAG,2DAA2D,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;oBAC5J,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;wBAClC,YAAY;wBACZ,QAAQ;wBACR,MAAM;wBACN,OAAO;wBACP,IAAI,EAAE,mBAAmB;wBACzB,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;qBACtE,CAAC,CAAC;oBACH,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,aAAa,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACvF,CAAC;gBACH,CAAC;gBAED,KAAK,MAAM,oBAAoB,IAAI,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC;oBAC9D,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,aAAa,oBAAoB,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;oBACxF,IAAI,QAAQ,GAAG,4DAA4D,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;oBAC5J,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;wBAClC,YAAY;wBACZ,QAAQ;wBACR,MAAM;wBACN,OAAO;wBACP,IAAI,EAAE,oBAAoB;wBAC1B,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;qBACtE,CAAC,CAAC;oBAEH,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,cAAc,oBAAoB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACzF,CAAC;oBAED,KAAK,MAAM,MAAM,IAAI,oBAAoB,CAAC,UAAU,EAAE,EAAE,CAAC;wBACvD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,UAAU,oBAAoB,CAAC,OAAO,EAAE,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;wBAC1G,QAAQ,GAAG,yDAAyD,MAAM,CAAC,OAAO,EAAE,qBAAqB,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;wBAE1L,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;4BAClC,YAAY;4BACZ,QAAQ;4BACR,MAAM;4BACN,OAAO;4BACP,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;yBACtE,CAAC,CAAC;wBACH,IAAI,CAAC,OAAO,EAAE,CAAC;4BACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,WAAW,oBAAoB,CAAC,OAAO,EAAE,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;wBAC3G,CAAC;oBAEH,CAAC;oBAED,KAAK,MAAM,QAAQ,IAAI,oBAAoB,CAAC,aAAa,EAAE,EAAE,CAAC;wBAC5D,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,aAAa,oBAAoB,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;wBAC/G,QAAQ,GAAG,yDAAyD,QAAQ,CAAC,OAAO,EAAE,qBAAqB,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;wBAE5L,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;4BAClC,YAAY;4BACZ,QAAQ;4BACR,MAAM;4BACN,OAAO;4BACP,IAAI,EAAE,QAAQ;4BACd,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;yBACtE,CAAC,CAAC;wBACH,IAAI,CAAC,OAAO,EAAE,CAAC;4BACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,WAAW,oBAAoB,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;wBAC7G,CAAC;oBAEH,CAAC;gBAEH,CAAC;gBAED,KAAK,MAAM,eAAe,IAAI,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC1D,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,QAAQ,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;oBAC9E,MAAM,QAAQ,GAAG,uDAAuD,eAAe,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;oBACpJ,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;wBAClC,YAAY;wBACZ,QAAQ;wBACR,MAAM;wBACN,OAAO;wBACP,IAAI,EAAE,eAAe;wBACrB,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;qBACtE,CAAC,CAAC;oBAEH,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,SAAS,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAC/E,CAAC;gBAEH,CAAC;gBAED,KAAK,MAAM,gBAAgB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC;oBACvD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,SAAS,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;oBAChF,IAAI,QAAQ,GAAG,wDAAwD,gBAAgB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;oBAEpJ,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;wBAClC,YAAY;wBACZ,QAAQ;wBACR,MAAM;wBACN,OAAO;wBACP,IAAI,EAAE,gBAAgB;wBACtB,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;qBACtE,CAAC,CAAC;oBACH,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,UAAU,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACjF,CAAC;oBAED,KAAK,MAAM,MAAM,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,gBAAK,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC9H,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,UAAU,gBAAgB,CAAC,OAAO,EAAE,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;wBACtG,QAAQ,GAAG,yDAAyD,MAAM,CAAC,OAAO,EAAE,iBAAiB,gBAAgB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;wBAElL,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;4BAClC,YAAY;4BACZ,QAAQ;4BACR,MAAM;4BACN,OAAO;4BACP,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;yBACtE,CAAC,CAAC;wBACH,IAAI,CAAC,OAAO,EAAE,CAAC;4BACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,WAAW,gBAAgB,CAAC,OAAO,EAAE,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;wBACvG,CAAC;oBAEH,CAAC;oBAED,KAAK,MAAM,QAAQ,IAAI,gBAAgB,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,QAAQ,CAAC,QAAQ,EAAE,KAAK,gBAAK,CAAC,MAAM,CAAC,EAAE,CAAC;wBACzI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,UAAU,gBAAgB,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;wBACxG,QAAQ,GAAG,2DAA2D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,gBAAgB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;wBAEtL,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;4BAClC,YAAY;4BACZ,QAAQ;4BACR,MAAM;4BACN,OAAO;4BACP,IAAI,EAAE,QAAQ;4BACd,OAAO,EAAE,EAAE,KAAK,EAAE,KAAc,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE;yBACtE,CAAC,CAAC;wBACH,IAAI,CAAC,OAAO,EAAE,CAAC;4BACb,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,WAAW,gBAAgB,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;wBACzG,CAAC;oBAEH,CAAC;gBAEH,CAAC;YAEH,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,KAAK,CAAC,CAAC;gBAC3D,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;YACpE,CAAC;QACH,CAAC,CAAA,CAAC;QAEF,MAAM,IAAA,qCAAgB,EAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAEhD,CAAC;CAAA;AAED,kBAAe,sBAAsB,CAAC"}

package/src/generators/documentation/index.d.ts

@@ -0,0 +1,2 @@
+declare const schematic: (generatorOptions: import("./schema").DocumentationGeneratorSchema) => (tree: any, context: any) => Promise<any>;
+export default schematic;

package/src/generators/documentation/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const generator_1 = require("./generator");
+const schematic = (0, devkit_1.convertNxGenerator)(generator_1.default);
+exports.default = schematic;
+//# sourceMappingURL=index.js.map

package/src/generators/documentation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/llm/src/generators/documentation/index.ts"],"names":[],"mappings":";;AAAA,uCAAgD;AAChD,2CAAoC;AAEpC,MAAM,SAAS,GAAG,IAAA,2BAAkB,EAAC,mBAAS,CAAC,CAAC;AAChD,kBAAe,SAAS,CAAC"}

package/src/generators/documentation/schema.d.ts

@@ -0,0 +1,13 @@
+export interface DocumentationGeneratorSchema {
+  path?: string;
+  /** The openai api key */
+  apiKey?: string;
+  /** The openai organization id */
+  orgId?: string;
+  /** The openai project id */
+  projectId?: string;
+  /** The openai base url */
+  baseUrl?: string;
+  /** Set the LLM model to be used */
+  model?: string;
+}

package/src/generators/documentation/schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "Documentation",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "path": {
+      "type": "string",
+      "format": "path"
+    },
+    "apiKey": {
+      "type": "string",
+      "description": "The openai api key"
+    },
+    "orgId": {
+      "type": "string",
+      "description": "The openai organization id"
+    },
+    "projectId": {
+      "type": "string",
+      "description": "The openai project id"
+    },
+    "baseUrl": {
+      "type": "string",
+      "description": "The openai base url"
+    },
+    "model": {
+      "type": "string",
+      "description": "Set the LLM model to be used",
+      "default": "anthropic/claude-3-5-sonnet"
+    }
+  },
+  "required": []
+}

package/src/generators/documentation/system-prompts/context.xsd

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            elementFormDefault="qualified">
+
+    <!-- Definition of the sourceFileType to capture the 'path' attribute -->
+    <xsd:complexType name="sourceFileType">
+        <xsd:attribute name="path" type="xsd:string" use="required"/>
+    </xsd:complexType>
+
+    <!-- Root element 'context' -->
+    <xsd:element name="context">
+        <xsd:complexType>
+            <xsd:sequence>
+                <!-- 'referenced' element with multiple 'source-file' elements -->
+                <xsd:element name="referenced" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="source-file" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+
+                <!-- 'used' element with multiple 'source-file' elements -->
+                <xsd:element name="used" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="source-file" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+            </xsd:sequence>
+        </xsd:complexType>
+    </xsd:element>
+
+</xsd:schema>

package/src/generators/documentation/system-prompts/exmaple.txt

@@ -0,0 +1,134 @@
+Example Input:
+------------------------------------------------------------
+<context>
+  <referenced>
+    <sourceFile path="/delete-undefined-properties.ts">
+export function DeleteUndefinedProperties<T extends {}>(obj: T, recursive?: boolean): Exclude<T, undefined> {
+  if (!obj || typeof obj !== 'object') {
+    return obj as any;
+  }
+
+  const keys = Object.keys(obj);
+  const cloneObj: any = {};
+
+  for (const key of keys) {
+    if ((obj as any)[key] !== undefined) {
+      const value = (obj as any)[key];
+      cloneObj[key] = value;
+      if (recursive && value) {
+        if (Array.isArray(value)) {
+          cloneObj[key] = value.map((item) => DeleteUndefinedProperties(item, true));
+        } else if (typeof value === 'object') {
+          cloneObj[key] = DeleteUndefinedProperties(value, true);
+        }
+      }
+    }
+  }
+
+  return cloneObj;
+}
+    </sourceFile>
+    <sourceFile path="/delete-null-properties.ts">
+export function DeleteNullProperties<T extends {}>(obj: T, recursive?: boolean): Exclude<T, null> {
+  if (!obj || typeof obj !== 'object') {
+    return obj as any;
+  }
+
+  const keys = Object.keys(obj);
+  const cloneObj: any = {};
+
+  for (const key of keys) {
+    if ((obj as any)[key] !== null) {
+      const value = (obj as any)[key];
+      cloneObj[key] = value;
+      if (recursive && value) {
+        if (Array.isArray(value)) {
+          cloneObj[key] = value.map((item) => DeleteNullProperties(item, true));
+        } else if (typeof value === 'object') {
+          cloneObj[key] = DeleteNullProperties(value, true);
+        }
+      }
+    }
+  }
+
+  return cloneObj;
+}
+    </sourceFile>
+  </referenced>
+  <used>
+    <sourceFile path="/delete-empty-properties.spec.ts">
+import { DeleteEmptyProperties } from './delete-empty-properties';
+
+describe('DeleteEmptyProperties function', () => {
+  test('should remove null properties from an object', () => {
+    const inputObj = {
+      a: 1,
+      b: null,
+      c: 'test',
+    };
+
+    const expectedOutput = {
+      a: 1,
+      c: 'test',
+    };
+
+    expect(DeleteEmptyProperties(inputObj)).toEqual(expectedOutput);
+  });
+
+  test('should not remove null properties from nested objects if recursive flag is not set', () => {
+    const inputObj = {
+      a: 1,
+      b: null,
+      c: {
+        d: 3,
+        e: null,
+      },
+    };
+
+    const expectedOutput = {
+      a: 1,
+      c: {
+        d: 3,
+        e: null,
+      },
+    };
+
+    expect(DeleteEmptyProperties(inputObj)).toEqual(expectedOutput);
+  });
+
+  test('should remove null properties from nested objects if recursive flag is set', () => {
+    const inputObj = {
+      a: 1,
+      b: null,
+      c: {
+        d: 3,
+        e: null,
+      },
+    };
+
+    const expectedOutput = {
+      a: 1,
+      c: {
+        d: 3,
+      },
+    };
+
+    expect(DeleteEmptyProperties(inputObj, true)).toEqual(expectedOutput);
+  });
+});
+    </sourceFile>
+  </used>
+</context>
+
+
+<sourceFile path="/delete-empty-properties.ts">
+import { DeleteUndefinedProperties } from './delete-undefined-properties';
+import { DeleteNullProperties } from './delete-null-properties';
+
+export function DeleteEmptyProperties<T extends {}>(obj: T, recursive?: boolean): Exclude<Exclude<T, null>, undefined> {
+  return DeleteUndefinedProperties(DeleteNullProperties(obj, recursive), recursive);
+}
+</sourceFile>
+
+TASK: create the JsDoc documentation for the function DeleteEmptyProperties from the file `delete-empty-properties.ts`
+------------------------------------------------------------