@rxap/plugin-gpt 20.1.0 → 20.1.1-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +14 -16
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [20.1.1-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.1.1-dev.0...@rxap/plugin-gpt@20.1.1-dev.1) (2025-02-18)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @rxap/plugin-gpt
|
|
9
|
+
|
|
10
|
+
## [20.1.1-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.1.0...@rxap/plugin-gpt@20.1.1-dev.0) (2025-02-17)
|
|
11
|
+
|
|
12
|
+
**Note:** Version bump only for package @rxap/plugin-gpt
|
|
13
|
+
|
|
6
14
|
# [20.1.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.1.0-dev.4...@rxap/plugin-gpt@20.1.0) (2025-02-13)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @rxap/plugin-gpt
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
This package provides a generator to add JSDoc documentation to TypeScript code using the OpenAI API. It can process functions and methods, and composes a context for the AI to generate accurate documentation. The generator also includes utilities for cleaning up JSDoc comments and managing OpenAI API interactions.
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@rxap/plugin-gpt)
|
|
4
4
|
[](https://commitizen.github.io/cz-cli/)
|
|
@@ -9,6 +9,8 @@
|
|
|
9
9
|
|
|
10
10
|
- [Installation](#installation)
|
|
11
11
|
- [Generators](#generators)
|
|
12
|
+
- [documentation](#documentation)
|
|
13
|
+
- [init](#init)
|
|
12
14
|
|
|
13
15
|
# Installation
|
|
14
16
|
|
|
@@ -26,26 +28,22 @@ yarn nx g @rxap/plugin-gpt:init
|
|
|
26
28
|
> documentation generator
|
|
27
29
|
|
|
28
30
|
```bash
|
|
29
|
-
|
|
31
|
+
nx g @rxap/plugin-gpt:documentation
|
|
30
32
|
```
|
|
31
33
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
yarn nx g @rxap/plugin-gpt:documentation
|
|
44
|
-
```
|
|
34
|
+
Option | Type | Default | Description
|
|
35
|
+
--- | --- | --- | ---
|
|
36
|
+
projects | array | | A list of projects where the documentation should be generated
|
|
37
|
+
project | string | |
|
|
38
|
+
offline | boolean | | If true, the openai api is not used
|
|
39
|
+
filter | string | | A filter to select the files to be processed
|
|
40
|
+
openaiApiKey | string | | The openai api key
|
|
41
|
+
openaiOrgId | string | | The openai organization id
|
|
42
|
+
openaiProjectId | string | | The openai project id
|
|
45
43
|
|
|
46
44
|
## init
|
|
47
45
|
> Initialize the package in the workspace
|
|
48
46
|
|
|
49
47
|
```bash
|
|
50
|
-
|
|
48
|
+
nx g @rxap/plugin-gpt:init
|
|
51
49
|
```
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "20.1.
|
|
2
|
+
"version": "20.1.1-dev.1",
|
|
3
3
|
"name": "@rxap/plugin-gpt",
|
|
4
4
|
"description": "This package provides a generator to add JSDoc documentation to TypeScript code using the OpenAI API. It can process functions and methods, and composes a context for the AI to generate accurate documentation. The generator also includes utilities for cleaning up JSDoc comments and managing OpenAI API interactions.\n",
|
|
5
5
|
"license": "GPL-3.0-or-later",
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"@nx/devkit": "20.4.2",
|
|
8
|
-
"@rxap/ts-morph": "^1.5.
|
|
9
|
-
"@rxap/workspace-ts-morph": "^19.1.
|
|
10
|
-
"@rxap/workspace-utilities": "^19.6.1",
|
|
8
|
+
"@rxap/ts-morph": "^1.5.4-dev.0",
|
|
9
|
+
"@rxap/workspace-ts-morph": "^19.1.10-dev.1",
|
|
10
|
+
"@rxap/workspace-utilities": "^19.6.2-dev.1",
|
|
11
11
|
"gpt-3-encoder": "^1.1.4",
|
|
12
12
|
"openai": "^4.52.0",
|
|
13
13
|
"ts-morph": "18.0.0",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
},
|
|
45
45
|
"schematics": "./generators.json",
|
|
46
46
|
"type": "commonjs",
|
|
47
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "9978b20018f781a5952245bfe2db15ab7612611c",
|
|
48
48
|
"types": "./src/index.d.ts",
|
|
49
49
|
"main": "./src/index.js"
|
|
50
50
|
}
|