miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(misc): add x-priority tags to next, react, webpack, rollup, esbuild (#14352)

Browse Source
This commit is contained in:
Jack Hsu 2023-01-13 11:50:01 -05:00 committed by GitHub
parent 9e07cf4146
commit d20cf91e6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
64 changed files with 499 additions and 256 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/generated/packages/esbuild/executors/esbuild.json
View File

@ -14,12 +14,14 @@
"description": "The path to the entry file, relative to project.",
"alias": "entryFile",
"x-completion-type": "file",
"x-completion-glob": "**/*@(.js|.ts)"
"x-completion-glob": "**/*@(.js|.ts)",
"x-priority": "important"
},
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"outputFileName": {
"type": "string",
@ -29,11 +31,8 @@
"type": "string",
"description": "The path to tsconfig file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
},
"project": {
"type": "string",
"description": "The path to package.json file."
"x-completion-glob": "tsconfig.*.json",
"x-priority": "important"
},
"additionalEntryPoints": {
"type": "array",
@ -139,7 +138,8 @@
"skipTypeCheck": {
"type": "boolean",
"description": "Skip type-checking via TypeScript. Skipping type-checking speeds up the build but type errors are not caught.",
"default": false
"default": false,
"x-priority": "internal"
},
"thirdParty": {
"type": "boolean",
@ -155,7 +155,8 @@
"esbuildOptions": {
"type": "object",
"description": "Additional options to pass to esbuild. See https://esbuild.github.io/api/.",
"additionalProperties": true
"additionalProperties": true,
"x-priority": "important"
}
},
"required": ["tsConfig", "main", "outputPath"],

18
docs/generated/packages/esbuild/generators/esbuild-project.json
View File

@ -14,31 +14,37 @@
"description": "The name of the project.",
"$default": { "$source": "argv", "index": 0 },
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a esbuild for?"
"x-prompt": "What is the name of the project to set up a esbuild for?",
"x-priority": "important"
},
"main": {
"type": "string",
"description": "Path relative to the workspace root for the main entry file. Defaults to `<project-root>/src/main.ts` or `<project-root>src/index.ts`, whichever is found.",
"alias": "entryFile"
"alias": "entryFile",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to `<project-root>/tsconfig.app.json` or `<project-root>/tsconfig.lib.json`, whichever is found."
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to `<project-root>/tsconfig.app.json` or `<project-root>/tsconfig.lib.json`, whichever is found.",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Do not perform any validation on existing project."
"description": "Do not perform any validation on existing project.",
"x-priority": "internal"
},
"importPath": {
"type": "string",

15
docs/generated/packages/next/executors/build.json
View File

@ -10,11 +10,16 @@
"description": "Build a Next.js app.",
"type": "object",
"properties": {
"root": { "description": "The source root", "type": "string" },
"root": {
"description": "The source root",
"type": "string",
"x-priority": "important"
},
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"fileReplacements": {
"description": "Replace files with other files in the build.",
@ -42,7 +47,8 @@
"description": "Path (relative to workspace root) to a function which takes phase, config, and builder options, and returns the resulting config. This is an advanced option and should not be used with a normal Next.js config file (i.e. `next.config.js`).",
"type": "string",
"x-completion-type": "file",
"x-completion-glob": "next?(*).js"
"x-completion-glob": "next?(*).js",
"x-priority": "important"
},
"buildLibsFromSource": {
"type": "boolean",
@ -57,7 +63,8 @@
"generateLockfile": {
"type": "boolean",
"description": "Generate a lockfile (e.g. yarn.lock) that matches the workspace lockfile to ensure package versions match.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["root", "outputPath"],

3
docs/generated/packages/next/executors/export.json
View File

@ -11,7 +11,8 @@
"properties": {
"buildTarget": {
"type": "string",
"description": "Target which builds the application"
"description": "Target which builds the application",
"x-priority": "important"
},
"silent": {
"type": "boolean",

6
docs/generated/packages/next/executors/server.json
View File

@ -16,12 +16,14 @@
},
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
"description": "Target which builds the application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"staticMarkup": {
"type": "boolean",

12
docs/generated/packages/next/generators/application.json
View File

@ -14,12 +14,14 @@
"type": "string",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "d"
"alias": "d",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -71,12 +73,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipWorkspaceJson": {
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. `babel`, `style`).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",

12
docs/generated/packages/next/generators/component.json
View File

@ -14,13 +14,15 @@
"description": "The name of the project.",
"alias": "p",
"$default": { "$source": "projectName" },
"x-prompt": "What is the name of the project for this component?"
"x-prompt": "What is the name of the project for this component?",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the component.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the component?"
"x-prompt": "What name would you like to use for the component?",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -62,12 +64,14 @@
"skipTests": {
"type": "boolean",
"description": "When true, does not create `spec.ts` test files for the new component.",
"default": false
"default": false,
"x-priority": "internal"
},
"directory": {
"type": "string",
"description": "Create the component under this directory (can be nested).",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"export": {
"type": "boolean",

3
docs/generated/packages/next/generators/custom-server.json
View File

@ -15,7 +15,8 @@
"alias": "p",
"$default": { "$source": "argv", "index": 0 },
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a custom server for?"
"x-prompt": "What is the name of the project to set up a custom server for?",
"x-priority": "important"
},
"compiler": {
"type": "string",

6
docs/generated/packages/next/generators/library.json
View File

@ -14,12 +14,14 @@
"description": "Library name",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the library?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "A directory where the lib is placed.",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",

12
docs/generated/packages/next/generators/page.json
View File

@ -14,18 +14,21 @@
"description": "The name of the project.",
"alias": "p",
"$default": { "$source": "projectName" },
"x-prompt": "What is the name of the project for this component?"
"x-prompt": "What is the name of the project for this component?",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the component.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the component?"
"x-prompt": "What name would you like to use for the component?",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "Create the page under this directory (can be nested). Will be created under `pages/`.",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -63,7 +66,8 @@
},
{ "value": "none", "label": "None" }
]
}
},
"x-priority": "important"
},
"withTests": {
"type": "boolean",

15
docs/generated/packages/react/executors/module-federation-dev-server.json
View File

@ -12,21 +12,25 @@
"devRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of remote applications to run in development mode (i.e. using serve target)."
"description": "List of remote applications to run in development mode (i.e. using serve target).",
"x-priority": "important"
},
"skipRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository."
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository.",
"x-priority": "important"
},
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
"description": "Target which builds the application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"host": {
"type": "string",
@ -68,7 +72,8 @@
"open": {
"type": "boolean",
"description": "Open the application in the browser.",
"default": false
"default": false,
"x-priority": "important"
},
"allowedHosts": {
"type": "string",

15
docs/generated/packages/react/executors/module-federation-ssr-dev-server.json
View File

@ -11,26 +11,31 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target which builds the browser application."
"description": "Target which builds the browser application.",
"x-priority": "important"
},
"serverTarget": {
"type": "string",
"description": "Target which builds the server application."
"description": "Target which builds the server application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "The port to be set on `process.env.PORT` for use in the server.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"devRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of remote applications to run in development mode (i.e. using serve target)."
"description": "List of remote applications to run in development mode (i.e. using serve target).",
"x-priority": "important"
},
"skipRemotes": {
"type": "array",
"items": { "type": "string" },
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository."
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository.",
"x-priority": "important"
},
"host": {
"type": "string",

18
docs/generated/packages/react/generators/application.json
View File

@ -28,12 +28,14 @@
"type": "string",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -88,12 +90,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "hidden"
},
"skipWorkspaceJson": {
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "hidden"
},
"unitTestRunner": {
"type": "string",
@ -162,7 +166,8 @@
"skipPackageJson": {
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "hidden"
},
"rootProject": {
"description": "Create a application at the root of the workspace",
@ -175,7 +180,8 @@
"type": "string",
"enum": ["vite", "webpack"],
"x-prompt": "Which bundler do you want to use to build the application?",
"default": "webpack"
"default": "webpack",
"x-priority": "important"
},
"minimal": {
"description": "Generate a React app with a minimal setup, no separate test files.",

6
docs/generated/packages/react/generators/component-cypress-spec.json
View File

@ -14,13 +14,15 @@
"description": "The project name for which to generate tests.",
"examples": ["shared-ui-component"],
"$default": { "$source": "projectName", "index": 0 },
"x-prompt": "What's name of the project for which to generate tests?"
"x-prompt": "What's name of the project for which to generate tests?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the library root?",
"examples": ["lib/components"],
"x-prompt": "What's path of the component relative to the project's lib root for which to generate a test?"
"x-prompt": "What's path of the component relative to the project's lib root for which to generate a test?",
"x-priority": "important"
},
"js": {
"type": "boolean",

6
docs/generated/packages/react/generators/component-story.json
View File

@ -15,13 +15,15 @@
"description": "The project where to add the components.",
"examples": ["shared-ui-component"],
"$default": { "$source": "projectName", "index": 0 },
"x-prompt": "What's name of the project where the component lives?"
"x-prompt": "What's name of the project where the component lives?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the library root.",
"examples": ["lib/components"],
"x-prompt": "What's path of the component relative to the project's lib root?"
"x-prompt": "What's path of the component relative to the project's lib root?",
"x-priority": "important"
}
},
"required": ["project", "componentPath"],

