repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixApplication",
"$schema": "https://json-schema.org/schema",
"description": "Generate a new Remix application.",
"properties": {
"directory": {
"alias": "dir",
"description": "A directory where the app is placed.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for e2e tests",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What is the name of the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "vitest",
"description": "Test runner to use for unit tests.",
"enum": [
"vitest",
"jest",
"none"
],
"type": "string",
"x-prompt": "What unit test runner should be used?"
}
},
"title": "Create an Application",
"type": "object"
} | MIT | en |
nrwl/nx | ed300d5f82c88320835eba99f97599d732401cac | 2023-08-04T15:14:59 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack",
"esbuild"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"playwright",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"nextAppDir": {
"default": true,
"description": "Enable the App Router for this project.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"preset",
"name"
],
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular application.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests. The `protractor` option is deprecated and it will be removed in v15.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Generate an application that is setup to use standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | 0dd89999eae2edc6098a4c55828a22e07db429a1 | 2021-06-08T07:37:24 | packages/react/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookStories",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from 'project' by default",
"type": "string"
},
"generateCypressSpecs": {
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"description": "Library or application name",
"type": "string",
"x-prompt": "What's name of the project for which you want to generate stories?"
}
},
"required": [
"project"
],
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a web application using `swc` or `babel` as compiler.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"webpack",
"none",
"vite"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "swc",
"description": "The compiler to use",
"enum": [
"swc",
"babel"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 295547b3a95a0e330d0d75bf8db82957cf9464b4 | 2023-01-13T18:50:57 | packages/angular/src/generators/ngrx/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNgrxGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds NgRx support to an application or library.",
"examples": [
{
"command": "nx g @nrwl/angular:ngrx --root --module=apps/my-app/src/app/app.module.ts --facade=false placeholder",
"description": "Add root ngrx configration to the `my-app` application"
},
{
"command": "nx g @nrwl/angular:ngrx --module=libs/my-lib/src/lib/my-lib.module.ts --facade=true --root=false users",
"description": "Add a `users` state with a facade to the `my-lib` library. It will be tracked under the default `+state` folder in the lib"
}
],
"properties": {
"barrels": {
"default": false,
"description": "Use barrels to re-export actions, state and selectors.",
"type": "boolean"
},
"directory": {
"default": "+state",
"description": "The name of the folder used to contain/group the generated NgRx files.",
"type": "string"
},
"facade": {
"default": false,
"description": "Create a Facade class for the the feature.",
"type": "boolean",
"x-prompt": "Would you like to use a Facade with your NgRx state?"
},
"minimal": {
"default": true,
"description": "Only register the root state management setup or feature state.",
"type": "boolean"
},
"module": {
"description": "The path to the `NgModule` where the feature state will be registered. The host directory will create/use the new state directory.",
"type": "string",
"x-deprecated": "This option will be removed in a future version of Nx. Please switch to using --parent instead."
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.",
"type": "string",
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`."
},
"parent": {
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"type": "string",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?"
},
"root": {
"default": false,
"description": "Setup root or feature state management with NgRx.",
"type": "boolean",
"x-prompt": "Is this the root state of the application?"
},
"route": {
"default": "''",
"description": "The route that the Standalone NgRx Providers should be added to. _Note: This is only supported in Angular versions >= 14.1.0_.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Generate NgRx feature files without registering the feature in the NgModule.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not update the `package.json` with NgRx dependencies.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Add NgRx support to an application or library.",
"type": "object"
} | MIT | en |
nrwl/nx | bdcbac4445df85a8f861ac70465eb641e025e8de | 2021-10-15T22:07:12 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g app myapp --directory=myorg",
"description": "Generate apps/myorg/myapp and apps/myorg/myapp-e2e"
},
{
"command": "g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "g app myapp --routing",
"description": "Set up React Router"
}
],
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a React Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | ed159e865f48760e1d1d00af04c42ecfd07b5d29 | 2022-12-09T20:41:04 | packages/workspace/src/generators/ci-workflow/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceCIWorkflow",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a CI workflow.",
"properties": {
"ci": {
"description": "CI provider.",
"enum": [
"github",
"circleci",
"azure",
"bitbucket-pipelines"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "Github Actions",
"value": "github"
},
{
"label": "Circle CI",
"value": "circleci"
},
{
"label": "Azure DevOps",
"value": "azure"
},
{
"label": "BitBucket Pipelines",
"value": "bitbucket-pipelines"
},
{
"label": "Gitlab",
"value": "gitlab"
}
],
"message": "What is your target CI provider?",
"type": "list"
}
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"default": "CI",
"description": "Workflow name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "How should we name your workflow?"
}
},
"required": [
"ci"
],
"title": "Generate a CI workflow.",
"type": "object"
} | MIT | en |
nrwl/nx | cb452b48a4b1f81e73f3b4e8a44239e0d863070a | 2022-02-11T17:00:54 | packages/js/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": true,
"description": "Generate a buildable library.",
"type": "boolean"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"config": {
"default": "project",
"description": "Determines whether the project's executors should be configured in workspace.json, project.json or as npm scripts",
"enum": [
"workspace",
"project",
"npm-scripts"
],
"type": "string"
},
"directory": {
"description": "A directory where the lib is placed",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"skipTypeCheck": {
"default": false,
"description": "Whether to skip TypeScript type checking for SWC compiler.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the library (used for linting)",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if unitTestRunner is set to jest",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a TypeScript Library",
"type": "object"
} | MIT | en |
nrwl/nx | 8bc99407aac128102a7ebc7ee73824c78d9e4aa0 | 2022-08-08T13:17:06 | packages/react-native/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React-Native app or library.",
"properties": {
"generateStories": {
"default": true,
"description": "Automatically generate *.stories.ts files for components declared in this project?",
"type": "boolean",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React native Storybook configuration",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/next/src/generators/page/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextReactPage",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a Page for Next.",
"examplesFile": "../../../docs/page-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "The directory at which to create the page file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the component?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-priority": "important",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"withTests": {
"default": false,
"description": "When true, creates a `spec.ts` test file for the new page.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Create a Page for Next",
"type": "object"
} | MIT | en |
nrwl/nx | f98618b8d31bbf58699f8edd78653a33aab59910 | 2022-11-22T15:37:24 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"description": "The port for the dev server of the remote app.",
"type": "number"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 2471768ce173f055e769a440f1f5da5d0bf008da | 2022-11-24T11:06:40 | packages/angular/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Remote Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:remote appName --host=host --port=4201",
"description": "Create an Angular app with configuration in place for Module Federation. If host is provided, attach this remote app to host app's configuration."
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"host": {
"description": "The name of the host app to attach this remote app to.",
"type": "string",
"x-dropdown": "projects"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the remote Angular app.",
"type": "string"
},
"port": {
"description": "The port on which this app should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the remote application to be consumed by a host application using SSR.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether to generate a remote application with standalone components.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | a798576e0e5bb31c849f302493f83493483752d7 | 2023-04-19T21:02:34 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "http://json-schema.org/schema",
"additionalProperties": true,
"cli": "nx",
"description": "Create an empty workspace.",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"nextAppDir": {
"default": false,
"description": "Enable experimental app directory for the project",
"type": "boolean"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"nxCloud": {
"default": false,
"description": "Connect the workspace to the free tier of the distributed cache provided by Nx Cloud.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | e71cef0ba9db87823cfa94fbe74550a1e20761d0 | 2021-02-11T05:39:49 | packages/next/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"examples": [
{
"command": "g component my-component --project=mylib",
"description": "Generate a component in the mylib library"
},
{
"command": "g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the mylib library"
}
],
"id": "NxReactApp",
"properties": {
"directory": {
"alias": "d",
"description": "Create the component under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project index.ts (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-prompt": "What name would you like to use for the component?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this component?"
},
"skipTests": {
"default": false,
"description": "When true, does not create \"spec.ts\" test files for the new component.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component for Next",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/class/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestClassGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"d",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest class language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the class.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Class Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | 678818a58b37bb395415665232f7acaac4bd21f6 | 2021-05-12T16:20:12 | packages/next/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextReactComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g component my-component --project=mylib",
"description": "Generate a component in the mylib library"
},
{
"command": "g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the mylib library"
}
],
"properties": {
"directory": {
"alias": "d",
"description": "Create the component under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project index.ts (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-prompt": "What name would you like to use for the component?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this component?"
},
"skipTests": {
"default": false,
"description": "When true, does not create \"spec.ts\" test files for the new component.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component for Next",
"type": "object"
} | MIT | en |
nrwl/nx | 15d83258fe3b9e0c4143d937868f77f040e30bb0 | 2022-08-18T22:40:46 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "http://json-schema.org/schema",
"additionalProperties": true,
"cli": "nx",
"description": "Create an empty workspace.",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"cli": {
"default": "nx",
"description": "CLI used for generating code and running tasks.",
"enum": [
"nx",
"angular"
],
"type": "string"
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"tslint",
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"nxCloud": {
"default": false,
"description": "Connect the workspace to the free tier of the distributed cache provided by Nx Cloud.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace.",
"type": "string"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | a2d95775539f768df3495b175d0776df5c31ff6a | 2022-07-12T13:55:22 | packages/react-native/src/generators/component-story/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeComponentStory",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate storybook story for a react-native component.",
"properties": {
"componentPath": {
"description": "Relative path to the component file from the library root.",
"examples": [
"lib/components"
],
"type": "string",
"x-prompt": "What's path of the component relative to the project's lib root?"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "The project where to add the components.",
"examples": [
"shared-ui-component"
],
"type": "string",
"x-prompt": "What's the name of the project where the component lives?"
}
},
"required": [
"project",
"componentPath"
],
"title": "React native component story",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "https://json-schema.org/schema",
"additionalProperties": true,
"cli": "nx",
"description": "Create an empty workspace.",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"playwright",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"nextAppDir": {
"default": true,
"description": "Enable the App Router for this project.",
"type": "boolean"
},
"nextSrcDir": {
"default": true,
"description": "Generate a `src` directory for this project.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/cypress/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressE2EConfigGenerator",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress configuration to an existing project.",
"examplesFile": "../../../docs/cypress-e2e-config-examples.md",
"properties": {
"baseUrl": {
"description": "The address (with the port) which your application is running on. If you wish to start your application when running the e2e target, then use --devServerTarget instead.",
"type": "string"
},
"bundler": {
"default": "webpack",
"description": "The Cypress bundler to use.",
"enum": [
"vite",
"webpack",
"none"
],
"type": "string",
"x-prompt": "Which Cypress bundler do you want to use?"
},
"devServerTarget": {
"description": "A devServerTarget,'<projectName>:<targetName>[:<configName>], that will be used to run tests against. This is usually the app this project will be used in. Pass --baseUrl if you wish to not use a devServerTarget.",
"type": "string",
"x-priority": "important"
},
"directory": {
"default": "cypress",
"description": "A directory where the project is placed relative from the project root",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"jsx": {
"default": true,
"description": "Whether or not this project uses JSX.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"port": {
"description": "Set the 'port' option on the e2e target. It's recommend to set a different port so you can run tests e2e targets in parallel. Most dev servers support using '0' to automatically find a free port. The value 'cypress-auto' can be used if the underlying dev server does not support automatically finding a free port.",
"oneOf": [
{
"enum": [
"cypress-auto"
],
"type": "string"
},
{
"type": "number"
}
],
"x-priority": "important"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The project to add a Cypress configuration to",
"type": "string",
"x-priority": "important",
"x-prompt": "What project do you want to add Cypress to?"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Add a Cypress Configuration.",
"type": "object"
} | MIT | en |
nrwl/nx | a798576e0e5bb31c849f302493f83493483752d7 | 2023-04-19T21:02:34 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"nextAppDir": {
"default": false,
"description": "Enable experimental app/ for the project",
"type": "boolean"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | cae625a81711d45e14b64112cc9fa4b3a0d92a18 | 2021-11-01T16:10:58 | packages/nest/src/generators/resource/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResourceGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"crud": {
"default": true,
"description": "When true, CRUD entry points are generated.",
"type": "boolean",
"x-prompt": {
"message": "Would you like to generate CRUD entry points?",
"type": "confirmation"
}
},
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest class language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resource.",
"type": "string",
"x-prompt": "What name would you like to use for this resource (plural, e.g., \"users\")?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
},
"type": {
"default": "rest",
"description": "The transport layer.",
"enum": [
"rest",
"graphql-code-first",
"graphql-schema-first",
"microservice",
"ws"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "REST API",
"value": "rest"
},
{
"label": "GraphQL (code first)",
"value": "graphql-code-first"
},
{
"label": "GraphQL (schema first)",
"value": "graphql-schema-first"
},
{
"label": "Microservice (non-HTTP)",
"value": "microservice"
},
{
"label": "WebSockets",
"value": "ws"
}
],
"message": "What transport layer do you use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Resource Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | 8564d9ba126665caa079d3bd0c20b41d3f52c67d | 2023-09-05T13:40:16 | packages/angular/src/generators/move/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularMove",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Move an Angular project to another folder in the workspace.",
"examples": [
{
"command": "nx g @nx/angular:move --project my-feature-lib --destination shared/my-feature-lib",
"description": "Move libs/my-feature-lib to libs/shared/my-feature-lib."
}
],
"properties": {
"destination": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The folder to move the Angular project into.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The new import path to use in the `tsconfig.base.json`.",
"type": "string"
},
"newProjectName": {
"alias": "project",
"description": "The new name of the project after the move.",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-priority": "important"
},
"projectName": {
"alias": "project",
"description": "The name of the Angular project to move.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the new project name and destination as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"updateImportPath": {
"default": true,
"description": "Update the import path to reflect the new location.",
"type": "boolean"
}
},
"required": [
"projectName",
"destination"
],
"title": "Nx Angular Move",
"type": "object"
} | MIT | en |
nrwl/nx | 80a623ed4af9d31e030908179bf9dfc07a38fd60 | 2022-10-11T09:29:01 | packages/angular/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsAngularModuleInit",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Initializes the `@nrwl/angular` plugin. NOTE: Does not work in the `--dry-run` mode.",
"examples": [
{
"command": "nx g @nrwl/angular:init --style=scss",
"description": "Installs angular dependencies and initializes the `@nrwl/angular` plugin with the `scss` stylesheet format."
}
],
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing after adding `@nrwl/workspace`.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
}
},
"title": "Init Angular Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/webpack/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebpackProject",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add Webpack Configuration to a project.",
"properties": {
"babelConfig": {
"description": "Optionally specify a path relative to workspace root to the babel configuration file of your project.",
"type": "string",
"x-completion-type": "file"
},
"compiler": {
"default": "swc",
"description": "The compiler to use to build source.",
"enum": [
"babel",
"swc",
"tsc"
],
"type": "string"
},
"devServer": {
"default": false,
"description": "Add a serve target to run a local webpack dev-server",
"type": "boolean"
},
"main": {
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'.",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project.",
"type": "string",
"x-dropdown": "project",
"x-priority": "important",
"x-prompt": "What is the name of the project to set up a webpack for?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipValidation": {
"default": false,
"description": "Do not perform any validation on existing project.",
"type": "boolean",
"x-priority": "internal"
},
"target": {
"default": "web",
"description": "Target platform for the build, same as the Webpack config option.",
"enum": [
"node",
"web",
"webworker"
],
"type": "string"
},
"tsConfig": {
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
"type": "string",
"x-priority": "important"
},
"webpackConfig": {
"description": "Path relative to workspace root to a custom webpack file that takes a config object and returns an updated config.",
"type": "string",
"x-priority": "internal"
}
},
"required": [],
"title": "Add Webpack Configuration to a project",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/plugin/src/generators/plugin/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginPlugin",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a Plugin for Nx.",
"examples": [
{
"command": "nx g plugin my-plugin --directory=plugins --importPath=@myorg/my-plugin",
"description": "Generates an Nx plugin project called `plugins-my-plugin` at `libs/plugins/my-plugin`. The project will have an npm package name and import path of `@myorg/my-plugin`."
}
],
"properties": {
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"directory": {
"description": "A directory where the plugin is placed.",
"type": "string"
},
"e2eTestRunner": {
"default": "none",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"importPath": {
"description": "How the plugin will be published, like `@myorg/my-awesome-plugin`. Note this must be a valid NPM name.",
"type": "string",
"x-priority": "important"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Plugin name",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the plugin?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"default": false,
"description": "Generates a boilerplate for publishing the plugin to npm.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not eslint configuration for plugin json files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Plugin for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 2ab66dd4104dac61a4a6c37546c5e18b53341a83 | 2023-03-09T11:28:31 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular application.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests. The `protractor` option is deprecated and it will be removed in v15.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a Angular app with a minimal setup.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"description": "Generate an application that is setup to use standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean",
"x-priority": "important"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | 88971468dbbed3fb5a0d86c6d37a0f558ac75573 | 2022-04-23T02:43:59 | packages/node/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Node Plugin.",
"properties": {
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init Node Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | b52b649fcbc8fdf259703939823969c5e8c4eead | 2022-12-16T13:35:52 | packages/vite/src/generators/vitest/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "Vitest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a vitest setup for a project.",
"properties": {
"coverageProvider": {
"default": "c8",
"description": "Coverage provider to use.",
"enum": [
"c8",
"istanbul"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "Do not generate separate spec files and set up in-source testing",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project to test.",
"type": "string"
},
"skipViteConfig": {
"default": false,
"description": "Skip generating a vite config file",
"type": "boolean"
},
"testTarget": {
"description": "The test target of the project to be transformed to use the @nrwl/vite:test executor.",
"hidden": true,
"type": "string"
},
"uiFramework": {
"default": "none",
"description": "UI framework to use with vitest",
"enum": [
"react",
"none"
],
"type": "string"
}
},
"required": [
"project"
],
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | 810a3b5259e1cca504f0616c3a64d427d8d57725 | 2024-04-14T15:26:54 | packages/js/src/generators/release-version/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJSReleaseVersionGenerator",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "DO NOT INVOKE DIRECTLY WITH `nx generate`. Use `nx release version` instead.",
"properties": {
"currentVersionResolver": {
"default": "disk",
"description": "Which approach to use to determine the current version of the project.",
"enum": [
"registry",
"disk",
"git-tag"
],
"type": "string"
},
"currentVersionResolverMetadata": {
"default": {},
"description": "Additional metadata to pass to the current version resolver.",
"type": "object"
},
"installArgs": {
"description": "Additional arguments to pass to the package manager when updating the lock file with an install command.",
"type": "string"
},
"installIgnoreScripts": {
"description": "Whether to ignore install lifecycle scripts when updating the lock file with an install command.",
"type": "boolean"
},
"packageRoot": {
"description": "The root directory of the directory (containing a manifest file at its root) to publish. Defaults to the project root",
"type": "string"
},
"preid": {
"description": "The optional prerelease identifier to apply to the version, in the case that the specifier argument has been set to prerelease.",
"type": "string"
},
"projectGraph": {
"description": "ProjectGraph instance",
"type": "object"
},
"projects": {
"description": "The ProjectGraphProjectNodes being versioned in the current execution.",
"items": {
"type": "object"
},
"type": "array"
},
"releaseGroup": {
"description": "The resolved release group configuration, including name, relevant to all projects in the current execution.",
"type": "object"
},
"skipLockFileUpdate": {
"description": "Whether to skip updating the lock file after updating the version.",
"type": "boolean"
},
"specifier": {
"description": "Exact version or semver keyword to apply to the selected release group. Overrides specifierSource.",
"type": "string"
},
"specifierSource": {
"default": "prompt",
"description": "Which approach to use to determine the semver specifier used to bump the version of the project.",
"enum": [
"prompt",
"conventional-commits"
],
"type": "string"
}
},
"required": [
"projects",
"projectGraph",
"releaseGroup"
],
"title": "Implementation details of `nx release version`",
"type": "object"
} | MIT | en |
nrwl/nx | c616f6218cd8fe198ff473731f9287590f8f48ff | 2022-08-26T09:05:17 | packages/angular/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Remote Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:remote appName --host=host --port=4201",
"description": "Create an Angular app with configuration in place for Module Federation. If host is provided, attach this remote app to host app's configuration."
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"host": {
"description": "The name of the host app to attach this remote app to.",
"type": "string",
"x-dropdown": "projects"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the remote Angular app.",
"type": "string"
},
"port": {
"description": "The port on which this app should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether to generate a remote application with standalone components.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 8d5ef222cc5fc985f26fe06c937d9a179cd9f28c | 2023-06-13T17:30:52 | packages/vite/src/generators/vitest/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "Vitest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a Vitest setup for a project.",
"properties": {
"coverageProvider": {
"default": "c8",
"description": "Coverage provider to use.",
"enum": [
"c8",
"istanbul"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "Do not generate separate spec files and set up in-source testing.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project to test.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipViteConfig": {
"default": false,
"description": "Skip generating a vite config file.",
"type": "boolean"
},
"testEnvironment": {
"description": "The vitest environment to use. See https://vitest.dev/config/#environment.",
"enum": [
"node",
"jsdom",
"happy-dom",
"edge-runtime"
],
"type": "string"
},
"testTarget": {
"description": "The test target of the project to be transformed to use the @nx/vite:test executor.",
"hidden": true,
"type": "string"
},
"uiFramework": {
"default": "none",
"description": "UI framework to use with vitest.",
"enum": [
"react",
"none"
],
"type": "string"
}
},
"required": [
"project"
],
"title": "Vitest",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/rollup/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRollupProject",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add Rollup Configuration to a project.",
"properties": {
"buildTarget": {
"default": "build",
"description": "The build target to add.",
"type": "string"
},
"compiler": {
"default": "babel",
"description": "The compiler to use to build source.",
"enum": [
"babel",
"swc",
"tsc"
],
"type": "string"
},
"external": {
"description": "A list of external modules that will not be bundled (`react`, `react-dom`, etc.).",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"default": [
"esm"
],
"description": "The format to build the library (esm or cjs).",
"items": {
"enum": [
"esm",
"cjs"
],
"type": "string"
},
"type": "array"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"main": {
"alias": "entryFile",
"description": "Path relative to the workspace root for the main entry file. Defaults to '<projectRoot>/src/main.ts'.",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project.",
"type": "string",
"x-dropdown": "project",
"x-priority": "important",
"x-prompt": "What is the name of the project to set up a rollup for?"
},
"rollupConfig": {
"description": "Path relative to workspace root to a custom rollup file that takes a config object and returns an updated config.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipValidation": {
"default": false,
"description": "Do not perform any validation on existing project.",
"type": "boolean",
"x-priority": "internal"
},
"tsConfig": {
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
"type": "string",
"x-priority": "important"
}
},
"required": [],
"title": "Add Rollup Configuration to a project",
"type": "object"
} | MIT | en |
nrwl/nx | aa7625b76fcd3f53f6eda91220ecfd0a549928de | 2023-10-17T22:14:36 | packages/nest/src/generators/resolver/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResolverGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Resolver Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18."
},
"language": {
"description": "Nest resolver language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resolver.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Resolver Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 586501aa35e9224464bf9f93c332729b6d309213 | 2022-04-19T20:48:49 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"description": "The port for the dev server of the remote app.",
"type": "number"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | abf3ac6c8f9cdf0703ac26cc9881c8706724bfc8 | 2023-09-14T18:02:45 | packages/node/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Node Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate `libs/myapp/mylib`"
}
],
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean",
"x-priority": "important"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"rootDir": {
"description": "Sets the `rootDir` for TypeScript compilation. When not defined, it uses the project's root property, or `srcRootForCompilationRoot` if it is defined.",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project`. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using `--directory`).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.base.json` for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if `unitTestRunner` is set to `jest`.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Node Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 739e2e7115ff057ec923ef71dc09f2d73bef2977 | 2024-04-23T15:27:09 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "playwright",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"playwright",
"cypress",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup. No nx starter template.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "tailwind [ https://tailwindcss.com/ ]",
"value": "tailwind"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS. When --js is used, this flag is ignored.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 678818a58b37bb395415665232f7acaac4bd21f6 | 2021-05-12T16:20:12 | packages/cypress/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {},
"title": "Add Cypress Configuration to the workspace",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/angular/src/generators/scam-to-standalone/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularScamToStandalone",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Convert an Inline SCAM to a Standalone Component.",
"examplesFile": "../../../docs/scam-to-standalone-examples.md",
"properties": {
"component": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The path to the SCAM component file, relative to the root of the project containing the SCAM.",
"type": "string",
"x-priority": "important"
},
"project": {
"description": "The project containing the SCAM.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project contains the SCAM?"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
}
},
"title": "Convert an Inline SCAM to Standalone Component",
"type": "object"
} | MIT | en |
nrwl/nx | 80a623ed4af9d31e030908179bf9dfc07a38fd60 | 2022-10-11T09:29:01 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular application.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests. The `protractor` option is deprecated and it will be removed in v15.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipDefaultProject": {
"default": false,
"description": "Skip setting the project as the default project. When `false` (the default), the project is set as the default project only if there is no default project already set.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Generate an application that is setup to use standalone components.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | 5fe8d843960c303eaf0b9112d58091f3be3726fb | 2022-04-20T18:51:15 | packages/workspace/src/generators/ci-workflow/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceCIWorkflow",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a CI workflow.",
"properties": {
"ci": {
"description": "CI provider.",
"enum": [
"github",
"circleci",
"azure"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "Github Actions",
"value": "github"
},
{
"label": "Circle CI",
"value": "circleci"
},
{
"label": "Azure DevOps",
"value": "azure"
}
],
"message": "What is your target CI provider?",
"type": "list"
}
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Workflow name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "How should we name your workflow?"
}
},
"required": [
"ci"
],
"title": "Generate a CI workflow.",
"type": "object"
} | MIT | en |
nrwl/nx | 6bf3dc91ad4e145cd920e854aba8f907d368a1b4 | 2023-07-10T10:42:59 | packages/vite/src/executors/preview-server/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"definitions": {},
"description": "Preview Server for Vite.",
"examplesFile": "../../../docs/preview-server-examples.md",
"presets": [
{
"keys": [
"buildTarget"
],
"name": "Default minimum setup"
},
{
"keys": [
"buildTarget",
"port"
],
"name": "Using a Different Port"
}
],
"properties": {
"buildTarget": {
"description": "Target which builds the application.",
"type": "string"
},
"clearScreen": {
"description": "Set to false to prevent Vite from clearing the terminal screen when logging certain messages.",
"type": "boolean"
},
"host": {
"description": "Specify which IP addresses the server should listen on.",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"https": {
"description": "Serve using HTTPS. https://vitejs.dev/config/server-options.html#server-https",
"oneOf": [
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"logLevel": {
"description": "Adjust console output verbosity.",
"enum": [
"info",
"warn",
"error",
"silent"
],
"type": "string"
},
"mode": {
"description": "Mode to run the server in.",
"type": "string"
},
"open": {
"description": "Automatically open the app in the browser on server start. When the value is a string, it will be used as the URL's pathname.",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"port": {
"description": "Port to listen on.",
"type": "number"
},
"proxyConfig": {
"description": "Path to the proxy configuration file.",
"type": "string",
"x-completion-type": "file"
},
"staticFilePath": {
"description": "Path where the build artifacts are located. If not provided then it will be infered from the buildTarget executor options as outputPath",
"type": "string",
"x-completion-type": "directory"
}
},
"required": [
"buildTarget"
],
"title": "Vite Preview Server",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | c616f6218cd8fe198ff473731f9287590f8f48ff | 2022-08-26T09:05:17 | packages/angular/src/generators/setup-mf/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularMFSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given Angular Application.",
"properties": {
"appName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Module Federation configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate a Module Federation configuration for?"
},
"e2eProjectName": {
"description": "The project name of the associated E2E project for the application. This is only required for Cypress E2E projects that do not follow the naming convention `<appName>-e2e`.",
"type": "string"
},
"federationType": {
"default": "static",
"description": "Use either Static or Dynamic Module Federation pattern for the application.",
"enum": [
"static",
"dynamic"
],
"type": "string"
},
"host": {
"description": "The name of the host application that the remote application will be consumed by.",
"type": "string"
},
"mfType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"description": "The prefix to use for any generated component.",
"type": "string"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"routing": {
"description": "Generate a routing setup to allow a host application to route to the remote application.",
"type": "boolean"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether the application is a standalone application.",
"type": "boolean"
}
},
"required": [
"appName",
"mfType"
],
"title": "Generate Module Federation Setup for Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | e4758358b0cf9d3013ddfd30ae9ea387866f5144 | 2024-01-22T18:51:41 | packages/playwright/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPlaywrightInit",
"$schema": "http://json-schema.org/schema",
"description": "Initializes a Playwright project in the current workspace.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Playwright Init Generator",
"type": "object"
} | MIT | en |
nrwl/nx | e4758358b0cf9d3013ddfd30ae9ea387866f5144 | 2024-01-22T18:51:41 | packages/jest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJestInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Jest Configuration to a workspace.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Jest init",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInitGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Init Nest Plugin.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init Nest Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | f04519996cf8d1cf1c34153f2030aff47b60eaa1 | 2023-10-04T21:43:02 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup. No nx starter template.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ] (DEPRECATED)",
"value": "styl"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": false,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | e048fe7f7a2ff892d0e3d33783f6b6f886823e66 | 2022-10-11T09:25:14 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular application.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests. The `protractor` option is deprecated and it will be removed in v15.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipDefaultProject": {
"default": false,
"description": "Skip setting the project as the default project. When `false` (the default), the project is set as the default project only if there is no default project already set.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Generate an application that is setup to use standalone components.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | 519451e1e2742673742097781b59e11061a4245f | 2022-08-17T17:22:58 | packages/react-native/src/generators/upgrade-native/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeUpgradeNativeConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Upgrade native iOS and Android code to latest.",
"properties": {
"displayName": {
"description": "The display name to show in the application. Defaults to name.",
"type": "string"
},
"e2eTestRunner": {
"default": "detox",
"description": "Adds the specified e2e test runner.",
"enum": [
"detox",
"none"
],
"type": "string"
},
"install": {
"default": true,
"description": "Runs `pod install` for native modules before building iOS app.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Application project name to upgrade native files.",
"type": "string",
"x-dropdown": "project"
}
},
"required": [
"name"
],
"title": "React native upgrade native configuration",
"type": "object"
} | MIT | en |
nrwl/nx | d56605522bee5807e6afc4b0b683b23fb7774a83 | 2023-08-21T19:47:18 | packages/node/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Node Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate `libs/myapp/mylib`"
}
],
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean",
"x-priority": "important"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"rootDir": {
"description": "Sets the `rootDir` for TypeScript compilation. When not defined, it uses the project's root property, or `srcRootForCompilationRoot` if it is defined.",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project`. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using `--directory`).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.base.json` for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if `unitTestRunner` is set to `jest`.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Node Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 7192141c44b2c72fc14156ecaa22f4b105b1f1df | 2024-01-18T15:56:54 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup. No nx starter template.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | packages/nest/src/generators/decorator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestDecoratorGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest decorator language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the decorator.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Nest Decorator Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/react/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Remote Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss.",
"type": "boolean"
},
"host": {
"description": "The host / shell application for this remote.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the remote application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the remote application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react/src/generators/setup-ssr/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactSSRSetup",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create the additional configuration required to enable SSR via Express for a React application.",
"properties": {
"appComponentImportPath": {
"default": "app/app",
"description": "The import path of the <App/ > component, relative to project sourceRoot.",
"type": "string"
},
"extraInclude": {
"default": [],
"description": "Extra include entries in tsconfig.",
"hidden": true,
"items": {
"type": "string"
},
"type": "array"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to add SSR support to.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What app would you like to add SSR support to?"
},
"serverPort": {
"default": 4200,
"description": "The port for the Express server.",
"type": "number",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate SSR setup for a React app",
"type": "object"
} | MIT | en |
nrwl/nx | bdcbac4445df85a8f861ac70465eb641e025e8de | 2021-10-15T22:07:12 | packages/storybook/src/generators/cypress-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "cypress-configure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"directory": {
"description": "A directory where the project is placed",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library or application name",
"type": "string"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/remix/src/generators/style/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixRouteStyle",
"$schema": "https://json-schema.org/schema",
"description": "Generate a style import and file for a given route.",
"examples": [
{
"command": "g style --path='apps/demo/app/routes/path/to/page.tsx'",
"description": "Generate route at apps/demo/app/routes/path/to/page.tsx"
}
],
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the styles in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Route path",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
}
},
"required": [
"path"
],
"title": "Add style import to a route",
"type": "object"
} | MIT | en |
nrwl/nx | 02e22de7ed1da351b4a04ade323c31f7b4603b2e | 2022-11-23T15:00:29 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React application for Nx.",
"examples": [
{
"command": "nx g app myapp --directory=myorg",
"description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
},
{
"command": "nx g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "nx g app myapp --routing",
"description": "Set up React Router"
}
],
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"vite",
"webpack"
],
"x-prompt": "Which bundler do you want to use?"
},
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipDefaultProject": {
"default": false,
"description": "Skip setting the project as the default project. When `false` (the default), the project is set as the default project only if there is no default project already set.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | 54865ae83e79beb2692accd8a6c39a9b8c29399f | 2023-10-20T15:41:25 | packages/vue/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Vue Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=libs/mylib",
"description": "Generate `libs/mylib`"
},
{
"command": "nx g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to `myapp`"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"bundler": {
"default": "none",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"none",
"vite"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
},
"component": {
"default": false,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Create a Vue library with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"vitest",
"jest",
"none"
],
"type": "string",
"x-prompt": "What unit test runner should be used?"
}
},
"required": [
"name"
],
"title": "Create a Vue Library",
"type": "object"
} | MIT | en |
nrwl/nx | b84125f9ddb2358cb1232b1903a30ea76907007d | 2023-03-03T14:56:57 | packages/js/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a TypeScript Library.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"buildable": {
"default": true,
"description": "Generate a buildable library.",
"type": "boolean",
"x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
},
"bundler": {
"default": "none",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"swc",
"tsc",
"rollup",
"vite",
"esbuild",
"none"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets",
"enum": [
"tsc",
"swc"
],
"type": "string",
"x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
},
"config": {
"default": "project",
"description": "Determines whether the project's executors should be configured in `workspace.json`, `project.json` or as npm scripts.",
"enum": [
"workspace",
"project",
"npm-scripts"
],
"type": "string",
"x-priority": "internal"
},
"directory": {
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib.",
"type": "string"
},
"includeBabelRc": {
"description": "Include a .babelrc configuration to compile TypeScript files",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"skipTypeCheck": {
"default": false,
"description": "Whether to skip TypeScript type checking for SWC compiler.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if unitTestRunner is set to jest.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [
"name"
],
"title": "Create a TypeScript Library",
"type": "object"
} | MIT | en |
nrwl/nx | cf7a18bd14244d7779b5603d42afff335130179e | 2022-02-01T21:32:47 | packages/angular/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsAngularModuleInit",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "NOTE: Does not work in the --dry-run mode",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing after adding `@nrwl/workspace`.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
}
},
"title": "Init Angular Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | f4c4ec058a2494d18328f2667fbea962c68d1e8d | 2023-01-23T22:24:08 | packages/node/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxNodeApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"bundler": {
"default": "esbuild",
"description": "Bundler which is used to package the application",
"enum": [
"esbuild",
"webpack"
],
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"docker": {
"description": "Add a docker build target",
"type": "boolean"
},
"e2eTestRunner": {
"default": "jest",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"jest",
"none"
],
"type": "string"
},
"framework": {
"default": "none",
"description": "Generate the node application using a framework",
"enum": [
"express",
"koa",
"fastify",
"none"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which framework do you want to use?"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the node application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"port": {
"default": 3000,
"description": "The port which the server will be run on",
"type": "number",
"x-priority": "important"
},
"rootProject": {
"default": false,
"description": "Create node application at the root of the workspace",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | d51bbe04f9f713a450262e962cc1a09425cfc085 | 2021-02-10T14:35:54 | packages/storybook/src/generators/cypress-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "cypress-configure",
"properties": {
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library or application name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
} | MIT | en |
nrwl/nx | 65e86eacac68881f749223f41d54beda96d9f0ee | 2024-01-31T20:38:02 | packages/react-native/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookStories",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a React Native project.",
"properties": {
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-priority": "important",
"x-prompt": "For which project do you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate React Native Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/nest/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestApplicationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 0c454dd29f28df535bff87c8bfac08f85e9dd8c1 | 2021-05-26T10:09:42 | packages/angular/src/generators/add-linting/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularAddLintingGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"prefix": {
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"projectName": {
"description": "The name of the selected project.",
"type": "string"
},
"projectRoot": {
"description": "The path to the root of the selected project.",
"type": "string"
}
},
"required": [
"prefix",
"projectName",
"projectRoot"
],
"title": "Add linting to an Angular project.",
"type": "object"
} | MIT | en |
nrwl/nx | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | packages/nest/src/generators/class/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestClassGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest class language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the class.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Class Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | 6475c41ec81cc044c304297843ca8f66a94ef4e1 | 2023-11-13T17:53:21 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup. No nx starter template.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/plugin/src/generators/generator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Generator for an Nx Plugin.",
"examples": [
{
"command": "nx g generator my-generator --project=my-plugin",
"description": "Generate `libs/my-plugin/src/generators/my-generator`"
}
],
"properties": {
"description": {
"description": "Generator description.",
"type": "string",
"x-priority": "important"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the generator file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string",
"x-priority": "important"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Generator name.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the generator?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the generator in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipFormat": {
"default": false,
"description": "Do not format files with prettier.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not add an eslint configuration for plugin json files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Generator for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds Storybook configuration to a project to be able to use and create stories.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"default": true,
"description": "Specifies whether to configure Cypress or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a Cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the generated Cypress e2e app?"
},
"generateStories": {
"default": true,
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"storybook7betaConfiguration": {
"default": false,
"description": "Configure your workspace to use Storybook 7, even though Storybook v7 is still in beta.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/workspace/src/generators/remove/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceRemove",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Remove a project from the workspace.",
"examples": [
{
"command": "nx g @nrwl/workspace:remove my-feature-lib",
"description": "Remove `my-feature-lib` from the workspace"
},
{
"command": "nx g @nrwl/workspace:remove my-feature-lib --forceRemove",
"description": "Force removal of `my-feature-lib` from the workspace"
}
],
"properties": {
"forceRemove": {
"aliases": [
"force-remove"
],
"default": false,
"description": "When `true`, forces removal even if the project is still in use.",
"type": "boolean"
},
"projectName": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "project",
"description": "The name of the project to remove.",
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"projectName"
],
"title": "Nx Remove",
"type": "object"
} | MIT | en |
nrwl/nx | 5f32a9ae5c0002798b054ea39dd7b74e07579235 | 2023-02-01T14:21:36 | packages/node/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Node Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate `libs/myapp/mylib`"
}
],
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean",
"x-priority": "important"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"rootDir": {
"description": "Sets the `rootDir` for TypeScript compilation. When not defined, it uses the project's root property, or `srcRootForCompilationRoot` if it is defined.",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project`. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using `--directory`).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.base.json` for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if `unitTestRunner` is set to `jest`.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Node Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestModuleGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Module Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"language": {
"description": "Nest module language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "The path to import the module.",
"format": "path",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the module.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Nest Module Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/esbuild/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxEsbuildInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Init Esbuild Plugin.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Init Esbuild Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 8249ace5a2da6697d659095d9f89b101b8b28446 | 2023-10-13T17:20:10 | packages/plugin/src/generators/executor/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginExecutor",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Executor for an Nx Plugin.",
"examples": [
{
"command": "nx g executor my-executor --project=my-plugin",
"description": "Generate `libs/my-plugin/src/executors/my-executor`"
}
],
"examplesFile": "../../../docs/generators/executor-examples.md",
"properties": {
"description": {
"description": "Executor description.",
"type": "string"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the executor file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string"
},
"includeHasher": {
"default": false,
"description": "Should the boilerplate for a custom hasher be generated?",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Executor name.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the executor?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not add an eslint configuration for plugin json files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create an Executor for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 1a3240d651ae7fe1a4319111392d2e5e78772e10 | 2022-12-02T21:42:03 | packages/react/src/generators/setup-ssr/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactSSRSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create the additional configuration required to enable SSR via Express for a React application.",
"properties": {
"appComponentImportPath": {
"default": "app/app",
"description": "The import path of the <App/ > component, relative to project sourceRoot.",
"type": "string"
},
"extraInclude": {
"default": [],
"description": "Extra include entries in tsconfig.",
"hidden": true,
"items": {
"type": "string"
},
"type": "array"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to add SSR support to.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to add SSR support to?"
},
"serverPort": {
"default": 4200,
"description": "The port for the Express server.",
"type": "number"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Generate SSR setup for a React app",
"type": "object"
} | MIT | en |
nrwl/nx | f1911a71f3ccecd26ecde0c1c1c765e89df04e17 | 2021-06-23T00:30:38 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
},
{
"command": "g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to myapp"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "d",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '*.css' rather than '*.module.css').",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 1a9df531b643a30616571797ef24c923144d634c | 2022-09-13T14:17:49 | packages/react/src/generators/component-test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactCypressComponentTest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress component test for a component.",
"examples": [
{
"command": "nx g @nrwl/react:component-test --project=my-react-project --component-path=src/lib/fancy-component.tsx",
"description": "Create a cypress component test for FancyComponent"
}
],
"properties": {
"componentPath": {
"description": "Path to component, from the project source root",
"type": "string",
"x-prompt": "What is the path to the component?"
},
"project": {
"description": "The name of the project the component is apart of",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What project is this component apart of?"
}
},
"required": [
"project",
"componentPath"
],
"title": "Add Cypress component test",
"type": "object"
} | MIT | en |
nrwl/nx | 013bb744440ee54ae533808313fd6fe6d452696b | 2023-01-17T20:38:52 | packages/node/src/generators/e2e-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxNodeE2eProject",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate an E2E project for a Node server application.",
"properties": {
"directory": {
"description": "The directory of the e2e project.",
"type": "string",
"x-priority": "important"
},
"formatFiles": {
"default": true,
"description": "Format generated files.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"linter": {
"default": "eslint",
"description": "Linter to be used for the E2E project",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"description": "The name of the e2e project. Defaults to the project name with '-e2e' suffix.",
"type": "string"
},
"port": {
"default": 3000,
"description": "The port that the server runs on. Only application for server application.",
"type": "number"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project.",
"type": "string",
"x-dropdown": "project",
"x-prompt": "What project is this for?"
},
"projectType": {
"default": "server",
"description": "The type of application that is being tested.",
"enum": [
"server",
"cli"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create node application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Node E2E Project Generator",
"type": "object"
} | MIT | en |
nrwl/nx | 2f7d647f52a2ab99aef880c0e0c9523ee51f3161 | 2022-09-27T17:03:23 | packages/angular/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookStoriesGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates Storybook stories/specs for all Angular components declared in a project.",
"examplesFile": "../../../docs/stories-examples.md",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `name` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What's the name of the project for which you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Create Storybook stories/specs",
"type": "object"
} | MIT | en |
nrwl/nx | 5d1c8eacd7b3f919a28018a8069fa6a4e7711a45 | 2023-01-30T10:56:19 | packages/nest/src/generators/gateway/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGatewayGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Gateway Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest gateway language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the gateway.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Gateway Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | e20f379414dd46a135c62b723c78215c52c437b2 | 2023-10-18T19:25:31 | packages/plugin/src/generators/migration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginMigration",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Migration for an Nx Plugin.",
"examples": [
{
"command": "nx g migration my-migration --project=my-plugin --version=1.0.0",
"description": "Adds a new migration to the project `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
}
],
"properties": {
"description": {
"description": "Migration description.",
"type": "string"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the migration file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Migration name.",
"type": "string",
"x-priority": "important"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the migration in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"packageJsonUpdates": {
"alias": "p",
"default": false,
"description": "Whether or not to include `package.json` updates.",
"type": "boolean"
},
"packageVersion": {
"alias": "v",
"description": "Version to use for the migration.",
"type": "string",
"x-priority": "important",
"x-prompt": "What version would you like to use for the migration?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"skipLintChecks": {
"default": false,
"description": "Do not eslint configuration for plugin json files.",
"type": "boolean"
}
},
"required": [
"packageVersion"
],
"title": "Create a Migration for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 41f276b84e9922d5881e55e6c16aded0808925ff | 2023-11-02T15:08:39 | packages/nuxt/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNuxtApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Nuxt Application for Nx.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "none",
"description": "Test runner to use for unit tests.",
"enum": [
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [],
"title": "Create a Nuxt Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestModuleGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"d",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest module language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "The path to import the module.",
"format": "path",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the module.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Nest Module Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | 27b2ec18151001c389ba878fea293046cf1f899c | 2022-10-10T13:24:47 | packages/angular/src/generators/setup-tailwind/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularTailwindSetupGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds the Tailwind CSS configuration files for a given Angular project and installs, if needed, the packages required for Tailwind CSS to work.",
"examplesFile": "../../../docs/setup-tailwind-examples.md",
"properties": {
"buildTarget": {
"default": "build",
"description": "The name of the target used to build the project. This option only applies to buildable/publishable libraries.",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project to add the Tailwind CSS setup for.",
"type": "string",
"x-prompt": "What project would you like to add the Tailwind CSS setup?"
},
"skipFormat": {
"description": "Skips formatting the workspace after the generator completes.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"stylesEntryPoint": {
"description": "Path to the styles entry point relative to the workspace root. If not provided the generator will do its best to find it and it will error if it can't. This option only applies to applications.",
"type": "string"
}
},
"required": [
"project"
],
"title": "Configures Tailwind CSS for an application or a buildable/publishable library.",
"type": "object"
} | MIT | en |
nrwl/nx | 02e22de7ed1da351b4a04ade323c31f7b4603b2e | 2022-11-23T15:00:29 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate `libs/myapp/mylib`"
},
{
"command": "nx g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to `myapp`"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "Which compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When `true`, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/plugin/src/generators/migration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginMigration",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Migration for an Nx Plugin.",
"examples": [
{
"command": "nx g migration my-migration --project=my-plugin --version=1.0.0",
"description": "Adds a new migration to the project `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
}
],
"properties": {
"description": {
"description": "Migration description.",
"type": "string"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the migration file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Migration name.",
"type": "string",
"x-priority": "important"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the migration in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"packageJsonUpdates": {
"alias": "p",
"default": false,
"description": "Whether or not to include `package.json` updates.",
"type": "boolean"
},
"packageVersion": {
"alias": "v",
"description": "Version to use for the migration.",
"type": "string",
"x-priority": "important",
"x-prompt": "What version would you like to use for the migration?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"skipLintChecks": {
"default": false,
"description": "Do not eslint configuration for plugin json files.",
"type": "boolean"
}
},
"required": [
"packageVersion"
],
"title": "Create a Migration for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | b6cbb2ac6db6eec82e4b7db22fb2cf95f746baa3 | 2024-01-12T18:46:10 | packages/remix/src/generators/loader/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "data-loader",
"$schema": "http://json-schema.org/schema",
"description": "Generate an loader for a given route.",
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the loader in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | ec0f4b4173c95efc8d5f726662cbbb70ea24ab38 | 2022-04-21T00:46:13 | packages/workspace/src/generators/ci-workflow/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceCIWorkflow",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a CI workflow.",
"properties": {
"ci": {
"description": "CI provider.",
"enum": [
"github",
"circleci",
"azure"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "Github Actions",
"value": "github"
},
{
"label": "Circle CI",
"value": "circleci"
},
{
"label": "Azure DevOps",
"value": "azure"
}
],
"message": "What is your target CI provider?",
"type": "list"
}
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"default": "build",
"description": "Workflow name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "How should we name your workflow?"
}
},
"required": [
"ci"
],
"title": "Generate a CI workflow.",
"type": "object"
} | MIT | en |
nrwl/nx | 9116c29c1848c08c77d425ce62c959b93c45e3b8 | 2023-09-18T19:11:44 | packages/js/executors.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"builders": {
"node": {
"description": "Execute a Node application.",
"implementation": "./src/executors/node/compat",
"schema": "./src/executors/node/schema.json"
},
"swc": {
"description": "Build a project using SWC.",
"implementation": "./src/executors/swc/compat",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/compat",
"schema": "./src/executors/tsc/schema.json"
},
"verdaccio": {
"description": "Start local registry with verdaccio",
"implementation": "./src/executors/verdaccio/compat",
"schema": "./src/executors/verdaccio/schema.json"
}
},
"executors": {
"node": {
"description": "Execute a Node application.",
"implementation": "./src/executors/node/node.impl",
"schema": "./src/executors/node/schema.json"
},
"release-publish": {
"description": "DO NOT INVOKE DIRECTLY WITH `nx run`. Use `nx release publish` instead.",
"hidden": true,
"implementation": "./src/executors/release-publish/release-publish.impl",
"schema": "./src/executors/release-publish/schema.json"
},
"swc": {
"description": "Build a project using SWC.",
"implementation": "./src/executors/swc/swc.impl",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"batchImplementation": "./src/executors/tsc/tsc.batch-impl",
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/tsc.impl",
"schema": "./src/executors/tsc/schema.json"
},
"verdaccio": {
"description": "Start local registry with verdaccio",
"implementation": "./src/executors/verdaccio/verdaccio.impl",
"schema": "./src/executors/verdaccio/schema.json"
}
}
} | MIT | en |
nrwl/nx | 28ebfae4ea0b1421283d2efb041e730bdd77b332 | 2021-08-19T17:19:35 | packages/react/src/generators/hook/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactHook",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g hook my-hook --project=mylib",
"description": "Generate a hook in the mylib library"
}
],
"properties": {
"directory": {
"alias": "d",
"description": "Create the hook under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the hook is exported from the project index.ts (if it exists).",
"type": "boolean",
"x-prompt": "Should this hook be exported in the project?"
},
"flat": {
"default": false,
"description": "Create hook at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the hook.",
"type": "string",
"x-prompt": "What name would you like to use for the hook?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. useHook/useHook.ts).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case hook file name (e.g. useHook.ts).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this hook?"
},
"skipTests": {
"default": false,
"description": "When true, does not create \"spec.ts\" test files for the new hook.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Create a React Hook for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 2f9978f4d35233592bd199d744086357dc161ed4 | 2023-02-13T11:44:53 | packages/vite/src/executors/preview-server/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"definitions": {},
"description": "Preview Server for Vite.",
"examplesFile": "../../../docs/preview-server-examples.md",
"presets": [
{
"keys": [
"buildTarget"
],
"name": "Default minimum setup"
},
{
"keys": [
"buildTarget",
"port"
],
"name": "Using a Different Port"
}
],
"properties": {
"buildTarget": {
"description": "Target which builds the application.",
"type": "string"
},
"clearScreen": {
"description": "Set to false to prevent Vite from clearing the terminal screen when logging certain messages.",
"type": "boolean"
},
"host": {
"description": "Specify which IP addresses the server should listen on.",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"https": {
"description": "Serve using HTTPS.",
"type": "boolean"
},
"logLevel": {
"description": "Adjust console output verbosity.",
"enum": [
"info",
"warn",
"error",
"silent"
],
"type": "string"
},
"mode": {
"description": "Mode to run the server in.",
"type": "string"
},
"open": {
"description": "Automatically open the app in the browser on server start. When the value is a string, it will be used as the URL's pathname.",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"port": {
"description": "Port to listen on.",
"type": "number"
},
"proxyConfig": {
"description": "Path to the proxy configuration file.",
"type": "string",
"x-completion-type": "file"
},
"staticFilePath": {
"description": "Path where the build artifacts are located. If not provided then it will be infered from the buildTarget executor options as outputPath",
"type": "string",
"x-completion-type": "directory"
}
},
"required": [
"buildTarget"
],
"title": "Vite Preview Server",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 4eb7cc7bf170cd48dd87fdd0dd387d3592beec69 | 2023-03-31T15:22:18 | packages/storybook/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Storybook configuration to a UI library or an application.",
"examplesFile": "../../../docs/configuration-generator-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"type": "string",
"x-priority": "important"
},
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureStaticServe": {
"default": false,
"description": "Add a static-storybook to serve the static storybook built files.",
"type": "boolean"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Added at root by default.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"storybook7Configuration": {
"aliases": [
"storybook7betaConfiguration"
],
"default": false,
"description": "Configure your workspace using Storybook version 7.",
"hidden": true,
"type": "boolean"
},
"storybook7UiFramework": {
"description": "Storybook UI Framework to use, for Storybook version 7.",
"enum": [
"@storybook/angular",
"@storybook/html-webpack5",
"@storybook/nextjs",
"@storybook/preact-webpack5",
"@storybook/react-webpack5",
"@storybook/react-vite",
"@storybook/server-webpack5",
"@storybook/svelte-webpack5",
"@storybook/svelte-vite",
"@storybook/sveltekit",
"@storybook/vue-webpack5",
"@storybook/vue-vite",
"@storybook/vue3-webpack5",
"@storybook/vue3-vite",
"@storybook/web-components-webpack5",
"@storybook/web-components-vite"
],
"hidden": true,
"type": "string"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
},
"uiFramework": {
"description": "Storybook UI Framework to use.",
"enum": [
"@storybook/angular",
"@storybook/react",
"@storybook/react-native",
"@storybook/html",
"@storybook/web-components",
"@storybook/vue",
"@storybook/vue3",
"@storybook/svelte"
],
"type": "string",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string",
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"generateCypressSpecs": {
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 58e1f233cfdc7ae48029a58ad65ef33cbddc3f22 | 2023-07-12T15:02:12 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds Storybook configuration to a project to be able to use and create stories.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"description": "Specifies whether to configure Cypress or not.",
"type": "boolean",
"x-deprecated": "Please use Storybook interaction tests instead."
},
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string",
"x-deprecated": "Please use Storybook interaction tests instead."
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-deprecated": "Please use Storybook interaction tests instead."
},
"generateStories": {
"default": true,
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/interceptor/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInterceptorGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Interceptor Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"language": {
"description": "Nest interceptor language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the interceptor.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Interceptor Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "Remix",
"$schema": "https://json-schema.org/schema",
"description": "Generate a Remix application in a standalone workspace. Can be used with `create-nx-workspace --preset=@nx/remix`.",
"properties": {
"tags": {
"alias": "t",
"description": "Add tags to the app (used for linting).",
"type": "string"
}
},
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | c6fee867aab37680f6097b9b163644b7ba1d6b39 | 2021-07-26T13:56:30 | packages/angular/src/generators/move/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularMove",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Move an Angular project to another folder in the workspace",
"examples": [
{
"command": "g @nrwl/angular:move --project my-feature-lib shared/my-feature-lib",
"description": "Move libs/my-feature-lib to libs/shared/my-feature-lib"
}
],
"properties": {
"destination": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The folder to move the Angular project into.",
"type": "string"
},
"importPath": {
"description": "The new import path to use in the `tsconfig.base.json`.",
"type": "string"
},
"projectName": {
"alias": "project",
"description": "The name of the Angular project to move.",
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"updateImportPath": {
"default": true,
"description": "Update the import path to reflect the new location.",
"type": "boolean"
}
},
"required": [
"projectName",
"destination"
],
"title": "Nx Angular Move",
"type": "object"
} | MIT | en |
nrwl/nx | 678818a58b37bb395415665232f7acaac4bd21f6 | 2021-05-12T16:20:12 | packages/react/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNgInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified e2e test runner.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init React Plugin",
"type": "object"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.