@rxap/plugin-llm 20.0.4-dev.3 → 20.1.0-dev.0

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +13 -13
  3. package/package.json +2 -2
  4. package/src/generators/documentation/schema.json +10 -7
  5. package/src/generators/package-description/schema.json +12 -8
package/CHANGELOG.md CHANGED
@@ -3,6 +3,12 @@
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.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-llm@20.0.4-dev.3...@rxap/plugin-llm@20.1.0-dev.0) (2026-01-12)
7
+
8
+ ### Features
9
+
10
+ - **schema:** enhance generator schema documentation with descriptions and examples ([0ae4939](https://gitlab.com/rxap/packages/commit/0ae4939d77e3e313ace4a77d8f5dd86c3c918d29))
11
+
6
12
  ## [20.0.4-dev.3](https://gitlab.com/rxap/packages/compare/@rxap/plugin-llm@20.0.4-dev.2...@rxap/plugin-llm@20.0.4-dev.3) (2025-09-18)
7
13
 
8
14
  **Note:** Version bump only for package @rxap/plugin-llm
package/README.md CHANGED
@@ -41,12 +41,12 @@ nx g @rxap/plugin-llm:documentation
41
41
 
42
42
  Option | Type | Default | Description
43
43
  --- | --- | --- | ---
44
- path | string | |
45
- apiKey | string | | The openai api key
46
- orgId | string | | The openai organization id
47
- projectId | string | | The openai project id
48
- baseUrl | string | | The openai base url
49
- model | string | anthropic/claude-3-5-sonnet | Set the LLM model to be used
44
+ path | string | | The file or directory path to process for documentation generation.
45
+ apiKey | string | | The API key for accessing LLM services.
46
+ orgId | string | | The organization ID for LLM API requests.
47
+ projectId | string | | The project ID for LLM API requests.
48
+ baseUrl | string | | The base URL for LLM API requests.
49
+ model | string | anthropic/claude-3-5-sonnet | The LLM model to use for documentation generation.
50
50
 
51
51
  ## package-description
52
52
  > Generates a package description based on the source code
@@ -57,10 +57,10 @@ nx g @rxap/plugin-llm:package-description
57
57
 
58
58
  Option | Type | Default | Description
59
59
  --- | --- | --- | ---
60
- project | string | |
61
- apiKey | string | | The openai api key
62
- orgId | string | | The openai organization id
63
- projectId | string | | The openai project id
64
- baseUrl | string | | The openai base url
65
- model | string | gemini/2.0-flash | Set the LLM model to be used
66
- overwrite | boolean | | Replaces the existing description files
60
+ project | string | | The name of the project to generate a package description for.
61
+ apiKey | string | | The API key for accessing LLM services.
62
+ orgId | string | | The organization ID for LLM API requests.
63
+ projectId | string | | The project ID for LLM API requests.
64
+ baseUrl | string | | The base URL for LLM API requests.
65
+ model | string | gemini/2.0-flash | The LLM model to use for package description generation.
66
+ overwrite | boolean | false | Whether to overwrite existing package description files.
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "20.0.4-dev.3",
2
+ "version": "20.1.0-dev.0",
3
3
  "name": "@rxap/plugin-llm",
4
4
  "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",
5
5
  "license": "GPL-3.0-or-later",
@@ -45,5 +45,5 @@
45
45
  "schematics": "./generators.json",
46
46
  "type": "commonjs",
47
47
  "types": "./src/index.d.ts",
48
- "gitHead": "ef20bc50270ad0727a111d54e48cb279ff3ed5cf"
48
+ "gitHead": "f6923aa9d989b25018f2fcac470963fb1e68049a"
49
49
  }
package/src/generators/documentation/schema.json CHANGED
@@ -6,28 +6,31 @@
6
6
  "properties": {
7
7
  "path": {
8
8
  "type": "string",
9
- "format": "path"
9
+ "format": "path",
10
+ "description": "The file or directory path to process for documentation generation.",
11
+ "examples": ["libs/my-lib", "libs/my-lib/src/index.ts"]
10
12
  },
11
13
  "apiKey": {
12
14
  "type": "string",
13
- "description": "The openai api key"
15
+ "description": "The API key for accessing LLM services."
14
16
  },
15
17
  "orgId": {
16
18
  "type": "string",
17
- "description": "The openai organization id"
19
+ "description": "The organization ID for LLM API requests."
18
20
  },
19
21
  "projectId": {
20
22
  "type": "string",
21
- "description": "The openai project id"
23
+ "description": "The project ID for LLM API requests."
22
24
  },
23
25
  "baseUrl": {
24
26
  "type": "string",
25
- "description": "The openai base url"
27
+ "description": "The base URL for LLM API requests."
26
28
  },
27
29
  "model": {
28
30
  "type": "string",
29
- "description": "Set the LLM model to be used",
30
- "default": "anthropic/claude-3-5-sonnet"
31
+ "description": "The LLM model to use for documentation generation.",
32
+ "default": "anthropic/claude-3-5-sonnet",
33
+ "examples": ["anthropic/claude-3-5-sonnet", "gemini/2.0-flash"]
31
34
  }
32
35
  },
33
36
  "required": []
package/src/generators/package-description/schema.json CHANGED
@@ -5,32 +5,36 @@
5
5
  "type": "object",
6
6
  "properties": {
7
7
  "project": {
8
- "type": "string"
8
+ "type": "string",
9
+ "description": "The name of the project to generate a package description for.",
10
+ "examples": ["my-lib"]
9
11
  },
10
12
  "apiKey": {
11
13
  "type": "string",
12
- "description": "The openai api key"
14
+ "description": "The API key for accessing LLM services."
13
15
  },
14
16
  "orgId": {
15
17
  "type": "string",
16
- "description": "The openai organization id"
18
+ "description": "The organization ID for LLM API requests."
17
19
  },
18
20
  "projectId": {
19
21
  "type": "string",
20
- "description": "The openai project id"
22
+ "description": "The project ID for LLM API requests."
21
23
  },
22
24
  "baseUrl": {
23
25
  "type": "string",
24
- "description": "The openai base url"
26
+ "description": "The base URL for LLM API requests."
25
27
  },
26
28
  "model": {
27
29
  "type": "string",
28
- "description": "Set the LLM model to be used",
29
- "default": "gemini/2.0-flash"
30
+ "description": "The LLM model to use for package description generation.",
31
+ "default": "gemini/2.0-flash",
32
+ "examples": ["gemini/2.0-flash", "anthropic/claude-3-5-sonnet"]
30
33
  },
31
34
  "overwrite": {
32
35
  "type": "boolean",
33
- "description": "Replaces the existing description files"
36
+ "description": "Whether to overwrite existing package description files.",
37
+ "default": false
34
38
  }
35
39
  },
36
40
  "required": ["project"]