6
docs/generated/packages/react/generators/component-test.json
View File

@ -19,12 +19,14 @@
"type": "string",
"description": "The name of the project the component is apart of",
"x-dropdown": "projects",
"x-prompt": "What project is this component apart of?"
"x-prompt": "What project is this component apart of?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Path to component, from the project source root",
"x-prompt": "What is the path to the component?"
"x-prompt": "What is the path to the component?",
"x-priority": "important"
}
},
"required": ["project", "componentPath"],

12
docs/generated/packages/react/generators/component.json
View File

@ -24,13 +24,15 @@
"description": "The name of the project.",
"alias": "p",
"$default": { "$source": "projectName" },
"x-prompt": "What is the name of the project for this component?"
"x-prompt": "What is the name of the project for this component?",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the component.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the component?"
"x-prompt": "What name would you like to use for the component?",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -78,12 +80,14 @@
"skipTests": {
"type": "boolean",
"description": "When true, does not create `spec.ts` test files for the new component.",
"default": false
"default": false,
"x-priority": "internal"
},
"directory": {
"type": "string",
"description": "Create the component under this directory (can be nested).",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"flat": {
"type": "boolean",

12
docs/generated/packages/react/generators/cypress-component-configuration.json
View File

@ -23,13 +23,15 @@
"type": "string",
"description": "The name of the project to add cypress component testing configuration to",
"x-dropdown": "projects",
"x-prompt": "What project should we add Cypress component testing to?"
"x-prompt": "What project should we add Cypress component testing to?",
"x-priority": "important"
},
"generateTests": {
"type": "boolean",
"description": "Generate default component tests for existing components in the project",
"x-prompt": "Automatically generate tests for components declared in this project?",
"default": false
"default": false,
"x-priority": "important"
},
"buildTarget": {
"type": "string",
@ -39,13 +41,15 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files",
"default": false
"default": false,
"x-priority": "internal"
},
"bundler": {
"description": "The bundler to use for Cypress Component Testing.",
"type": "string",
"enum": ["vite", "webpack"],
"hidden": true
"hidden": true,
"x-priority": "internal"
}
},
"required": ["project"],

