@rxap/plugin-gpt 16.0.1-dev.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 16.0.1-dev.0 (2023-08-01)
+
+**Note:** Version bump only for package @rxap/plugin-gpt

package/README.md

@@ -0,0 +1,30 @@
+# @rxap/plugin-gpt
+
+[![npm version](https://img.shields.io/npm/v/@rxap/plugin-gpt?style=flat-square)](https://www.npmjs.com/package/@rxap/plugin-gpt)
+[![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
+[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+![Libraries.io dependency status for latest release, scoped npm package](https://img.shields.io/librariesio/release/npm/@rxap/plugin-gpt)
+![npm](https://img.shields.io/npm/dm/@rxap/plugin-gpt)
+![NPM](https://img.shields.io/npm/l/@rxap/plugin-gpt)
+
+- [Installation](#installation)
+- [Generators](#generators)
+
+# Installation
+
+**Add the package to your workspace:**
+```bash
+yarn add @rxap/plugin-gpt
+```
+**Install peer dependencies:**
+```bash
+yarn add 
+```
+# Generators
+
+## documentation
+> documentation generator
+
+```bash
+yarn nx g @rxap/plugin-gpt:documentation
+```

package/generators.json

@@ -0,0 +1,9 @@
+{
+  "generators": {
+    "documentation": {
+      "factory": "./src/generators/documentation/generator",
+      "schema": "./src/generators/documentation/schema.json",
+      "description": "documentation generator"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@rxap/plugin-gpt",
+  "version": "16.0.1-dev.0",
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public",
+    "directory": "../../../dist/packages/plugin/gpt"
+  },
+  "keywords": [
+    "rxap",
+    "plugin",
+    "nx",
+    "nx-plugin",
+    "gpt",
+    "openai",
+    "packages"
+  ],
+  "homepage": "https:/gitlab.com/rxap/packages/packages/plugin/gpt",
+  "bugs": {
+    "url": "https://gitlab.com/rxap/packages/-/issues",
+    "email": "incoming+rxap-packages-14898188-issue-@incoming.gitlab.com"
+  },
+  "license": "GPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/rxap/packages.git",
+    "directory": "packages/plugin/gpt"
+  },
+  "author": {
+    "name": "Merzough Münker",
+    "email": "mmuenker@digitaix.com"
+  },
+  "generators": "./generators.json",
+  "dependencies": {
+    "ignore": "^5.2.4",
+    "process": "0.11.10",
+    "semver": "^7.3.5",
+    "tslib": "2.6.1"
+  },
+  "peerDependencies": {
+    "@nx/devkit": "^16.5.0",
+    "@rxap/generator-ts-morph": "^1.0.1-dev.2",
+    "@rxap/generator-utilities": "^1.0.1-dev.2",
+    "gpt-3-encoder": "^1.1.4",
+    "openai": "^3.3.0",
+    "ts-morph": "^18.0.0",
+    "@rxap/node-utilities": "1.0.1-dev.2",
+    "@rxap/utilities": "16.0.0-dev.4",
+    "@rxap/workspace-ts-morph": "0.0.2-dev.0",
+    "@rxap/workspace-utilities": "0.1.0-dev.0"
+  },
+  "nx-migrations": {
+    "packageGroup": [
+      {
+        "package": "@rxap/generator-ts-morph",
+        "version": "1.0.1-dev.2"
+      },
+      {
+        "package": "@rxap/generator-utilities",
+        "version": "1.0.1-dev.2"
+      }
+    ]
+  },
+  "gitHead": "ed3a0788894aa734ec2a8e9e957cf73cabe033d6",
+  "main": "./src/index.js",
+  "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,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentationGenerator = void 0;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const ts_morph_1 = require("ts-morph");
+const generator_ts_morph_1 = require("@rxap/generator-ts-morph");
+const generator_utilities_1 = require("@rxap/generator-utilities");
+const process = require("process");
+const openai_1 = require("openai");
+const simple_prompt_1 = require("./simple-prompt");
+const path_1 = require("path");
+const fs_1 = require("fs");
+function getOpenAi(param = {}) {
+    const configuration = new openai_1.Configuration(Object.assign(Object.assign({}, param), { apiKey: process.env.OPENAI_API_KEY }));
+    return new openai_1.OpenAIApi(configuration);
+}
+function loadSystemPrompt(name) {
+    const filePath = (0, path_1.join)(__dirname, 'system-prompts', `${name}.txt`);
+    if (!(0, fs_1.existsSync)(filePath)) {
+        throw new Error(`Can not find system prompt file '${filePath}'`);
+    }
+    return (0, fs_1.readFileSync)(filePath).toString();
+}
+const FUNCTION_SYSTEM_PROMPT = loadSystemPrompt('function');
+const METHOD_SYSTEM_PROMPT = loadSystemPrompt('method');
+const CLASS_SYSTEM_PROMPT = loadSystemPrompt('class');
+function hasJsDoc(node) {
+    return node.getJsDocs().length > 0;
+}
+function prompt(options, systemPrompt, prompt) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (options.offline) {
+            return '';
+        }
+        return (0, simple_prompt_1.SimplePrompt)(systemPrompt, prompt, getOpenAi());
+    });
+}
+function cleanupJsDoc(jsDoc) {
+    const cleanJsDocArray = jsDoc
+        .split('\n')
+        .map(line => line
+        .trim()
+        .replace(/^\/\*\*/, '')
+        .replace(/^\s?\*\//, '')
+        .replace(/^\s?\*\s?/, '')
+        .trim());
+    cleanJsDocArray.pop();
+    return cleanJsDocArray.join('\n');
+}
+function addJsDoc(options, node, jsDoc) {
+    if (options.offline) {
+        return;
+    }
+    node.addJsDoc(cleanupJsDoc(jsDoc));
+}
+function processMethod(options, project, sourceFile, methodDeclaration) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        console.log(`====== Process method: \x1b[36m${methodDeclaration.getName()}\x1b[0m`);
+        if (hasJsDoc(methodDeclaration)) {
+            console.log(`\x1b[33mMethod has already a documentation\x1b[0m`);
+            return false;
+        }
+        const methodText = methodDeclaration.getText();
+        console.log('Method text:');
+        console.log(methodText);
+        const jsDoc = yield prompt(options, METHOD_SYSTEM_PROMPT, methodText);
+        console.log('Method documentation:');
+        console.log(jsDoc);
+        addJsDoc(options, methodDeclaration, jsDoc);
+        return true;
+    });
+}
+function processClass(options, project, sourceFile, classDeclaration) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        console.log(`====== Process class: \x1b[36m${classDeclaration.getName()}\x1b[0m`);
+        let changed = false;
+        for (const md of classDeclaration.getMethods()) {
+            const scope = md.getScope();
+            if (scope === 'public' || scope === undefined) {
+                const hasChanged = yield processMethod(options, project, sourceFile, md);
+                changed = changed || hasChanged;
+            }
+        }
+        return changed;
+    });
+}
+function processFunction(options, project, sourceFile, functionDeclaration) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        console.log(`====== Process function: \x1b[36m${functionDeclaration.getName()}\x1b[0m`);
+        if (hasJsDoc(functionDeclaration)) {
+            console.log(`\x1b[33mFunction has already a documentation\x1b[0m`);
+            return false;
+        }
+        const functionText = functionDeclaration.getText();
+        console.log('Function text:');
+        console.log(functionText);
+        const jsDoc = yield prompt(options, FUNCTION_SYSTEM_PROMPT, functionText);
+        console.log('Function documentation:');
+        console.log(jsDoc);
+        addJsDoc(options, functionDeclaration, jsDoc);
+        return true;
+    });
+}
+function processSourceFile(options, project, sourceFile) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        console.log(`====== Process source file: \x1b[35m${sourceFile.getFilePath()}\x1b[0m`);
+        let changed = false;
+        for (const fd of sourceFile.getFunctions()) {
+            const hasChanged = yield processFunction(options, project, sourceFile, fd);
+            changed = changed || hasChanged;
+        }
+        for (const cd of sourceFile.getClasses()) {
+            const hasChanged = yield processClass(options, project, sourceFile, cd);
+            changed = changed || hasChanged;
+        }
+        return changed;
+    });
+}
+function skipSourceFile(sourceFile) {
+    if (sourceFile.getBaseName() === 'index.ts') {
+        // console.log(`\x1b[33mSkip index file: \x1b[0m${ sourceFile.getFilePath() }`);
+        return true;
+    }
+    if (sourceFile.getBaseName().endsWith('.spec.ts')) {
+        // console.log(`\x1b[33mSkip spec file: \x1b[0m${ sourceFile.getFilePath() }`);
+        return true;
+    }
+    if (sourceFile.getBaseName().endsWith('.stories.ts')) {
+        // console.log(`\x1b[33mSkip stories file: \x1b[0m${ sourceFile.getFilePath() }`);
+        return true;
+    }
+    if (sourceFile.getBaseName().endsWith('.cy.ts')) {
+        // console.log(`\x1b[33mSkip cypress file: \x1b[0m${ sourceFile.getFilePath() }`);
+        return true;
+    }
+    return false;
+}
+function processProject(options, projectName, tree) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const projectSourceRoot = (0, generator_utilities_1.GetProjectSourceRoot)(tree, projectName);
+        const project = new ts_morph_1.Project({
+            manipulationSettings: {
+                indentationText: ts_morph_1.IndentationText.TwoSpaces,
+                quoteKind: ts_morph_1.QuoteKind.Single,
+            },
+            useInMemoryFileSystem: true,
+        });
+        (0, generator_ts_morph_1.AddDir)(tree, projectSourceRoot, project);
+        const start = Date.now();
+        for (const sourceFile of project.getSourceFiles()) {
+            if (skipSourceFile(sourceFile)) {
+                continue;
+            }
+            try {
+                const changed = yield processSourceFile(options, project, sourceFile);
+                if (changed) {
+                    tree.write(sourceFile.getFilePath(), sourceFile.getFullText());
+                }
+            }
+            catch (e) {
+                console.error(`\x1b[31mError processing file: \x1b[0m${sourceFile.getFilePath()}`);
+                console.error(e.message);
+                console.error(e.stack);
+                break;
+            }
+            if (Date.now() - start > MAX_TIME) {
+                console.log(`\x1b[33mMax time reached: \x1b[0m${MAX_TIME}`);
+                break;
+            }
+        }
+    });
+}
+function skipProject(project, projectName, options) {
+    var _a;
+    if ((_a = options.projects) === null || _a === void 0 ? void 0 : _a.length) {
+        return !options.projects.includes(projectName);
+    }
+    return false;
+}
+const MAX_TIME = 1000 * 60 * 60 * 0.5;
+function documentationGenerator(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        for (const [projectName, project] of (0, devkit_1.getProjects)(tree).entries()) {
+            if (skipProject(project, projectName, options)) {
+                continue;
+            }
+            yield processProject(options, projectName, tree);
+        }
+    });
+}
+exports.documentationGenerator = documentationGenerator;
+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/gpt/src/generators/documentation/generator.ts"],"names":[],"mappings":";;;;AAAA,uCAIoB;AAEpB,uCASkB;AAClB,iEAAkD;AAClD,mEAAiE;AACjE,mCAAmC;AACnC,mCAIgB;AAChB,mDAA+C;AAC/C,+BAA4B;AAC5B,2BAGY;AAEZ,SAAS,SAAS,CAAC,QAAiD,EAAE;IAGpE,MAAM,aAAa,GAAG,IAAI,sBAAa,iCAClC,KAAK,KACR,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc,IAClC,CAAC;IACH,OAAO,IAAI,kBAAS,CAAC,aAAa,CAAC,CAAC;AAEtC,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY;IACpC,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,EAAE,GAAI,IAAK,MAAM,CAAC,CAAC;IACpE,IAAI,CAAC,IAAA,eAAU,EAAC,QAAQ,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,oCAAqC,QAAS,GAAG,CAAC,CAAC;KACpE;IACD,OAAO,IAAA,iBAAY,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC3C,CAAC;AAED,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAC5D,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AACxD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAEtD,SAAS,QAAQ,CAAC,IAAmB;IACnC,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AACrC,CAAC;AAED,SAAe,MAAM,CAAC,OAAO,EAAE,YAAoB,EAAE,MAAc;;QAEjE,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,EAAE,CAAC;SACX;QAED,OAAO,IAAA,4BAAY,EACjB,YAAY,EACZ,MAAM,EACN,SAAS,EAAE,CACZ,CAAC;IACJ,CAAC;CAAA;AAED,SAAS,YAAY,CAAC,KAAa;IAEjC,MAAM,eAAe,GAAG,KAAK;SAC1B,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI;SACd,IAAI,EAAE;SACN,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;SACtB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,IAAI,EAAE,CACR,CAAC;IAEJ,eAAe,CAAC,GAAG,EAAE,CAAC;IAEtB,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEpC,CAAC;AAED,SAAS,QAAQ,CAAC,OAAqC,EAAE,IAAmB,EAAE,KAAa;IAEzF,IAAI,OAAO,CAAC,OAAO,EAAE;QACnB,OAAO;KACR;IAED,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,SAAe,aAAa,CAC1B,OAAqC,EACrC,OAAgB,EAChB,UAAsB,EACtB,iBAAoC;;QAGpC,OAAO,CAAC,GAAG,CAAC,kCAAmC,iBAAiB,CAAC,OAAO,EAAG,SAAS,CAAC,CAAC;QAEtF,IAAI,QAAQ,CAAC,iBAAiB,CAAC,EAAE;YAC/B,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;YACjE,OAAO,KAAK,CAAC;SACd;QAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAE/C,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAGxB,MAAM,KAAK,GAAG,MAAM,MAAM,CACxB,OAAO,EACP,oBAAoB,EACpB,UAAU,CACX,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEnB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IAEd,CAAC;CAAA;AAED,SAAe,YAAY,CACzB,OAAqC,EACrC,OAAgB,EAChB,UAAsB,EACtB,gBAAkC;;QAGlC,OAAO,CAAC,GAAG,CAAC,iCAAkC,gBAAgB,CAAC,OAAO,EAAG,SAAS,CAAC,CAAC;QAEpF,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,KAAK,MAAM,EAAE,IAAI,gBAAgB,CAAC,UAAU,EAAE,EAAE;YAC9C,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAC5B,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS,EAAE;gBAC7C,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;gBACzE,OAAO,GAAG,OAAO,IAAI,UAAU,CAAC;aACjC;SACF;QAED,OAAO,OAAO,CAAC;IAEjB,CAAC;CAAA;AAED,SAAe,eAAe,CAC5B,OAAqC,EACrC,OAAgB,EAChB,UAAsB,EACtB,mBAAwC;;QAGxC,OAAO,CAAC,GAAG,CAAC,oCAAqC,mBAAmB,CAAC,OAAO,EAAG,SAAS,CAAC,CAAC;QAE1F,IAAI,QAAQ,CAAC,mBAAmB,CAAC,EAAE;YACjC,OAAO,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAC;YACnE,OAAO,KAAK,CAAC;SACd;QAED,MAAM,YAAY,GAAG,mBAAmB,CAAC,OAAO,EAAE,CAAC;QAEnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE1B,MAAM,KAAK,GAAG,MAAM,MAAM,CACxB,OAAO,EACP,sBAAsB,EACtB,YAAY,CACb,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEnB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC;IAEd,CAAC;CAAA;AAED,SAAe,iBAAiB,CAAC,OAAqC,EAAE,OAAgB,EAAE,UAAsB;;QAE9G,OAAO,CAAC,GAAG,CAAC,uCAAwC,UAAU,CAAC,WAAW,EAAG,SAAS,CAAC,CAAC;QAExF,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE;YAC1C,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;YAC3E,OAAO,GAAG,OAAO,IAAI,UAAU,CAAC;SACjC;QAED,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE;YACxC,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;YACxE,OAAO,GAAG,OAAO,IAAI,UAAU,CAAC;SACjC;QAED,OAAO,OAAO,CAAC;IAEjB,CAAC;CAAA;AAED,SAAS,cAAc,CAAC,UAAsB;IAC5C,IAAI,UAAU,CAAC,WAAW,EAAE,KAAK,UAAU,EAAE;QAC3C,gFAAgF;QAChF,OAAO,IAAI,CAAC;KACb;IACD,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QACjD,+EAA+E;QAC/E,OAAO,IAAI,CAAC;KACb;IACD,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QACpD,kFAAkF;QAClF,OAAO,IAAI,CAAC;KACb;IACD,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAC/C,kFAAkF;QAClF,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAe,cAAc,CAAC,OAAqC,EAAE,WAAmB,EAAE,IAAU;;QAElG,MAAM,iBAAiB,GAAG,IAAA,0CAAoB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAElE,MAAM,OAAO,GAAG,IAAI,kBAAO,CAAC;YAC1B,oBAAoB,EAAE;gBACpB,eAAe,EAAE,0BAAe,CAAC,SAAS;gBAC1C,SAAS,EAAE,oBAAS,CAAC,MAAM;aAC5B;YACD,qBAAqB,EAAE,IAAI;SAC5B,CAAC,CAAC;QAEH,IAAA,2BAAM,EAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAEzC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEzB,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,EAAE;YACjD,IAAI,cAAc,CAAC,UAAU,CAAC,EAAE;gBAC9B,SAAS;aACV;YACD,IAAI;gBACF,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;gBACtE,IAAI,OAAO,EAAE;oBACX,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;iBAChE;aACF;YAAC,OAAO,CAAM,EAAE;gBACf,OAAO,CAAC,KAAK,CAAC,yCAA0C,UAAU,CAAC,WAAW,EAAG,EAAE,CAAC,CAAC;gBACrF,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACzB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBACvB,MAAM;aACP;YACD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,QAAQ,EAAE;gBACjC,OAAO,CAAC,GAAG,CAAC,oCAAqC,QAAS,EAAE,CAAC,CAAC;gBAC9D,MAAM;aACP;SACF;IAEH,CAAC;CAAA;AAED,SAAS,WAAW,CAAC,OAA6B,EAAE,WAAmB,EAAE,OAAqC;;IAE5G,IAAI,MAAA,OAAO,CAAC,QAAQ,0CAAE,MAAM,EAAE;QAC5B,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;KAChD;IAED,OAAO,KAAK,CAAC;AAEf,CAAC;AAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;AAEtC,SAAsB,sBAAsB,CAC1C,IAAU,EACV,OAAqC;;QAGrC,KAAK,MAAM,CAAE,WAAW,EAAE,OAAO,CAAE,IAAI,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YAElE,IAAI,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;gBAC9C,SAAS;aACV;YAED,MAAM,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;SAElD;IAEH,CAAC;CAAA;AAfD,wDAeC;AAED,kBAAe,sBAAsB,CAAC"}

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

