@rxap/plugin-nestjs 20.2.0-dev.10 → 20.2.0-dev.11

package/src/generators/health-indicator/schema.json

@@ -6,12 +6,13 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the health indicator class",
+      "description": "The name of the health indicator class.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What name would you like to use for the health indicator?"
+      "x-prompt": "What name would you like to use for the health indicator?",
+      "examples": ["MyService"]
     },
     "project": {
       "type": "string",
@@ -19,10 +20,13 @@
       "$default": {
         "$source": "projectName"
       },
-      "x-prompt": "For which project should the health indicator be added?"
+      "x-prompt": "For which project should the health indicator be added?",
+      "examples": ["my-api"]
     },
     "overwrite": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "Whether to overwrite existing files.",
+      "default": false
     }
   },
   "required": [

package/src/generators/health-indicator-init/schema.json

@@ -10,10 +10,13 @@
       "$default": {
         "$source": "projectName"
       },
-      "x-prompt": "For which project should the health indicator module be initialized?"
+      "x-prompt": "For which project should the health indicator module be initialized?",
+      "examples": ["my-api"]
     },
     "overwrite": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "Whether to overwrite existing files.",
+      "default": false
     }
   },
   "required": [

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 NestJS.",
+      "examples": ["my-api"]
     },
     "projects": {
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "description": "The list of projects to initialize with NestJS.",
+      "examples": [["my-api", "another-api"]]
     },
     "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/init-application/schema.json

@@ -5,44 +5,49 @@
   "type": "object",
   "properties": {
     "project": {
-      "type": "string"
+      "type": "string",
+      "description": "The name of the application project to initialize with NestJS.",
+      "examples": ["my-app"]
     },
     "projects": {
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "description": "The list of application projects to initialize with NestJS.",
+      "examples": [["my-app", "another-app"]]
     },
     "sentry": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service should use sentry",
+      "description": "Whether this application should use Sentry for error tracking.",
       "x-prompt": "Should this service use sentry?"
     },
     "skipFormat": {
       "type": "boolean",
-      "default": false
+      "default": false,
+      "description": "Whether to skip formatting files with Prettier after initialization."
     },
     "swagger": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service should use swagger",
+      "description": "Whether this application should support Swagger/OpenAPI documentation generation.",
       "x-prompt": "Should this service support open-api config generation?"
     },
     "swaggerLive": {
       "type": "boolean",
       "default": false,
-      "description": "Whether this service should start a swagger live server"
+      "description": "Whether this application should start a live Swagger server in development mode."
     },
     "generateMain": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the main file should be generated"
+      "description": "Whether to generate the 'main.ts' entry point file."
     },
     "healthIndicator": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service should use a health indicator",
+      "description": "Whether this application should include a health indicator endpoint.",
       "x-prompt": "Should this service have a health indicator endpoint?"
     },
     "healthIndicatorList": {
@@ -50,12 +55,13 @@
       "items": {
         "type": "string"
       },
-      "description": "A list of health indicators"
+      "description": "A list of specific health indicators to include.",
+      "examples": [["memory_heap", "memory_rss"]]
     },
     "validator": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service use the ValidationPipe",
+      "description": "Whether this application should use the NestJS 'ValidationPipe'.",
       "x-prompt": "Should this service use the ValidationPipe?"
     },
     "platform": {
@@ -65,67 +71,74 @@
         "fastify"
       ],
       "default": "express",
+      "description": "The underlying HTTP server platform to use.",
       "x-prompt": "Whichever platform should be used?"
     },
     "port": {
       "type": "number",
-      "description": "The default port where the server is listens"
+      "description": "The default port number for the application server.",
+      "examples": [3000]
     },
     "apiPrefix": {
       "oneOf": [
         {
           "type": "string",
-          "description": "The default global api prefix"
+          "description": "The default global API prefix."
         },
         {
-          "description": "Disable the global api prefix",
+          "description": "Disable the global API prefix.",
           "type": "boolean",
           "const": false
         }
-      ]
+      ],
+      "examples": ["api", false]
     },
     "pluginBuildInfoOptions": {
       "type": "object",
-      "additionalProperties": true
+      "additionalProperties": true,
+      "description": "Options for the build-info plugin."
     },
     "pluginDockerOptions": {
       "type": "object",
-      "additionalProperties": true
+      "additionalProperties": true,
+      "description": "Options for the Docker plugin."
     },
     "sentryDsn": {
       "type": "string",
-      "description": "Default sentry dsn"
+      "description": "The default Sentry DSN for error reporting.",
+      "examples": ["https://examplePublicKey@o0.ingest.sentry.io/0"]
     },
     "overwrite": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to overwrite existing files"
+      "description": "Whether to overwrite existing files during initialization."
     },
     "jwt": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the application should use jwt",
+      "description": "Whether the application should use JWT authentication.",
       "x-prompt": "Should this service use jwt?"
     },
     "openApi": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the application should use openApi as client",
+      "description": "Whether the application should use an OpenAPI client.",
       "x-prompt": "Should this service use an open api client?"
     },
     "skipProjects": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to skip executing project specific initialization"