12
docs/generated/packages/react/generators/hook.json
View File

@ -20,13 +20,15 @@
"description": "The name of the project.",
"alias": "p",
"$default": { "$source": "projectName" },
"x-prompt": "What is the name of the project for this hook?"
"x-prompt": "What is the name of the project for this hook?",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the hook.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the hook?"
"x-prompt": "What name would you like to use for the hook?",
"x-priority": "important"
},
"js": {
"type": "boolean",
@ -36,11 +38,13 @@
"skipTests": {
"type": "boolean",
"description": "When true, does not create `spec.ts` test files for the new hook.",
"default": false
"default": false,
"x-priority": "internal"
},
"directory": {
"type": "string",
"description": "Create the hook under this directory (can be nested)."
"description": "Create the hook under this directory (can be nested).",
"x-priority": "important"
},
"flat": {
"type": "boolean",

18
docs/generated/packages/react/generators/host.json
View File

@ -14,12 +14,14 @@
"description": "The name of the host application to generate the Module Federation configuration",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use as the host application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -68,12 +70,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipWorkspaceJson": {
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -137,12 +141,14 @@
"remotes": {
"type": "array",
"description": "A list of remote application names that the host application should consume.",
"default": []
"default": [],
"x-priority": "important"
},
"devServerPort": {
"type": "number",
"description": "The port for the dev server of the remote app.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"ssr": {
"description": "Whether to configure SSR for the host application",

18
docs/generated/packages/react/generators/library.json
View File

@ -24,12 +24,14 @@
"description": "Library name",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the library?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "A directory where the lib is placed.",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -93,12 +95,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipTsConfig": {
"type": "boolean",
"default": false,
"description": "Do not update `tsconfig.json` for development experience."
"description": "Do not update `tsconfig.json` for development experience.",
"x-priority": "internal"
},
"pascalCaseFiles": {
"type": "boolean",
@ -163,7 +167,8 @@
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": ["none", "vite", "rollup"],
"default": "none",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup.",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -174,7 +179,8 @@
"skipPackageJson": {
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"minimal": {
"description": "Create a React library with a minimal setup, no separate test files.",

9
docs/generated/packages/react/generators/redux.json
View File

@ -12,20 +12,23 @@
"name": {
"type": "string",
"description": "Redux slice name.",
"$default": { "$source": "argv", "index": 0 }
"$default": { "$source": "argv", "index": 0 },
"x-priority": "important"
},
"project": {
"type": "string",
"description": "The name of the project to add the slice to. If it is an application, then the store configuration will be updated too.",
"alias": "p",
"$default": { "$source": "projectName" },
"x-prompt": "What is the name of the project for this slice?"
"x-prompt": "What is the name of the project for this slice?",
"x-priority": "important"
},
"directory": {
"type": "string",
"alias": "dir",
"default": "",
"description": "The name of the folder used to contain/group the generated Redux files."
"description": "The name of the folder used to contain/group the generated Redux files.",
"x-priority": "important"
},
"appProject": {
"type": "string",

18
docs/generated/packages/react/generators/remote.json
View File

@ -14,12 +14,14 @@
"description": "The name of the remote application to generate the Module Federation configuration",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use as the remote application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -73,12 +75,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipWorkspaceJson": {
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -141,12 +145,14 @@
},
"host": {
"type": "string",
"description": "The host / shell application for this remote."
"description": "The host / shell application for this remote.",
"x-priority": "important"
},
"devServerPort": {
"type": "number",
"description": "The port for the dev server of the remote app.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"ssr": {
"description": "Whether to configure SSR for the host application",

9
docs/generated/packages/react/generators/setup-ssr.json
View File

@ -14,7 +14,8 @@
"description": "The name of the application to add SSR support to.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What app would you like to add SSR support to?",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"appComponentImportPath": {
"type": "string",
@ -24,11 +25,13 @@
"serverPort": {
"type": "number",
"default": 4200,
"description": "The port for the Express server."
"description": "The port for the Express server.",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"extraInclude": {
"type": "array",

12
docs/generated/packages/react/generators/setup-tailwind.json
View File

@ -21,21 +21,25 @@
"alias": "p",
"$default": { "$source": "argv", "index": 0 },
"x-dropdown": "projects",
"x-prompt": "What project would you like to add the Tailwind CSS setup?"
"x-prompt": "What project would you like to add the Tailwind CSS setup?",
"x-priority": "important"
},
"buildTarget": {
"type": "string",
"description": "The name of the target used to build the project. This option is not needed in most cases.",
"default": "build"
"default": "build",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skips formatting the workspace after the generator completes."
"description": "Skips formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

6
docs/generated/packages/react/generators/stories.json
View File

@ -14,12 +14,14 @@
"aliases": ["name", "projectName"],
"description": "Project for which to generate stories.",
"$default": { "$source": "projectName", "index": 0 },
"x-prompt": "For which project do you want to generate stories?"
"x-prompt": "For which project do you want to generate stories?",
"x-priority": "important"
},
"generateCypressSpecs": {
"type": "boolean",
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"x-prompt": "Do you want to generate Cypress specs as well?"
"x-prompt": "Do you want to generate Cypress specs as well?",
"x-priority": "important"
},
"cypressProject": {
"type": "string",

12
docs/generated/packages/rollup/executors/rollup.json
View File

@ -11,19 +11,22 @@
"properties": {
"project": {
"type": "string",
"description": "The path to package.json file."
"description": "The path to package.json file.",
"x-priority": "important"
},
"main": {
"type": "string",
"description": "The path to the entry file, relative to project.",
"alias": "entryFile",
"x-completion-type": "file",
"x-completion-glob": "**/*@(.js|.ts)"
"x-completion-glob": "**/*@(.js|.ts)",
"x-priority": "important"
},
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"outputFileName": {
"type": "string",
@ -38,7 +41,8 @@
"type": "string",
"description": "The path to tsconfig file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
"x-completion-glob": "tsconfig.*.json",
"x-priority": "important"
},
"format": {
"type": "array",

18
docs/generated/packages/rollup/generators/rollup-project.json
View File

@ -14,7 +14,8 @@
"description": "The name of the project.",
"$default": { "$source": "argv", "index": 0 },
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a rollup for?"
"x-prompt": "What is the name of the project to set up a rollup for?",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -25,26 +26,31 @@
"main": {
"type": "string",
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'.",
"alias": "entryFile"
"alias": "entryFile",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'."
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Do not perform any validation on existing project."
"description": "Do not perform any validation on existing project.",
"x-priority": "internal"
},
"importPath": {
"type": "string",

9
docs/generated/packages/webpack/executors/dev-server.json
View File

@ -11,12 +11,14 @@
"properties": {
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
"description": "Target which builds the application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"host": {
"type": "string",
@ -58,7 +60,8 @@
"open": {
"type": "boolean",
"description": "Open the application in the browser.",
"default": false
"default": false,
"x-priority": "important"
},
"allowedHosts": {
"type": "string",

9
docs/generated/packages/webpack/executors/ssr-dev-server.json
View File

@ -11,16 +11,19 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target which builds the browser application."
"description": "Target which builds the browser application.",
"x-priority": "important"
},
"serverTarget": {
"type": "string",
"description": "Target which builds the server application."
"description": "Target which builds the server application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "The port to be set on `process.env.PORT` for use in the server.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"browserTargetOptions": {
"type": "object",

12
docs/generated/packages/webpack/executors/webpack.json
View File

@ -17,13 +17,15 @@
"type": "string",
"description": "The name of the main entry-point file.",
"x-completion-type": "file",
"x-completion-glob": "**/*@(.js|.ts|.tsx)"
"x-completion-glob": "**/*@(.js|.ts|.tsx)",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "The name of the Typescript configuration file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
"x-completion-glob": "tsconfig.*.json",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -34,7 +36,8 @@
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"target": {
"type": "string",
@ -378,7 +381,8 @@
"type": "string",
"description": "Path to a function which takes a webpack config, some context and returns the resulting webpack config. See https://nx.dev/guides/customize-webpack",
"x-completion-type": "file",
"x-completion-glob": "webpack?(*)@(.js|.ts)"
"x-completion-glob": "webpack?(*)@(.js|.ts)",
"x-priority": "important"
}
},
"required": ["tsConfig", "main"],

21
docs/generated/packages/webpack/generators/webpack-project.json
View File

@ -14,7 +14,8 @@
"description": "The name of the project.",
"$default": { "$source": "argv", "index": 0 },
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a webpack for?"
"x-prompt": "What is the name of the project to set up a webpack for?",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -24,11 +25,13 @@
},
"main": {
"type": "string",
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'."
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'.",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'."
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
"x-priority": "important"
},
"target": {
"type": "string",
@ -39,17 +42,20 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Do not perform any validation on existing project."
"description": "Do not perform any validation on existing project.",
"x-priority": "internal"
},
"devServer": {
"type": "boolean",
@ -58,7 +64,8 @@
},
"webpackConfig": {
"type": "string",
"description": "Path relative to workspace root to a custom webpack file that takes a config object and returns an updated config."
"description": "Path relative to workspace root to a custom webpack file that takes a config object and returns an updated config.",
"x-priority": "internal"
}
},
"required": [],

19
packages/esbuild/src/executors/esbuild/schema.json
View File

@ -11,12 +11,14 @@
"description": "The path to the entry file, relative to project.",
"alias": "entryFile",
"x-completion-type": "file",
"x-completion-glob": "**/*@(.js|.ts)"
"x-completion-glob": "**/*@(.js|.ts)",
"x-priority": "important"
},
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"outputFileName": {
"type": "string",
@ -26,11 +28,8 @@
"type": "string",
"description": "The path to tsconfig file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
},
"project": {
"type": "string",
"description": "The path to package.json file."
"x-completion-glob": "tsconfig.*.json",
"x-priority": "important"
},
"additionalEntryPoints": {
"type": "array",
@ -117,7 +116,8 @@
"skipTypeCheck": {
"type": "boolean",
"description": "Skip type-checking via TypeScript. Skipping type-checking speeds up the build but type errors are not caught.",
"default": false
"default": false,
"x-priority": "internal"
},
"thirdParty": {
"type": "boolean",
@ -133,7 +133,8 @@
"esbuildOptions": {
"type": "object",
"description": "Additional options to pass to esbuild. See https://esbuild.github.io/api/.",
"additionalProperties": true
"additionalProperties": true,
"x-priority": "important"
}
},
"required": ["tsConfig", "main", "outputPath"],

18
packages/esbuild/src/generators/esbuild-project/schema.json
View File

@ -14,31 +14,37 @@
"index": 0
},
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a esbuild for?"
"x-prompt": "What is the name of the project to set up a esbuild for?",
"x-priority": "important"
},
"main": {
"type": "string",
"description": "Path relative to the workspace root for the main entry file. Defaults to `<project-root>/src/main.ts` or `<project-root>src/index.ts`, whichever is found.",
"alias": "entryFile"
"alias": "entryFile",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to `<project-root>/tsconfig.app.json` or `<project-root>/tsconfig.lib.json`, whichever is found."
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to `<project-root>/tsconfig.app.json` or `<project-root>/tsconfig.lib.json`, whichever is found.",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Do not perform any validation on existing project."
"description": "Do not perform any validation on existing project.",
"x-priority": "internal"
},
"importPath": {
"type": "string",

12
packages/next/src/executors/build/schema.json
View File

@ -9,12 +9,14 @@
"properties": {
"root": {
"description": "The source root",
"type": "string"
"type": "string",
"x-priority": "important"
},
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"fileReplacements": {
"description": "Replace files with other files in the build.",
@ -42,7 +44,8 @@
"description": "Path (relative to workspace root) to a function which takes phase, config, and builder options, and returns the resulting config. This is an advanced option and should not be used with a normal Next.js config file (i.e. `next.config.js`).",
"type": "string",
"x-completion-type": "file",
"x-completion-glob": "next?(*).js"
"x-completion-glob": "next?(*).js",
"x-priority": "important"
},
"buildLibsFromSource": {
"type": "boolean",
@ -57,7 +60,8 @@
"generateLockfile": {
"type": "boolean",
"description": "Generate a lockfile (e.g. yarn.lock) that matches the workspace lockfile to ensure package versions match.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["root", "outputPath"]

3
packages/next/src/executors/export/schema.json
View File

@ -8,7 +8,8 @@
"properties": {
"buildTarget": {
"type": "string",
"description": "Target which builds the application"
"description": "Target which builds the application",
"x-priority": "important"
},
"silent": {
"type": "boolean",

6
packages/next/src/executors/server/schema.json
View File

@ -13,12 +13,14 @@
},
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
"description": "Target which builds the application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"staticMarkup": {
"type": "boolean",

12
packages/next/src/generators/application/schema.json
View File

@ -14,12 +14,14 @@
"index": 0
},
"x-prompt": "What name would you like to use for the application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "d"
"alias": "d",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -71,12 +73,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipWorkspaceJson": {
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. `babel`, `style`).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",

12
packages/next/src/generators/component/schema.json
View File

@ -13,7 +13,8 @@
"$default": {
"$source": "projectName"
},
"x-prompt": "What is the name of the project for this component?"
"x-prompt": "What is the name of the project for this component?",
"x-priority": "important"
},
"name": {
"type": "string",
@ -22,7 +23,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the component?"
"x-prompt": "What name would you like to use for the component?",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -64,12 +66,14 @@
"skipTests": {
"type": "boolean",
"description": "When true, does not create `spec.ts` test files for the new component.",
"default": false
"default": false,
"x-priority": "internal"
},
"directory": {
"type": "string",
"description": "Create the component under this directory (can be nested).",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"export": {
"type": "boolean",

3
packages/next/src/generators/custom-server/schema.json
View File

@ -15,7 +15,8 @@
"index": 0
},
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a custom server for?"
"x-prompt": "What is the name of the project to set up a custom server for?",
"x-priority": "important"
},
"compiler": {
"type": "string",

6
packages/next/src/generators/library/schema.json
View File

@ -14,12 +14,14 @@
"index": 0
},
"x-prompt": "What name would you like to use for the library?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "A directory where the lib is placed.",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",

12
packages/next/src/generators/page/schema.json
View File

@ -13,7 +13,8 @@
"$default": {
"$source": "projectName"
},
"x-prompt": "What is the name of the project for this component?"
"x-prompt": "What is the name of the project for this component?",
"x-priority": "important"
},
"name": {
"type": "string",
@ -22,12 +23,14 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the component?"
"x-prompt": "What name would you like to use for the component?",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "Create the page under this directory (can be nested). Will be created under `pages/`.",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -68,7 +71,8 @@
"label": "None"
}
]
}
},
"x-priority": "important"
},
"withTests": {
"type": "boolean",

15
packages/react/src/executors/module-federation-dev-server/schema.json
View File

@ -11,23 +11,27 @@
"items": {
"type": "string"
},
"description": "List of remote applications to run in development mode (i.e. using serve target)."
"description": "List of remote applications to run in development mode (i.e. using serve target).",
"x-priority": "important"
},
"skipRemotes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository."
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository.",
"x-priority": "important"
},
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
"description": "Target which builds the application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"host": {
"type": "string",
@ -69,7 +73,8 @@
"open": {
"type": "boolean",
"description": "Open the application in the browser.",
"default": false
"default": false,
"x-priority": "important"
},
"allowedHosts": {
"type": "string",

15
packages/react/src/executors/module-federation-ssr-dev-server/schema.json
View File

@ -8,30 +8,35 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target which builds the browser application."
"description": "Target which builds the browser application.",
"x-priority": "important"
},
"serverTarget": {
"type": "string",
"description": "Target which builds the server application."
"description": "Target which builds the server application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "The port to be set on `process.env.PORT` for use in the server.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"devRemotes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of remote applications to run in development mode (i.e. using serve target)."
"description": "List of remote applications to run in development mode (i.e. using serve target).",
"x-priority": "important"
},
"skipRemotes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository."
"description": "List of remote applications to not automatically serve, either statically or in development mode. This can be useful for multi-repository module federation setups where the host application uses a remote application from an external repository.",
"x-priority": "important"
},
"host": {
"type": "string",

18
packages/react/src/generators/application/schema.json
View File

@ -28,12 +28,14 @@
"index": 0
},
"x-prompt": "What name would you like to use for the application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -94,12 +96,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "hidden"
},
"skipWorkspaceJson": {
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "hidden"
},
"unitTestRunner": {
"type": "string",
@ -168,7 +172,8 @@
"skipPackageJson": {
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "hidden"
},
"rootProject": {
"description": "Create a application at the root of the workspace",
@ -181,7 +186,8 @@
"type": "string",
"enum": ["vite", "webpack"],
"x-prompt": "Which bundler do you want to use to build the application?",
"default": "webpack"
"default": "webpack",
"x-priority": "important"
},
"minimal": {
"description": "Generate a React app with a minimal setup, no separate test files.",

6
packages/react/src/generators/component-cypress-spec/schema.json
View File

@ -14,13 +14,15 @@
"$source": "projectName",
"index": 0
},
"x-prompt": "What's name of the project for which to generate tests?"
"x-prompt": "What's name of the project for which to generate tests?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the library root?",
"examples": ["lib/components"],
"x-prompt": "What's path of the component relative to the project's lib root for which to generate a test?"
"x-prompt": "What's path of the component relative to the project's lib root for which to generate a test?",
"x-priority": "important"
},
"js": {
"type": "boolean",

6
packages/react/src/generators/component-story/schema.json
View File

@ -15,13 +15,15 @@
"$source": "projectName",
"index": 0
},
"x-prompt": "What's name of the project where the component lives?"
"x-prompt": "What's name of the project where the component lives?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the library root.",
"examples": ["lib/components"],
"x-prompt": "What's path of the component relative to the project's lib root?"
"x-prompt": "What's path of the component relative to the project's lib root?",
"x-priority": "important"
}
},
"required": ["project", "componentPath"]

6
packages/react/src/generators/component-test/schema.json
View File

@ -16,12 +16,14 @@
"type": "string",
"description": "The name of the project the component is apart of",
"x-dropdown": "projects",
"x-prompt": "What project is this component apart of?"
"x-prompt": "What project is this component apart of?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Path to component, from the project source root",
"x-prompt": "What is the path to the component?"
"x-prompt": "What is the path to the component?",
"x-priority": "important"
}
},
"required": ["project", "componentPath"],

12
packages/react/src/generators/component/schema.json
View File

@ -23,7 +23,8 @@
"$default": {
"$source": "projectName"
},
"x-prompt": "What is the name of the project for this component?"
"x-prompt": "What is the name of the project for this component?",
"x-priority": "important"
},
"name": {
"type": "string",
@ -32,7 +33,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the component?"
"x-prompt": "What name would you like to use for the component?",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -83,12 +85,14 @@
"skipTests": {
"type": "boolean",
"description": "When true, does not create `spec.ts` test files for the new component.",
"default": false
"default": false,
"x-priority": "internal"
},
"directory": {
"type": "string",
"description": "Create the component under this directory (can be nested).",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"flat": {
"type": "boolean",

12
packages/react/src/generators/cypress-component-configuration/schema.json
View File

@ -20,13 +20,15 @@
"type": "string",
"description": "The name of the project to add cypress component testing configuration to",
"x-dropdown": "projects",
"x-prompt": "What project should we add Cypress component testing to?"
"x-prompt": "What project should we add Cypress component testing to?",
"x-priority": "important"
},
"generateTests": {
"type": "boolean",
"description": "Generate default component tests for existing components in the project",
"x-prompt": "Automatically generate tests for components declared in this project?",
"default": false
"default": false,
"x-priority": "important"
},
"buildTarget": {
"type": "string",
@ -36,13 +38,15 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files",
"default": false
"default": false,
"x-priority": "internal"
},
"bundler": {
"description": "The bundler to use for Cypress Component Testing.",
"type": "string",
"enum": ["vite", "webpack"],
"hidden": true
"hidden": true,
"x-priority": "internal"
}
},
"required": ["project"],

12
packages/react/src/generators/hook/schema.json
View File

@ -19,7 +19,8 @@
"$default": {
"$source": "projectName"
},
"x-prompt": "What is the name of the project for this hook?"
"x-prompt": "What is the name of the project for this hook?",
"x-priority": "important"
},
"name": {
"type": "string",
@ -28,7 +29,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the hook?"
"x-prompt": "What name would you like to use for the hook?",
"x-priority": "important"
},
"js": {
"type": "boolean",
@ -38,11 +40,13 @@
"skipTests": {
"type": "boolean",
"description": "When true, does not create `spec.ts` test files for the new hook.",
"default": false
"default": false,
"x-priority": "internal"
},
"directory": {
"type": "string",
"description": "Create the hook under this directory (can be nested)."
"description": "Create the hook under this directory (can be nested).",
"x-priority": "important"
},
"flat": {
"type": "boolean",

18
packages/react/src/generators/host/schema.json
View File

@ -14,12 +14,14 @@
"index": 0
},
"x-prompt": "What name would you like to use as the host application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -74,12 +76,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipWorkspaceJson": {
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -143,12 +147,14 @@
"remotes": {
"type": "array",
"description": "A list of remote application names that the host application should consume.",
"default": []
"default": [],
"x-priority": "important"
},
"devServerPort": {
"type": "number",
"description": "The port for the dev server of the remote app.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"ssr": {
"description": "Whether to configure SSR for the host application",

18
packages/react/src/generators/library/schema.json
View File

@ -24,12 +24,14 @@
"index": 0
},
"x-prompt": "What name would you like to use for the library?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "A directory where the lib is placed.",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -96,12 +98,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipTsConfig": {
"type": "boolean",
"default": false,
"description": "Do not update `tsconfig.json` for development experience."
"description": "Do not update `tsconfig.json` for development experience.",
"x-priority": "internal"
},
"pascalCaseFiles": {
"type": "boolean",
@ -166,7 +170,8 @@
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": ["none", "vite", "rollup"],
"default": "none",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup.",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -177,7 +182,8 @@
"skipPackageJson": {
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"minimal": {
"description": "Create a React library with a minimal setup, no separate test files.",

9
packages/react/src/generators/redux/schema.json
View File

@ -12,7 +12,8 @@
"$default": {
"$source": "argv",
"index": 0
}
},
"x-priority": "important"
},
"project": {
"type": "string",
@ -21,13 +22,15 @@
"$default": {
"$source": "projectName"
},
"x-prompt": "What is the name of the project for this slice?"
"x-prompt": "What is the name of the project for this slice?",
"x-priority": "important"
},
"directory": {
"type": "string",
"alias": "dir",
"default": "",
"description": "The name of the folder used to contain/group the generated Redux files."
"description": "The name of the folder used to contain/group the generated Redux files.",
"x-priority": "important"
},
"appProject": {
"type": "string",

18
packages/react/src/generators/remote/schema.json
View File

@ -14,12 +14,14 @@
"index": 0
},
"x-prompt": "What name would you like to use as the remote application?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"alias": "dir"
"alias": "dir",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -79,12 +81,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipWorkspaceJson": {
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -147,12 +151,14 @@
},
"host": {
"type": "string",
"description": "The host / shell application for this remote."
"description": "The host / shell application for this remote.",
"x-priority": "important"
},
"devServerPort": {
"type": "number",
"description": "The port for the dev server of the remote app.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"ssr": {
"description": "Whether to configure SSR for the host application",

9
packages/react/src/generators/setup-ssr/schema.json
View File

@ -14,7 +14,8 @@
"index": 0
},
"x-prompt": "What app would you like to add SSR support to?",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"appComponentImportPath": {
"type": "string",
@ -24,11 +25,13 @@
"serverPort": {
"type": "number",
"default": 4200,
"description": "The port for the Express server."
"description": "The port for the Express server.",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"extraInclude": {
"type": "array",

12
packages/react/src/generators/setup-tailwind/schema.json
View File

@ -21,21 +21,25 @@
"index": 0
},
"x-dropdown": "projects",
"x-prompt": "What project would you like to add the Tailwind CSS setup?"
"x-prompt": "What project would you like to add the Tailwind CSS setup?",
"x-priority": "important"
},
"buildTarget": {
"type": "string",
"description": "The name of the target used to build the project. This option is not needed in most cases.",
"default": "build"
"default": "build",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skips formatting the workspace after the generator completes."
"description": "Skips formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

6
packages/react/src/generators/stories/schema.json
View File

@ -14,12 +14,14 @@
"$source": "projectName",
"index": 0
},
"x-prompt": "For which project do you want to generate stories?"
"x-prompt": "For which project do you want to generate stories?",
"x-priority": "important"
},
"generateCypressSpecs": {
"type": "boolean",
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"x-prompt": "Do you want to generate Cypress specs as well?"
"x-prompt": "Do you want to generate Cypress specs as well?",
"x-priority": "important"
},
"cypressProject": {
"type": "string",

12
packages/rollup/src/executors/rollup/schema.json
View File

@ -8,19 +8,22 @@
"properties": {
"project": {
"type": "string",
"description": "The path to package.json file."
"description": "The path to package.json file.",
"x-priority": "important"
},
"main": {
"type": "string",
"description": "The path to the entry file, relative to project.",
"alias": "entryFile",
"x-completion-type": "file",
"x-completion-glob": "**/*@(.js|.ts)"
"x-completion-glob": "**/*@(.js|.ts)",
"x-priority": "important"
},
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"outputFileName": {
"type": "string",
@ -35,7 +38,8 @@
"type": "string",
"description": "The path to tsconfig file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
"x-completion-glob": "tsconfig.*.json",
"x-priority": "important"
},
"format": {
"type": "array",

18
packages/rollup/src/generators/rollup-project/schema.json
View File

@ -14,7 +14,8 @@
"index": 0
},
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a rollup for?"
"x-prompt": "What is the name of the project to set up a rollup for?",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -25,26 +26,31 @@
"main": {
"type": "string",
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'.",
"alias": "entryFile"
"alias": "entryFile",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'."
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Do not perform any validation on existing project."
"description": "Do not perform any validation on existing project.",
"x-priority": "internal"
},
"importPath": {
"type": "string",

9
packages/webpack/src/executors/dev-server/schema.json
View File

@ -8,12 +8,14 @@
"properties": {
"buildTarget": {
"type": "string",
"description": "Target which builds the application."
"description": "Target which builds the application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "Port to listen on.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"host": {
"type": "string",
@ -55,7 +57,8 @@
"open": {
"type": "boolean",
"description": "Open the application in the browser.",
"default": false
"default": false,
"x-priority": "important"
},
"allowedHosts": {
"type": "string",

9
packages/webpack/src/executors/ssr-dev-server/schema.json
View File

@ -8,16 +8,19 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target which builds the browser application."
"description": "Target which builds the browser application.",
"x-priority": "important"
},
"serverTarget": {
"type": "string",
"description": "Target which builds the server application."
"description": "Target which builds the server application.",
"x-priority": "important"
},
"port": {
"type": "number",
"description": "The port to be set on `process.env.PORT` for use in the server.",
"default": 4200
"default": 4200,
"x-priority": "important"
},
"browserTargetOptions": {
"type": "object",

12
packages/webpack/src/executors/webpack/schema.json
View File

@ -14,13 +14,15 @@
"type": "string",
"description": "The name of the main entry-point file.",
"x-completion-type": "file",
"x-completion-glob": "**/*@(.js|.ts|.tsx)"
"x-completion-glob": "**/*@(.js|.ts|.tsx)",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "The name of the Typescript configuration file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
"x-completion-glob": "tsconfig.*.json",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -31,7 +33,8 @@
"outputPath": {
"type": "string",
"description": "The output path of the generated files.",
"x-completion-type": "directory"
"x-completion-type": "directory",
"x-priority": "important"
},
"target": {
"type": "string",
@ -299,7 +302,8 @@
"type": "string",
"description": "Path to a function which takes a webpack config, some context and returns the resulting webpack config. See https://nx.dev/guides/customize-webpack",
"x-completion-type": "file",
"x-completion-glob": "webpack?(*)@(.js|.ts)"
"x-completion-glob": "webpack?(*)@(.js|.ts)",
"x-priority": "important"
}
},
"required": ["tsConfig", "main"],

21
packages/webpack/src/generators/webpack-project/schema.json
View File

@ -14,7 +14,8 @@
"index": 0
},
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a webpack for?"
"x-prompt": "What is the name of the project to set up a webpack for?",
"x-priority": "important"
},
"compiler": {
"type": "string",
@ -24,11 +25,13 @@
},
"main": {
"type": "string",
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'."
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'.",
"x-priority": "important"
},
"tsConfig": {
"type": "string",
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'."
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
"x-priority": "important"
},
"target": {
"type": "string",
@ -39,17 +42,20 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Do not perform any validation on existing project."
"description": "Do not perform any validation on existing project.",
"x-priority": "internal"
},
"devServer": {
"type": "boolean",
@ -58,7 +64,8 @@
},
"webpackConfig": {
"type": "string",
"description": "Path relative to workspace root to a custom webpack file that takes a config object and returns an updated config."
"description": "Path relative to workspace root to a custom webpack file that takes a config object and returns an updated config.",
"x-priority": "internal"
}
},
"required": []