@@ -0,0 +1,4 @@
+export interface DocumentationGeneratorSchema {
+  projects: string[];
+  offline: boolean;
+}

package/src/generators/documentation/schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "Documentation",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "projects": {
+      "alias": "project",
+      "type": "array",
+      "description": "A list of projects where the documentation should be generated",
+      "items": {
+        "type": "string"
+      }
+    },
+    "offline": {
+      "type": "boolean",
+      "description": "If true, the openai api is not used"
+    }
+  }
+}

package/src/generators/documentation/simple-prompt.d.ts

@@ -0,0 +1,6 @@
+import { OpenAIApi } from 'openai';
+export interface SimplePromtOptions {
+    max_tokens?: number;
+    model?: 'gpt-4' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k';
+}
+export declare function SimplePrompt(systemPrompt: string, prompt: string, openai: OpenAIApi, options?: SimplePromtOptions): Promise<string>;

package/src/generators/documentation/simple-prompt.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimplePrompt = void 0;
+const tslib_1 = require("tslib");
+const gpt_3_encoder_1 = require("gpt-3-encoder");
+const tokenLimits = {
+    'gpt-4': 8192,
+    'gpt-3.5-turbo': 4096,
+    'gpt-3.5-turbo-16k': 16384,
+};
+function SimplePrompt(systemPrompt, prompt, openai, options = {
+    max_tokens: 1024,
+    model: 'gpt-4',
+}) {
+    var _a, _b, _c, _d;
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const systemPromptLength = (0, gpt_3_encoder_1.encode)(systemPrompt).length;
+        const promptLength = (0, gpt_3_encoder_1.encode)(prompt).length;
+        const inputLength = Math.floor((systemPromptLength + promptLength) * 1.1);
+        (_a = options.model) !== null && _a !== void 0 ? _a : (options.model = 'gpt-4');
+        (_b = options.max_tokens) !== null && _b !== void 0 ? _b : (options.max_tokens = 1024);
+        if (!tokenLimits[options.model]) {
+            throw new Error(`\x1b[31mModel '${options.model}' is not supported.\x1b[0m`);
+        }
+        const tokenLimit = tokenLimits[options.model];
+        if (inputLength > tokenLimit * 0.8) {
+            throw new Error(`\x1b[31mInput length (${inputLength}) is too large. It should be at most ${tokenLimit *
+                0.8}\x1b[0m`);
+        }
+        if (options.max_tokens) {
+            if (options.max_tokens > tokenLimit - inputLength) {
+                console.log(`\x1b[33mWarning: max_tokens (${options.max_tokens}) is too large. It should be at most ${tokenLimit -
+                    inputLength}\x1b[0m`);
+                options.max_tokens = tokenLimit - inputLength;
+            }
+        }
+        let content;
+        try {
+            const response = yield openai.createChatCompletion(Object.assign(Object.assign({}, options), { messages: [
+                    {
+                        'role': 'system',
+                        'content': systemPrompt,
+                    },
+                    {
+                        'role': 'user',
+                        'content': prompt,
+                    },
+                ], temperature: 0, top_p: 1, frequency_penalty: 0, presence_penalty: 0 }));
+            content = (_c = response.data.choices[0].message) === null || _c === void 0 ? void 0 : _c.content;
+        }
+        catch (e) {
+            console.log((_d = e.response) === null || _d === void 0 ? void 0 : _d.data);
+            throw new Error('OpenAI API error: ' + e.message);
+        }
+        if (!content) {
+            throw new Error(`\x1b[31mNo content in response for paper\x1b[0m`);
+        }
+        return content;
+    });
+}
+exports.SimplePrompt = SimplePrompt;
+//# sourceMappingURL=simple-prompt.js.map

