@rxap/plugin-n8n 20.1.3-dev.3 → 20.2.0-dev.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [20.2.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-n8n@20.1.3-dev.3...@rxap/plugin-n8n@20.2.0-dev.0) (2026-01-12)
+
+### Features
+
+- **schema:** enhance generator schema documentation with descriptions and examples ([0ae4939](https://gitlab.com/rxap/packages/commit/0ae4939d77e3e313ace4a77d8f5dd86c3c918d29))
+
 ## [20.1.3-dev.3](https://gitlab.com/rxap/packages/compare/@rxap/plugin-n8n@20.1.3-dev.2...@rxap/plugin-n8n@20.1.3-dev.3) (2025-09-18)
 
 **Note:** Version bump only for package @rxap/plugin-n8n

package/README.md

@@ -72,11 +72,11 @@ nx g @rxap/plugin-n8n:init
 
 Option | Type | Default | Description
 --- | --- | --- | ---
-project | string |  | 
-projects | array |  | 
-skipFormat | boolean | false | 
-overwrite | boolean | false | Whether to overwrite existing files
-skipProjects | boolean | false | Whether to skip executing project specific initialization
+project | string |  | The name of the project to initialize with n8n integration.
+projects | array |  | The list of projects to initialize with n8n integration.
+skipFormat | boolean | false | Whether to skip formatting files with Prettier after initialization.
+overwrite | boolean | false | Whether to overwrite existing files during initialization.
+skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
 
 ## node
 > node generator
@@ -87,10 +87,10 @@ nx g @rxap/plugin-n8n:node
 
 Option | Type | Default | Description
 --- | --- | --- | ---
-name | string |  | 
-project | string |  | 
-description | string |  | 
-nodeNamePrefix | string |  | 
+name | string |  | The name of the new n8n node.
+project | string |  | The name of the project where the new node should be created.
+description | string |  | A brief description of the new n8n node's purpose.
+nodeNamePrefix | string |  | An optional prefix to prepend to the node's internal class name.
 
 ## trigger
 > trigger generator
@@ -101,7 +101,7 @@ nx g @rxap/plugin-n8n:trigger
 
 Option | Type | Default | Description
 --- | --- | --- | ---
-name | string |  | 
-project | string |  | 
-description | string |  | 
-nodeNamePrefix | string |  | 
+name | string |  | The name of the new n8n trigger node.
+project | string |  | The name of the project where the new trigger node should be created.
+description | string |  | A brief description of the new n8n trigger node's purpose.
+nodeNamePrefix | string |  | An optional prefix to prepend to the trigger node's internal class name.

package/package.json

@@ -1,11 +1,11 @@
 {
-  "version": "20.1.3-dev.3",
+  "version": "20.2.0-dev.0",
   "name": "@rxap/plugin-n8n",
   "description": "This package provides generators for initializing and creating n8n plugins within an Nx workspace. It includes generators for initializing a workspace or project for n8n development, as well as a generator for creating new n8n nodes. The package also includes utilities for updating project configurations and package.json files to support n8n plugin development.\n",
   "license": "GPL-3.0-or-later",
   "dependencies": {
     "@nx/devkit": "20.5.0",
-    "@rxap/plugin-library": "^20.2.2-dev.3",
+    "@rxap/plugin-library": "^20.3.0-dev.0",
     "@rxap/ts-morph": "^1.6.0-dev.2",
     "@rxap/utilities": "^16.5.0-dev.0",
     "@rxap/workspace-ts-morph": "^19.1.13-dev.3",
@@ -46,7 +46,7 @@
   "schematics": "./generators.json",
   "type": "commonjs",
   "typings": "./src/index.d.ts",
-  "gitHead": "ef20bc50270ad0727a111d54e48cb279ff3ed5cf",
+  "gitHead": "f6923aa9d989b25018f2fcac470963fb1e68049a",
   "exports": {
     "./package.json": "./package.json",
     ".": {

package/src/generators/init/schema.json

@@ -5,27 +5,32 @@
   "type": "object",
   "properties": {
     "project": {
-      "type": "string"
+      "type": "string",
+      "description": "The name of the project to initialize with n8n integration.",
+      "examples": ["my-n8n-lib"]
     },
     "projects": {
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "description": "The list of projects to initialize with n8n integration.",
+      "examples": [["my-n8n-lib", "another-n8n-lib"]]
     },
     "skipFormat": {
       "type": "boolean",
-      "default": false
+      "default": false,
+      "description": "Whether to skip formatting files with Prettier after initialization."
     },
     "overwrite": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to overwrite existing files"
+      "description": "Whether to overwrite existing files during initialization."
     },
     "skipProjects": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to skip executing project specific initialization"
+      "description": "Whether to skip executing project-specific initialization logic."
     }
   },
   "required": []

package/src/generators/node/schema.json

@@ -6,24 +6,28 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "",
+      "description": "The name of the new n8n node.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What name would you like to use?",
+      "examples": ["my-custom-node"]
     },
     "project": {
       "type": "string",
-      "description": ""
+      "description": "The name of the project where the new node should be created.",
+      "examples": ["my-n8n-lib"]
     },
     "description": {
       "type": "string",
-      "description": ""
+      "description": "A brief description of the new n8n node's purpose.",
+      "examples": ["Perform custom data transformation."]
     },
     "nodeNamePrefix": {
       "type": "string",
-      "description": ""
+      "description": "An optional prefix to prepend to the node's internal class name.",
+      "examples": ["MyCompany"]
     }
   },
   "required": ["name", "project"]

package/src/generators/trigger/schema.json

@@ -6,24 +6,28 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "",
+      "description": "The name of the new n8n trigger node.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What name would you like to use?",
+      "examples": ["my-custom-trigger"]
     },
     "project": {
       "type": "string",
-      "description": ""
+      "description": "The name of the project where the new trigger node should be created.",
+      "examples": ["my-n8n-lib"]
     },
     "description": {
       "type": "string",
-      "description": ""
+      "description": "A brief description of the new n8n trigger node's purpose.",
+      "examples": ["Trigger workflow on custom event."]
     },
     "nodeNamePrefix": {
       "type": "string",
-      "description": ""
+      "description": "An optional prefix to prepend to the trigger node's internal class name.",
+      "examples": ["MyCompany"]
     }
   },
   "required": ["name", "project"]