+      "description": "Whether to skip executing project-specific initialization logic."
     },
     "apiConfigurationFile": {
       "type": "string",
-      "description": "The api configuration file to use"
+      "description": "The path to the API configuration file.",
+      "examples": ["apps/my-app/src/api-config.json"]
     },
     "standalone": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the nest service should be standalone",
+      "description": "Whether the NestJS application should be a standalone application.",
       "x-prompt": "Should this service be standalone?"
     },
     "typeorm": {
@@ -135,6 +148,7 @@
         "postgres"
       ],
       "default": "none",
+      "description": "The TypeORM database driver to use.",
       "x-prompt": "Which typeorm database should be used?"
     },
     "bootstrap": {
@@ -145,6 +159,7 @@
         "microservice"
       ],
       "default": "monolithic",
+      "description": "The type of application bootstrap to use.",
       "x-prompt": "Which bootstrap type should be used?"
     },
     "transport": {
@@ -154,18 +169,18 @@
         "rabbitmq"
       ],
       "default": "none",
-      "description": "The transport to use for microservices communication",
+      "description": "The transport mechanism to use for microservices communication.",
       "x-prompt": "Which transport should be used for microservices communication?"
     },
     "minio": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the application should use minio"
+      "description": "Whether the application should use Minio for object storage."
     },
     "openai": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the application should use openai"
+      "description": "Whether the application should use OpenAI integration."
     }
   },
   "required": []

package/src/generators/init-library/schema.json

@@ -5,38 +5,44 @@
   "type": "object",
   "properties": {
     "project": {
-      "type": "string"
+      "type": "string",
+      "description": "The name of the library project to initialize with NestJS.",
+      "examples": ["my-api-lib"]
     },
     "projects": {
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "description": "The list of library projects to initialize with NestJS.",
+      "examples": [["my-api-lib", "another-api-lib"]]
     },
     "overwrite": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to overwrite existing files"
+      "description": "Whether to overwrite existing files during initialization."
     },
     "skipFormat": {
       "type": "boolean",
-      "default": false
+      "default": false,
+      "description": "Whether to skip formatting files with Prettier after initialization."
     },
     "skipProjects": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to skip executing project specific initialization"
+      "description": "Whether to skip executing project-specific initialization logic."
     },
     "targets": {
       "type": "object",
+      "description": "Configuration for specific project targets.",
       "properties": {
         "fixDependencies": {
           "type": "boolean",
-          "description": "If set to false the target fix-dependencies will not be added to the project"
+          "description": "Whether to add the 'fix-dependencies' target to the library project."
         },
         "indexExport": {
           "type": "boolean",
-          "description": "If set to false the target index-export will not be added to the project"
+          "description": "Whether to add the 'index-export' target to the library project."
         }
       }
     }

package/src/generators/jwt/schema.json

@@ -6,10 +6,20 @@
   "properties": {
     "project": {
       "type": "string",
-      "description": ""
+      "description": "The name of the project to add JWT support to.",
+      "x-prompt": "Which project should be extended with JWT support?",
+      "examples": [
+        "my-api"
+      ]
     },
     "overwrite": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "Whether to overwrite existing files.",
+      "default": false,
+      "examples": [
+        true,
+        false
+      ]
     }
   },
   "required": [

package/src/generators/microservice/schema.json

@@ -6,29 +6,48 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of microservice",
-      "x-prompt": "Enter the name of the microservice?"
+      "description": "The name of the microservice.",
+      "x-prompt": "What is the name of the microservice?",
+      "examples": [
+        "order-service"
+      ]
     },
     "directory": {
       "type": "string",
-      "description": "The directory to create the microservice in"
+      "description": "The directory where the microservice will be created.",
+      "examples": [
+        "services"
+      ]
     },
 
     "sentry": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service should use sentry",
-      "x-prompt": "Should this service use sentry?"
+      "description": "Whether this microservice should use Sentry for error tracking.",
+      "x-prompt": "Should this microservice use Sentry?",
+      "examples": [
+        true,
+        false
+      ]
     },
     "skipFormat": {
       "type": "boolean",
-      "default": false
+      "default": false,
+      "description": "Whether to skip formatting the generated files.",
+      "examples": [
+        true,
+        false
+      ]
     },
     "swagger": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service should use swagger",
-      "x-prompt": "Should this service support open-api config generation?"
+      "description": "Whether this microservice should use Swagger/OpenAPI for documentation.",
+      "x-prompt": "Should this microservice support OpenAPI configuration generation?",
+      "examples": [
+        true,
+        false
+      ]
     },
     "swaggerLive": {
       "type": "boolean",
@@ -37,26 +56,45 @@
     },
     "generateMain": {
       "type": "boolean",
-      "description": "Whether the main file should be generated"
+      "description": "Whether the main entry point file (`main.ts`) should be generated.",
+      "default": true,
+      "examples": [
+        true,
+        false
+      ]
     },
     "healthIndicator": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service should use a health indicator",