package/src/generators/documentation/simple-prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-prompt.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/simple-prompt.ts"],"names":[],"mappings":";;;;AACA,iDAAuC;AAEvC,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,KAAK;CAC3B,CAAC;AAOF,SAAsB,YAAY,CAChC,YAAoB,EACpB,MAAc,EACd,MAAiB,EACjB,UAA8B;IAC5B,UAAU,EAAE,IAAI;IAChB,KAAK,EAAE,OAAO;CACf;;;QAID,MAAM,kBAAkB,GAAG,IAAA,sBAAM,EAAC,YAAY,CAAC,CAAC,MAAM,CAAC;QACvD,MAAM,YAAY,GAAG,IAAA,sBAAM,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAE3C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,kBAAkB,GAAG,YAAY,CAAC,GAAG,GAAG,CAAC,CAAC;QAE1E,MAAA,OAAO,CAAC,KAAK,oCAAb,OAAO,CAAC,KAAK,GAAK,OAAO,EAAC;QAC1B,MAAA,OAAO,CAAC,UAAU,oCAAlB,OAAO,CAAC,UAAU,GAAK,IAAI,EAAC;QAE5B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,kBAAmB,OAAO,CAAC,KAAM,4BAA4B,CAAC,CAAC;SAChF;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE9C,IAAI,WAAW,GAAG,UAAU,GAAG,GAAG,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,yBAA0B,WAAY,wCAAyC,UAAU;gBACzG,GAAI,SAAS,CAAC,CAAC;SAChB;QAED,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,IAAI,OAAO,CAAC,UAAU,GAAG,UAAU,GAAG,WAAW,EAAE;gBACjD,OAAO,CAAC,GAAG,CAAC,gCAAiC,OAAO,CAAC,UAAW,wCAAyC,UAAU;oBACnH,WAAY,SAAS,CAAC,CAAC;gBACvB,OAAO,CAAC,UAAU,GAAG,UAAU,GAAG,WAAW,CAAC;aAC/C;SACF;QAED,IAAI,OAA2B,CAAC;QAEhC,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,oBAAoB,iCAC5C,OAAe,KACnB,QAAQ,EAAE;oBACR;wBACE,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,YAAY;qBACxB;oBACD;wBACE,MAAM,EAAE,MAAM;wBACd,SAAS,EAAE,MAAM;qBAClB;iBACF,EACD,WAAW,EAAE,CAAC,EACd,KAAK,EAAE,CAAC,EACR,iBAAiB,EAAE,CAAC,EACpB,gBAAgB,EAAE,CAAC,IACnB,CAAC;YAEH,OAAO,GAAG,MAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,0CAAE,OAAO,CAAC;SAErD;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,MAAA,CAAC,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;SACnD;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,OAAO,OAAO,CAAC;;CAEhB;AAxED,oCAwEC"}

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

@@ -0,0 +1 @@
+You're a software developer with a particular task at hand: to generate succinct, insightful, and comprehensive documentation for a TypeScript class methods. Your work should be presented in the form of a documentation comment. Please note, the output of your task should solely consist of the documentation comment, excluding any code or non-documentation elements. Remember not to alter or analyze the logic of the class method - your main focus is on producing precise and understandable documentation. The TypeScript class method to be documented is outlined below:

package/src/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/plugin/gpt/src/index.ts"],"names":[],"mappings":""}