-      "x-prompt": "Should this service have a health indicator endpoint?"
+      "description": "Whether this microservice should include a health indicator endpoint.",
+      "x-prompt": "Should this microservice have a health indicator endpoint?",
+      "examples": [
+        true,
+        false
+      ]
     },
     "healthIndicatorList": {
       "type": "array",
       "items": {
         "type": "string"
       },
-      "description": "A list of health indicators"
+      "description": "A list of additional health indicators to include.",
+      "examples": [
+        [
+          "database",
+          "redis"
+        ]
+      ]
     },
     "validator": {
       "type": "boolean",
       "default": true,
-      "description": "Whether this service use the ValidationPipe",
-      "x-prompt": "Should this service use the ValidationPipe?"
+      "description": "Whether this microservice should use the NestJS `ValidationPipe`.",
+      "x-prompt": "Should this microservice use the `ValidationPipe`?",
+      "examples": [
+        true,
+        false
+      ]
     },
     "platform": {
       "type": "string",
@@ -65,55 +103,91 @@
         "fastify"
       ],
       "default": "express",
-      "x-prompt": "Whichever platform should be used?"
+      "x-prompt": "Which platform should be used (Express or Fastify)?",
+      "examples": [
+        "express",
+        "fastify"
+      ]
     },
     "port": {
       "type": "number",
-      "description": "The default port where the server is listens"
+      "description": "The default port number where the server will listen.",
+      "examples": [
+        3000,
+        8080
+      ]
     },
     "apiPrefix": {
       "oneOf": [
         {
           "type": "string",
-          "description": "The default global api prefix"
+          "description": "The default global API prefix.",
+          "examples": [
+            "api"
+          ]
         },
         {
-          "description": "Disable the global api prefix",
+          "description": "Disable the global API prefix.",
           "type": "boolean",
-          "const": false
+          "const": false,
+          "examples": [
+            false
+          ]
         }
       ]
     },
     "sentryDsn": {
       "type": "string",
-      "description": "Default sentry dsn"
+      "description": "The default Sentry DSN for error tracking.",
+      "examples": [
+        "https://examplePublicKey@o0.ingest.sentry.io/0"
+      ]
     },
     "overwrite": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to overwrite existing files"
+      "description": "Whether to overwrite existing files, if any.",
+      "examples": [
+        true,
+        false
+      ]
     },
     "jwt": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the application should use jwt",
-      "x-prompt": "Should this service use jwt?"
+      "description": "Whether the microservice should use JWT for authentication.",
+      "x-prompt": "Should this microservice use JWT?",
+      "examples": [
+        true,
+        false
+      ]
     },
     "openApi": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the application should use openApi as client",
-      "x-prompt": "Should this service use an open api client?"
+      "description": "Whether the microservice should use an OpenAPI client.",
+      "x-prompt": "Should this microservice use an OpenAPI client?",
+      "examples": [
+        true,
+        false
+      ]
     },
     "apiConfigurationFile": {
       "type": "string",
-      "description": "The api configuration file to use"
+      "description": "The path to the API configuration file.",
+      "examples": [
+        "apps/my-api/src/assets/api-config.json"
+      ]
     },
     "standalone": {
       "type": "boolean",
       "default": false,
-      "description": "Whether the nest service should be standalone",
-      "x-prompt": "Should this service be standalone?"
+      "description": "Whether the NestJS service should be standalone (without a module).",
+      "x-prompt": "Should this microservice be standalone?",
+      "examples": [
+        true,
+        false
+      ]
     }
   },
   "required": [

package/src/generators/open-api/schema.json

@@ -6,10 +6,20 @@
   "properties": {
     "project": {
       "type": "string",
-      "description": ""
+      "description": "The name of the project to add OpenApi support to.",
+      "x-prompt": "Which project should be extended with OpenApi support?",
+      "examples": [
+        "my-api"
+      ]
     },
     "overwrite": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "Whether to overwrite existing files.",
+      "default": false,
+      "examples": [
+        true,
+        false
+      ]
     }
   },
   "required": [

package/src/generators/sentry/schema.json

@@ -10,20 +10,35 @@
       "$default": {
         "$source": "projectName"
       },
-      "x-prompt": "Which project should be extend with sentry support?"
+      "x-prompt": "Which project should be extended with sentry support?",
+      "examples": [
+        "my-app"
+      ]
     },
     "dsn": {
       "type": "string",
-      "description": "Default sentry dsn"
+      "description": "The default Sentry DSN.",
+      "examples": [
+        "https://examplePublicKey@o0.ingest.sentry.io/0"
+      ]
     },
     "required": {
       "type": "boolean",
-      "description": "Whether or not the sentry dsn should be required to start the application"
+      "description": "Whether or not the Sentry DSN should be required to start the application.",
+      "default": false,
+      "examples": [
+        true,
+        false
+      ]
     },
     "overwrite": {
       "type": "boolean",
       "default": false,
-      "description": "Whether to overwrite existing files"
+      "description": "Whether to overwrite existing files.",
+      "examples": [
+        true,
+        false
+      ]
     }
   },
   "required": [