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 | eb9caa1ade345aee6e01c67633e338d0536b9e0f | 2023-08-18T17:12:23 | 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",
"rspack"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"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",
"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?"
},
"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"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup, no separate test files.",
"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?"
},
"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"
},
"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"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating `nx.json` with default options based on values provided to this app.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"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"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | 3ef5406fb81f0ef686c3e693564681a96d3a91f3 | 2023-03-02T15:38:18 | packages/detox/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Add Detox Schematics.",
"properties": {
"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": [],
"title": "Add Detox Schematics",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "https://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 that uses rollup to bundle.",
"type": "boolean",
"x-deprecated": "Use the `bundler` option for greater control (none, vite, rollup)."
},
"bundler": {
"default": "none",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"none",
"vite",
"rollup"
],
"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": "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",
"x-priority": "important"
},
"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"
},
"minimal": {
"default": false,
"description": "Create a React 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"
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the name of the module of the library.",
"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"
},
"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": "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": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "What unit test runner should be used?"
}
},
"required": [
"name"
],
"title": "Create a React Library",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/angular/src/generators/ng-add/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularNgAddGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Migrates an Angular CLI workspace to Nx or adds the Angular plugin to an Nx workspace. NOTE: Does not work in the `--dry-run` mode.",
"examplesFile": "../../../docs/ng-add-examples.md",
"properties": {
"defaultBase": {
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean",
"x-priority": "internal"
},
"skipInstall": {
"default": false,
"description": "Skip installing added packages.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean",
"x-priority": "internal"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
}
},
"title": "Angular plugin initialization",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/nest/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestLibraryGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a NestJS Library for Nx.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"controller": {
"default": false,
"description": "Include a controller with the library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the library is placed.",
"type": "string"
},
"global": {
"default": false,
"description": "Add the Global decorator to the generated module.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"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": "Library name.",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"service": {
"default": false,
"description": "Include a service with the library.",
"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.base.json for development experience.",
"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": 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"
},
"target": {
"default": "es6",
"description": "The ES target, Nest suggest using es6 or higher.",
"enum": [
"es5",
"es6",
"esnext",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020"
],
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment for jest, for node applications this should stay as node unless doing DOM testing.",
"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 NestJS Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 6b6995a81e4602675ab24ad48d749d8df0799019 | 2022-10-13T15:50:19 | 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"
},
"bundler": {
"default": "none",
"description": "The bundler to use.",
"enum": [
"none",
"esbuild",
"rollup",
"webpack"
]
},
"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"
},
"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"
},
"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 | 80702b59c788094e16d8e56a1a09ee3868ffa96a | 2024-05-22T20:51:21 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "https://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": [
"playwright",
"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": 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",
"bun"
],
"type": "string"
},
"prefix": {
"description": "The prefix to use for Angular component and directive selectors.",
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"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"
},
"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) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://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 | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/service/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestServiceGenerator",
"$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 service language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the service.",
"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 Service Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | e8e8f94f7a33f1b92a52ba7f08b1ca7566dbe85e | 2023-11-10T16:22:43 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://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 v18."
},
"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 v18."
},
"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 v18."
},
"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 | f1911a71f3ccecd26ecde0c1c1c765e89df04e17 | 2021-06-23T00:30:38 | 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",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"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"
},
"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.",
"type": "string",
"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"
},
"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": false,
"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 | 09c6ccb2666f98014a206e23187a2794642a579c | 2022-09-28T15:08:01 | 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"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"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"
},
"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"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.base.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": 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 | 0e018e620eb2f9b050db8b74c48690f3671a014f | 2023-01-20T22:26:39 | packages/node/src/generators/setup-docker/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxSetupDocker",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Nx Node Docker Options Schema.",
"properties": {
"buildTargetName": {
"default": "build",
"description": "The name of the build target",
"type": "string"
},
"projectName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project",
"type": "string"
},
"targetName": {
"default": "docker-build",
"description": "The name of the target to create",
"type": "string"
}
},
"title": "Nx Node Docker Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInitGenerator",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Init Nest 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",
"x-priority": "internal"
}
},
"required": [],
"title": "Init Nest Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/interface/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInterfaceGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Interface 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 v18."
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the interface.",
"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"
}
},
"required": [
"name"
],
"title": "Nest Interface Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | cf7a18bd14244d7779b5603d42afff335130179e | 2022-02-01T21:32: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 TailwindCSS configuration files for a given Angular project and installs, if needed, the packages required for TailwindCSS to work.",
"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 TailwindCSS setup for.",
"type": "string",
"x-prompt": "What project would you like to add the TailwindCSS 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 TailwindCSS for an application or a buildable/publishable library.",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | packages/react/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Component for Nx.",
"examples": [
{
"command": "nx g component my-component --project=mylib",
"description": "Generate a component in the `mylib` library"
},
{
"command": "nx g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the `mylib` library"
}
],
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "Create the component under this directory (can be nested).",
"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",
"x-prompt": "Should this component be exported in the project?"
},
"fileName": {
"description": "Create a component with this file name.",
"type": "string"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"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"
},
"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?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for this component?"
},
"routing": {
"description": "Generate a library with routes.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new component.",
"type": "boolean",
"x-priority": "internal"
},
"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"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component",
"type": "object"
} | MIT | en |
nrwl/nx | 204c5cb5d83649841a93fb5193319a8bbfda216b | 2022-10-15T12:45:59 | 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",
"description": "Create a React Component for Next.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"directory": {
"alias": "dir",
"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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "https://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": "Use interactionTests instead. This option will be removed in v18."
},
"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 v18."
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"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": {
"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?"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"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?"
},
"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": [
"project"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | f98618b8d31bbf58699f8edd78653a33aab59910 | 2022-11-22T15:37:24 | 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": {
"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"
},
"host": {
"description": "The host / shell application for this remote.",
"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 remote application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"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"
},
"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 Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | a2167648f74ae7a9bffa9cb63e0e6c5bdad63073 | 2024-04-11T14:15:30 | packages/angular/src/generators/setup-ssr/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularUniversalSetup",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create the additional configuration required to enable SSR via Angular Universal for an Angular application.",
"properties": {
"appId": {
"default": "serverApp",
"description": "The `appId` to use with `withServerTransition`. _Note: This is only used in Angular versions <16.0.0. It's deprecated since Angular 16 and not supported since Angular 17._",
"format": "html-selector",
"type": "string"
},
"hydration": {
"description": "Set up Hydration for the SSR application. It defaults to `true` for Angular versions >= 17.0.0. Otherwise, it defaults to `false`. _Note: This is only supported in Angular versions >= 16.0.0_.",
"type": "boolean"
},
"main": {
"default": "main.server.ts",
"description": "The name of the main entry-point file.",
"format": "path",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Angular Universal configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate an Angular Universal configuration for?"
},
"rootModuleClassName": {
"default": "AppServerModule",
"description": "The name of the root module class.",
"type": "string"
},
"rootModuleFileName": {
"default": "app.server.module.ts",
"description": "The name of the root module file",
"format": "path",
"type": "string"
},
"serverFileName": {
"default": "server.ts",
"description": "The name of the Express server file.",
"type": "string"
},
"serverPort": {
"default": 4000,
"description": "The port for the Express server.",
"type": "number"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"standalone": {
"description": "Use Standalone Components to bootstrap SSR.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Generate Angular Universal (SSR) setup for an Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | 8ca7d4bbd61b8768b48358a75f5b7b33f9c9e590 | 2022-06-27T12:28:17 | packages/angular/src/generators/component-cypress-spec/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularComponentCypressSpecGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates a Cypress spec for a UI component that has a story.",
"properties": {
"componentFileName": {
"description": "Component file name without the `.ts` extension.",
"examples": [
"awesome.component"
],
"type": "string"
},
"componentName": {
"description": "Class name of the component.",
"examples": [
"AwesomeComponent"
],
"type": "string"
},
"componentPath": {
"description": "Relative path to the component file from the project root.",
"examples": [
"awesome"
],
"type": "string"
},
"cypressProject": {
"description": "The Cypress project to generate the stories under. By default, inferred from `projectName`.",
"type": "string"
},
"projectName": {
"description": "The name of the project.",
"examples": [
"ui-samples"
],
"type": "string"
},
"projectPath": {
"description": "Path to the project.",
"examples": [
"libs/ui-samples"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"projectName",
"projectPath",
"componentName",
"componentPath",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 277bdd22551bf1abfdaf1fc26820850f7072d09b | 2021-07-01T09:11:36 | 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",
"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-prompt": "What is the path to the module where this NgRx state should be registered?"
},
"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`."
},
"onlyAddFiles": {
"default": false,
"description": "Only add new NgRx files, without changing the module file (e.g., `--onlyAddFiles`).",
"type": "boolean",
"x-deprecated": "Use the `skipImport` option instead."
},
"onlyEmptyRoot": {
"default": false,
"description": "Do not generate any files. Only generate `StoreModule.forRoot` and `EffectsModule.forRoot` (e.g., `--onlyEmptyRoot`).",
"type": "boolean",
"x-deprecated": "Use the `minimal` option instead."
},
"root": {
"default": false,
"description": "Setup root or feature state management with NgRx.",
"type": "boolean",
"x-prompt": "Is this the root state of the application?"
},
"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"
},
"syntax": {
"default": "creators",
"description": "Specifies whether to use class-based or creator functions for actions, reducers, and effects.",
"enum": [
"classes",
"creators"
],
"type": "string"
},
"useDataPersistence": {
"default": false,
"description": "Generate NgRx Effects with the `DataPersistence` helper service. Set to false to use plain effects data persistence operators.",
"type": "boolean"
}
},
"required": [
"module",
"name"
],
"title": "Add NgRx support to an application or library.",
"type": "object"
} | MIT | en |
nrwl/nx | b6cbb2ac6db6eec82e4b7db22fb2cf95f746baa3 | 2024-01-12T18:46:10 | packages/remix/src/generators/error-boundary/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixErrorBoundary",
"$schema": "http://json-schema.org/schema",
"description": "Generate an ErrorBoundary for a given route.",
"examples": [
{
"command": "g error-boundary --routePath=apps/demo/app/routes/my-route.tsx",
"description": "Generate an ErrorBoundary for my-route.tsx"
}
],
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the error boundary 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": {
"description": "The path to route file relative to the project root.",
"type": "string"
},
"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."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files after generation.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"path"
],
"title": "Create an ErrorBoundary for a Route",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/node/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxNodeApp",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead `ts-jest`.",
"type": "boolean",
"x-deprecated": "Use --swcJest instead for faster compilation"
},
"bundler": {
"default": "esbuild",
"description": "Bundler which is used to package the application",
"enum": [
"esbuild",
"webpack"
],
"type": "string",
"x-priority": "important"
},
"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",
"fastify",
"koa",
"nest",
"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",
"x-dropdown": "projects",
"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 application.",
"pattern": "^[a-zA-Z][^:]*$",
"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"
},
"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 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": {
"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"
},
"swcJest": {
"default": false,
"description": "Use `@swc/jest` instead `ts-jest` for faster test compilation.",
"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": [
"name"
],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | e45c2f24bab36a72c3481ffbd605b6003a6591f2 | 2022-08-02T18:37:23 | packages/next/src/generators/custom-server/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextCustomServer",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add a custom server to existing Next.js application.",
"examples": [
{
"command": "nx g custom-server my-app",
"description": "Add a custom server to existing Next.js app."
}
],
"properties": {
"compiler": {
"default": "tsc",
"description": "The compiler used to build the custom server.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-dropdown": "project",
"x-prompt": "What is the name of the project to set up a custom server for?"
}
},
"required": [
"project"
],
"title": "Add custom server",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/controller/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestControllerGenerator",
"$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 controller language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "Allows specification of the declaring module.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the controller.",
"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"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Controller Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/guard/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGuardGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Guard 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 v18."
},
"language": {
"description": "Nest guard language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the guard.",
"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"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Guard Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 739e2e7115ff057ec923ef71dc09f2d73bef2977 | 2024-04-23T15:27:09 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "https://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": [
"playwright",
",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": 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"
},
"prefix": {
"description": "The prefix to use for Angular component and directive selectors.",
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"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"
},
"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) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://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 | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | 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",
"x-priority": "important"
},
"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",
"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"
},
"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. _Note: This is only supported in Angular versions >= 14.1.0_",
"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 | 24e45d494f50c6a883a389216ed663b9fb1e2523 | 2023-07-07T17:59:41 | packages/rollup/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRollupProject",
"$schema": "http://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"
},
"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 | 82fbb98e7d2337b801587e79c7e253056e0beee0 | 2022-12-21T14:15:26 | 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"
],
"type": "string",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"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"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup, no separate test files.",
"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?"
},
"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"
},
"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 | abfa8640b24b7ea12d90b975bf060ec8014eae18 | 2023-01-13T13:14:36 | 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",
"x-prompt": "Which Storybook builder do you want to use?"
},
"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?"
},
"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?"
},
"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",
"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",
"x-prompt": "What UI framework plugin should storybook use?"
}
},
"required": [
"name"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | 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"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"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"
},
"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"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.base.json` for development experience.",
"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": 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 | b994a297a9175d0758da2c130ecdbe4e229cc719 | 2023-10-18T20:27:29 | packages/vue/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a Vue project.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"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?"
},
"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"
},
"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?"
},
"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": [
"name"
],
"title": "Vue Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | d91c7ca4ec6c3eb6ffd7e4eb0fda4a61a5b5bd8c | 2022-09-30T11:02:05 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"default": true,
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean",
"x-prompt": "Add a Storybook Test-Runner target?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-prompt": "Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator?"
},
"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"
],
"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 Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | e8e8f94f7a33f1b92a52ba7f08b1ca7566dbe85e | 2023-11-10T16:22:43 | 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": "Use interactionTests instead. This option will be removed in v18."
},
"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 v18."
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"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": {
"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?"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"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?"
},
"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": [
"project"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 8d118160e942fa86fdcbc68d1be2960aa6a1be69 | 2023-07-19T15:59:43 | packages/playwright/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPlaywrightConfiguration",
"$schema": "http://json-schema.org/schema",
"description": "Add a Playwright configuration.",
"properties": {
"directory": {
"default": "playwright",
"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"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The project to add a Playwright configuration to",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project to set up Playwright 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"
},
"webServerAddress": {
"description": "The address of the web server.",
"type": "string"
},
"webServerCommand": {
"description": "The command to start the web server.",
"type": "string"
}
},
"required": [
"project"
],
"title": "Add a Playwright configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 5d1c8eacd7b3f919a28018a8069fa6a4e7711a45 | 2023-01-30T10:56:19 | packages/nest/src/generators/filter/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestFilterGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Filter 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 filter language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the filter.",
"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 Filter Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/guard/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGuardGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Guard 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 guard language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the guard.",
"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 Guard Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 65e86eacac68881f749223f41d54beda96d9f0ee | 2024-01-31T20:38:02 | packages/storybook/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxStorybookConfigure",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add Storybook configuration to a UI library or an application.",
"examplesFile": "../../../docs/configuration-generator-examples.md",
"properties": {
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v19."
},
"configureStaticServe": {
"default": false,
"description": "Add a static-storybook to serve the static storybook built files.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Added at root by default.",
"type": "string",
"x-deprecated": "Use interactionTests instead. This option will be removed in v19."
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"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",
"none"
],
"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?"
},
"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"
},
"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"
},
"uiFramework": {
"aliases": [
"storybook7UiFramework"
],
"description": "Storybook UI Framework to use.",
"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": false,
"type": "string",
"x-priority": "important",
"x-prompt": "Choose the Storybook framework that you need to use."
}
},
"required": [
"project",
"uiFramework"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/middleware/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestMiddlewareGenerator",
"$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 middleware language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the middleware.",
"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 Middleware Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | a63a25d2e2d0a4cd0afbc6840a3e1acc2edc683d | 2022-11-25T20:25:37 | 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. If a bundler is set then the library is buildable by default.",
"type": "boolean"
},
"bundler": {
"description": "The bundler to use.",
"enum": [
"vite",
"rollup"
],
"type": "string",
"x-prompt": "Which bundler would you like to use to build the library?"
},
"compiler": {
"default": "babel",
"description": "Which compiler to use. Does not apply if bundler is set to Vite.",
"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": {
"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 | 06f84b3326ad80103b0edff8bdfbc2436bf388f0 | 2021-02-02T23:56:35 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"id": "NxWebApp",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"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",
"none"
],
"type": "string"
},
"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]{1}.*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"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": "Stylus(.styl)[ http://stylus-lang.com ]",
"value": "styl"
},
{
"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"
}
},
"required": [],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 6141f44203898277adb8244db4200fcc3cea207f | 2024-01-17T19:22:58 | packages/eslint/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxESLintInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up the ESLint plugin.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Initialize ESLint Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/vue/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueLibrary",
"$schema": "https://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",
"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 | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/workspace/src/generators/run-commands/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsRunCommands",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a custom target to run any command.",
"examples": [
{
"command": "nx g @nrwl/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'",
"description": "Add the `printhello` target to `my-feature-lib`"
}
],
"properties": {
"command": {
"description": "Command to run.",
"type": "string",
"x-prompt": "What command would you like to run?"
},
"cwd": {
"description": "Current working directory of the command.",
"type": "string"
},
"envFile": {
"description": "Env files to be loaded before executing the commands.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Target name.",
"type": "string",
"x-prompt": "What name would you like to use to invoke the command?"
},
"outputs": {
"description": "Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.",
"type": "string"
},
"project": {
"description": "Project name.",
"type": "string",
"x-prompt": "What project does the target belong to?"
}
},
"required": [
"name",
"command",
"project"
],
"title": "Create a custom target to run any command",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/jest/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJestProject",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add Jest Configuration to a project.",
"properties": {
"babelJest": {
"alias": "babel-jest",
"default": false,
"description": "Use `babel-jest` instead of `ts-jest`.",
"type": "boolean",
"x-deprecated": "Use `--compiler=babel` instead."
},
"compiler": {
"default": "tsc",
"description": "The compiler to use for source and tests.",
"enum": [
"tsc",
"babel",
"swc"
],
"type": "string"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript for config files",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project.",
"type": "string",
"x-priority": "important"
},
"setupFile": {
"default": "none",
"description": "The setup file to be generated.",
"enum": [
"none",
"angular",
"web-components"
],
"type": "string",
"x-priority": "important"
},
"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"
},
"skipSerializers": {
"default": false,
"description": "Skips the serializers required to snapshot angular templates.",
"type": "boolean"
},
"skipSetupFile": {
"default": false,
"description": "Skips the setup file required for angular.",
"type": "boolean",
"x-deprecated": "Use `--setup-file` instead."
},
"supportTsx": {
"default": false,
"description": "Setup `tsx` support.",
"type": "boolean",
"x-priority": "important"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment for jest.",
"enum": [
"jsdom",
"node",
"none"
],
"type": "string",
"x-priority": "important"
}
},
"required": [],
"title": "Add Jest Configuration to a project",
"type": "object"
} | MIT | en |
nrwl/nx | 4df3b661528656d81e5deaf603af2dbc25b9dce9 | 2021-03-11T19:18:22 | packages/node/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"id": "NxNodeLibrary",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"directory": {
"alias": "d",
"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",
"tslint"
],
"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"
},
"rootDir": {
"alias": "srcRootForCompilationRoot",
"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"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean"
},
"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 | 8c1d035b0b971a47cc8f3dbe5e2ce11a48fbd1bd | 2023-03-03T19:32: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"
},
"minimal": {
"default": false,
"description": "Generate a library with a minimal setup. No README.md generated.",
"type": "boolean"
},
"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 | 08339ee49f2ec5401dbfec5e12f4b45287a3ec11 | 2023-06-06T19:45:33 | 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",
"description": "Initialize a React Plugin.",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified E2E test runner.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipHelperLibs": {
"default": false,
"description": "Do not install tslib.",
"hidden": true,
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"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 |
nrwl/nx | 37072bc5d6eb83eb8a636a485087f49ee0e7ed5f | 2022-07-01T13:48:38 | 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-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"
}
},
"required": [
"appName",
"mfType"
],
"title": "Generate Module Federation Setup for Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | f36d65c2ef5776e4702422e4049e60e2f3fb243c | 2023-04-06T15:39:03 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"bundler": {
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"x-priority": "important"
},
"configureCypress": {
"default": true,
"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": 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?"
},
"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": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator?"
},
"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": {
"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"
],
"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?"
},
"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": true,
"description": "Configure your workspace using Storybook version 7.",
"hidden": true,
"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 Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 9940a0c54467414f0b6365286d4ca5d625ddc1ad | 2023-07-07T16:43:29 | packages/cypress/src/generators/component-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressComponentConfiguration",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Cypress component test for a project.",
"examples": [
{
"command": "nx g @nx/cypress:component-configuration --project=my-cool-lib ",
"description": "Add cypress component testing to an existing project named my-cool-lib"
}
],
"examplesFile": "../../../docs/cypress-component-configuration-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The Cypress bundler to use.",
"enum": [
"vite",
"webpack"
],
"type": "string",
"x-prompt": "Which Cypress bundler do you want to use for the dev-server?"
},
"directory": {
"default": "cypress",
"description": "A directory where the project is placed relative from the project root",
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project to add cypress component testing to",
"type": "string",
"x-prompt": "What project should we add Cypress component testing to?"
}
},
"required": [
"project"
],
"title": "Set up Cypress component testing for a project",
"type": "object"
} | MIT | en |
nrwl/nx | 24b1ab5463f46925d547fffc791050e699f86c90 | 2023-08-03T15:16:35 | 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",
"description": "Initialize a React Plugin.",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified E2E test runner.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipHelperLibs": {
"default": false,
"description": "Do not install tslib.",
"hidden": true,
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"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 |
nrwl/nx | f45aa076da124ec50aa9a34b0280f98ff11c397c | 2023-05-03T15:02:07 | packages/angular/src/generators/setup-ssr/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularUniversalSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create the additional configuration required to enable SSR via Angular Universal for an Angular application.",
"properties": {
"appId": {
"default": "serverApp",
"description": "The `appId` to use with `withServerTransition`. _Note: This is only used in Angular versions <16.0.0. It's deprecated since Angular 16._",
"format": "html-selector",
"type": "string"
},
"main": {
"default": "main.server.ts",
"description": "The name of the main entry-point file.",
"format": "path",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Angular Universal configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate an Angular Universal configuration for?"
},
"rootModuleClassName": {
"default": "AppServerModule",
"description": "The name of the root module class.",
"type": "string"
},
"rootModuleFileName": {
"default": "app.server.module.ts",
"description": "The name of the root module file",
"format": "path",
"type": "string"
},
"serverFileName": {
"default": "server.ts",
"description": "The name of the Express server file.",
"type": "string"
},
"serverPort": {
"default": 4000,
"description": "The port for the Express server.",
"type": "number"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
},
"standalone": {
"description": "Use Standalone Components to bootstrap SSR. _Note: This is only supported in Angular versions >= 14.1.0_.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Generate Angular Universal (SSR) setup for an Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | d62acecec60955fb960a98ce178a08f1186e08c1 | 2023-10-13T14:47:43 | 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",
"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"
},
"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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/angular/src/generators/ngrx-feature-store/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNgrxFeatureStoreGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Add an NgRx Feature Store to an application or library.",
"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": false,
"description": "Only register the feature state.",
"type": "boolean",
"x-priority": "important"
},
"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-priority": "important",
"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 file where the state will be registered. For NgModule usage, this will be your Feature Module. For Standalone API usage, this will be your Routes definition file for your feature state. The host directory will create/use the new state directory.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?"
},
"route": {
"default": "''",
"description": "The route that the Standalone NgRx Providers should be added to.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"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",
"x-priority": "internal"
}
},
"required": [
"name"
],
"title": "NgRx Feature Store Generator",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "https://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": "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": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"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": {
"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?"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"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?"
},
"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": [
"project"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 396ffc463647c53436218639a5a7b31777befbf0 | 2024-02-02T08:40:59 | packages/remix/generators.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://json-schema.org/schema",
"extends": [
"@nx/react"
],
"generators": {
"action": {
"description": "Add an action function to an existing route",
"implementation": "./src/generators/action/action.impl",
"schema": "./src/generators/action/schema.json"
},
"application": {
"aliases": [
"app"
],
"description": "Generate a new Remix application",
"implementation": "./src/generators/application/application.impl#remixApplicationGeneratorInternal",
"schema": "./src/generators/application/schema.json",
"x-type": "application"
},
"cypress": {
"description": "Generate a project for testing Remix apps using Cypress",
"implementation": "./src/generators/cypress/cypress.impl#cypressGeneratorInternal",
"schema": "./src/generators/cypress/schema.json"
},
"cypress-component-configuration": {
"description": "Generate a Cypress Component Testing configuration for a Remix project",
"implementation": "./src/generators/cypress-component-configuration/cypress-component-configuration.impl#cypressComponentConfigurationGeneratorInternal",
"schema": "./src/generators/cypress-component-configuration/schema.json"
},
"error-boundary": {
"description": "Add an ErrorBoundary to an existing route",
"implementation": "./src/generators/error-boundary/error-boundary.impl",
"schema": "./src/generators/error-boundary/schema.json"
},
"init": {
"description": "Initialize the `@nx/remix` plugin.",
"hidden": true,
"implementation": "./src/generators/init/init#remixInitGeneratorInternal",
"schema": "./src/generators/init/schema.json"
},
"library": {
"aliases": [
"lib"
],
"description": "Generate a new library",
"implementation": "./src/generators/library/library.impl#remixLibraryGeneratorInternal",
"schema": "./src/generators/library/schema.json",
"x-type": "library"
},
"loader": {
"description": "Add a loader function to an existing route",
"implementation": "./src/generators/loader/loader.impl",
"schema": "./src/generators/loader/schema.json"
},
"meta": {
"description": "Add a meta function to an existing route",
"implementation": "./src/generators/meta/meta.impl",
"schema": "./src/generators/meta/schema.json"
},
"preset": {
"description": "Generate a new Remix workspace",
"hidden": true,
"implementation": "./src/generators/preset/preset.impl",
"schema": "./src/generators/preset/schema.json"
},
"resource-route": {
"description": "Generate a new resource route",
"implementation": "./src/generators/resource-route/resource-route.impl",
"schema": "./src/generators/resource-route/schema.json"
},
"route": {
"description": "Generate a new route",
"implementation": "./src/generators/route/route.impl",
"schema": "./src/generators/route/schema.json"
},
"setup": {
"description": "Setup a Remix in an existing workspace",
"hidden": true,
"implementation": "./src/generators/setup/setup.impl",
"schema": "./src/generators/setup/schema.json"
},
"setup-tailwind": {
"description": "Generates a TailwindCSS configuration for the Remix application",
"implementation": "./src/generators/setup-tailwind/setup-tailwind.impl",
"schema": "./src/generators/setup-tailwind/schema.json"
},
"storybook-configuration": {
"description": "Generates a Storybook configuration for a Remix application",
"implementation": "./src/generators/storybook-configuration/storybook-configuration.impl#remixStorybookConfiguration",
"schema": "./src/generators/storybook-configuration/schema.json"
},
"style": {
"description": "Generates a new stylesheet and adds it to an existing route",
"implementation": "./src/generators/style/style.impl",
"schema": "./src/generators/style/schema.json"
}
},
"name": "NxRemix",
"version": "0.0.1"
} | MIT | en |
nrwl/nx | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | packages/workspace/src/generators/run-commands/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsRunCommands",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a custom target to run any command.",
"examples": [
{
"command": "nx g @nx/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'",
"description": "Add the `printhello` target to `my-feature-lib`"
}
],
"properties": {
"command": {
"description": "Command to run.",
"type": "string",
"x-prompt": "What command would you like to run?"
},
"cwd": {
"description": "Current working directory of the command.",
"type": "string"
},
"envFile": {
"description": "Env files to be loaded before executing the commands.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Target name.",
"type": "string",
"x-prompt": "What name would you like to use to invoke the command?"
},
"outputs": {
"description": "Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.",
"type": "string"
},
"project": {
"description": "Project name.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What project does the target belong to?"
}
},
"required": [
"name",
"command",
"project"
],
"title": "Create a custom target to run any command",
"type": "object"
} | MIT | en |
nrwl/nx | 62240262d6dee5f02a8113266fcf973ca04ecab2 | 2023-10-18T12:42:40 | packages/nest/src/generators/middleware/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestMiddlewareGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Middleware 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 v18."
},
"language": {
"description": "Nest middleware language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the middleware.",
"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"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Middleware Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/webpack/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebpackInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Initialize the Webpack 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"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Init Webpack Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 33acb41afbaf5160d948147b1d2c10c71b1b68c1 | 2021-02-12T20:29:31 | packages/react/src/generators/component-story/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "component-story",
"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
},
"description": "The project name where to add the components.",
"examples": [
"shared-ui-component"
],
"type": "string",
"x-prompt": "What's name of the project where the component lives?"
}
},
"required": [
"project",
"componentPath"
],
"type": "object"
} | MIT | en |
nrwl/nx | 2d860eaf882f7d6389f387f06b59e34d66361b72 | 2022-11-25T14:01:35 | 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-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-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-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-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"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": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 4bba066d57712db6aba4a2dc8cf4493fdae8cf1a | 2023-07-13T10:06:04 | 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",
"description": "Generate stories/specs for all 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 `project` by default.",
"type": "string",
"x-deprecated": "Please use Storybook interaction tests instead."
},
"generateCypressSpecs": {
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-deprecated": "Please use Storybook interaction tests instead."
},
"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": {
"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 Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | 2f7d647f52a2ab99aef880c0e0c9523ee51f3161 | 2022-09-27T17:03:23 | 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-prompt": "Configure a Cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean",
"x-prompt": "Add a Storybook Test-Runner target?"
},
"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-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-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-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"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": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | 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": "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": "DEPRECATD: Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"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 | a25e081a84509d83db5c5c4c27d2898dcad79f65 | 2021-01-25T17:52:30 | packages/workspace/src/generators/move/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Move a project to another folder in the workspace",
"examples": [
{
"command": "g @nrwl/workspace:move --project my-feature-lib shared/my-feature-lib",
"description": "Move libs/my-feature-lib to libs/shared/my-feature-lib"
}
],
"id": "NxWorkspaceMove",
"properties": {
"destination": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The folder to move the 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 project to move",
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"updateImportPath": {
"default": true,
"description": "Should the generator update the import path to reflect the new location?",
"type": "boolean"
}
},
"required": [
"projectName",
"destination"
],
"title": "Nx Move",
"type": "object"
} | MIT | en |
nrwl/nx | d20cf91e6c5e1b71fb8af4e6413d27b15e82d2ce | 2023-01-13T16:50:01 | packages/react/src/generators/redux/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "redux",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Redux state slice for a React project.",
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the slice to.",
"type": "string"
},
"directory": {
"alias": "dir",
"default": "",
"description": "The name of the folder used to contain/group the generated Redux files.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Redux slice name.",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project to add the slice to. If it is an application, then the store configuration will be updated too.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for this slice?"
}
},
"required": [
"name"
],
"title": "Create Redux state",
"type": "object"
} | MIT | en |
nrwl/nx | 4f09949383d97bf0cd551cdc6de24fea753fc7c5 | 2023-02-10T20:06:41 | 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"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"connect"
],
"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?"
},
"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 the Standalone APIs 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 | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/nest/src/generators/resolver/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResolverGenerator",
"$schema": "https://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 v19."
},
"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 v19."
},
"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 | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | 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",
"x-prompt": "Which Storybook builder do you want to use?"
},
"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?"
},
"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?"
},
"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"
},
"storybook7UiFramework": {
"description": "Storybook UI Framework to use.",
"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"
},
"storybook7betaConfiguration": {
"default": false,
"description": "Configure your workspace to use Storybook 7, even though Storybook v7 is still in beta.",
"hidden": true,
"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"
},
"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",
"x-prompt": "What UI framework plugin should storybook use?"
}
},
"required": [
"name"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 62240262d6dee5f02a8113266fcf973ca04ecab2 | 2023-10-18T12:42:40 | 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. 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 v18."
},
"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?"
},
"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"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Gateway Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 901b70a4fec92d2af875acd4f947acc7a91636e4 | 2023-07-25T22:15:26 | 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"
},
"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?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for the executor?"
},
"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": [
"project",
"name"
],
"title": "Create an Executor for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 7812f419945d42ca3bcac8295992e42a726e3723 | 2023-03-16T16:38:04 | packages/angular/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Host Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:host appName --remotes=remote1",
"description": "Create an Angular application with configuration in place for Module Federation. If the `remotes` option is provided, attach the remote application to this application'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"
},
"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"
},
"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 host Angular application.",
"pattern": "^[a-zA-Z].*$",
"type": "string"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"remotes": {
"description": "The names of the remote applications to add to the host.",
"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"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean",
"x-priority": "important"
},
"standalone": {
"default": false,
"description": "Whether to generate a host application that uses 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": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Host Application",
"type": "object"
} | MIT | en |
nrwl/nx | d038b70a877e42e229399b98d3a4d124cc105b94 | 2022-06-07T14:57: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": "Project name.",
"type": "string"
}
},
"required": [
"name"
],
"title": "React native upgrade native configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 7caae07881f000a128f826e431caf98250dad0b6 | 2023-10-19T13:22:55 | packages/react/src/generators/federate-module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactFederateModule",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a federated module, which can be loaded by a remote host.",
"examples": [
{
"command": "nx g federate-module MyModule --path=./src/component/my-cmp.ts --remote=my-remote-app --remoteDirectory=apps/my-remote-app",
"description": "Create a federated module from my-remote-app, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule."
}
],
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"host": {
"description": "The host / shell application for this remote.",
"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 module.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the module?"
},
"path": {
"description": "The path to locate the federated module. This path should be relative to the workspace root and the file should exist.",
"type": "string",
"x-prompt": "What is the path to the module to be federated?"
},
"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"
},
"remote": {
"description": "The name of the remote.",
"type": "string",
"x-prompt": "What is/should the remote be named?"
},
"remoteDirectory": {
"description": "The directory of the new remote application if one needs to be created.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "none",
"description": "The file extension to be used for style files.",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"path",
"remote"
],
"title": "Federate Module",
"type": "object"
} | MIT | en |
nrwl/nx | 27923fd2d848cbfc57732210d0465b684a2ac888 | 2023-08-01T14:53:06 | packages/web/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Web Plugin.",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"webpack",
"none",
"vite"
],
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified e2e test runner",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init Web Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 35dd6c95bc192117907951c6dda7d6d0241679b4 | 2022-10-28T21:17:16 | 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",
"description": "Create a React component using Hooks in a dedicated React project.",
"examples": [
{
"command": "nx g hook my-hook --project=mylib",
"description": "Generate a hook in the `mylib` library"
}
],
"properties": {
"directory": {
"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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/rollup/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebpackInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Init Webpack 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 Webpack Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 0f47f0345131ec6a06f7574fac3560df9e8fad1e | 2024-05-17T03:38:19 | 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": "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?"
},
"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"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"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) [ 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 | fca85ca4828822ebae43a525e9f3076196666a4e | 2022-04-22T18:49:40 | 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": {
"babelJest": {
"alias": "babel-jest",
"default": false,
"description": "Use `babel-jest` instead of `ts-jest`.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript for config files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Jest init",
"type": "object"
} | MIT | en |
nrwl/nx | b110275f9c17c7e8c17de3f7c8e4a9d10b700d78 | 2023-01-31T17:17:46 | packages/webpack/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebpackInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initialize the Webpack Plugin.",
"properties": {
"compiler": {
"default": "babel",
"description": "The compiler to initialize for.",
"enum": [
"babel",
"swc",
"tsc"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"uiFramework": {
"description": "UI Framework to use for Webpack.",
"enum": [
"react",
"none"
],
"type": "string",
"x-prompt": "What UI framework plugin should Webpack use?"
}
},
"required": [],
"title": "Init Webpack Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 6d83dd7ff068caecb8bc1dc630ae5f2578b683c8 | 2024-03-19T18:38:15 | packages/gradle/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxGradleInitSchema",
"$schema": "https://json-schema.org/schema",
"description": "Initializes a Gradle 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": "Gradle Init Generator",
"type": "object"
} | MIT | en |
nrwl/nx | 3b5bf6d1d177188017d0c92d251bcd61a62686b4 | 2023-12-13T16:07:08 | packages/remix/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixLibrary",
"$schema": "http://json-schema.org/schema",
"description": "Generate a Remix library to help structure workspace and application.",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Should the library be buildable?",
"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"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"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?"
},
"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"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files after generator runs",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "Generate a stylesheet",
"enum": [
"none",
"css"
],
"type": "string"
},
"tags": {
"description": "Add tags to the library (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "vitest",
"description": "Test Runner to use for Unit Tests",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "What test runner should be used?"
}
},
"required": [
"name"
],
"title": "Create a Library",
"type": "object"
} | MIT | en |
nrwl/nx | 901b70a4fec92d2af875acd4f947acc7a91636e4 | 2023-07-25T22:15:26 | packages/plugin/src/generators/e2e-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginE2E",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create an E2E app for a Nx Plugin.",
"examplesFile": "../../../docs/generators/e2e-project-examples.md",
"properties": {
"jestConfig": {
"description": "Jest config file.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate the e2e project with a minimal setup. This would involve not generating tests for a default executor and generator.",
"type": "boolean"
},
"npmPackageName": {
"description": "the package name of the plugin as it would be published to NPM.",
"type": "string",
"x-priority": "important"
},
"pluginName": {
"description": "the project name of the plugin to be tested.",
"type": "string",
"x-priority": "important"
},
"pluginOutputPath": {
"description": "the output path of the plugin after it builds.",
"type": "string",
"x-priority": "important"
},
"projectDirectory": {
"description": "the directory where the plugin is placed.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"pluginName",
"npmPackageName"
],
"title": "Create an E2E app for a Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 46e7b4d49c71718d50fe7293254fea50ffbcfaef | 2022-04-12T18:05:55 | 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.",
"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 | fcecebeb3ad5007920e7ced230ef847b48a062e7 | 2021-11-16T02:29:28 | 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": false,
"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 how 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"
},
"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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/service/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestServiceGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Service 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 service language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the service.",
"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"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Service Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 901b70a4fec92d2af875acd4f947acc7a91636e4 | 2023-07-25T22:15:26 | packages/plugin/src/generators/lint-checks/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "PluginLint",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Adds linting configuration to validate common json files for nx plugins.",
"examples": [
{
"command": "nx g @nx/plugin:lint-checks",
"description": "Sets up linting configuration to validate common json files for an nx plugin project."
}
],
"properties": {
"projectName": {
"$default": {
"$source": "projectName"
},
"description": "Which project should be the configuration be added to?",
"type": "string",
"x-priority": "important"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files with prettier.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"projectName"
],
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | 46e7b4d49c71718d50fe7293254fea50ffbcfaef | 2022-04-12T18:05:55 | 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"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"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",
"tslint"
],
"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"
},
"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"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.base.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": 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 | ab5137c6392b226e35c2d15bf58d0370648e1c3d | 2024-02-06T14:06:04 | 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",
"playwright",
"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 | e1b76e26f886109706bd1c86cb98cee497484287 | 2023-08-22T14:26:10 | packages/nest/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestLibraryGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a NestJS Library for Nx.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean",
"x-priority": "important"
},
"controller": {
"default": false,
"description": "Include a controller with the library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the library is placed.",
"type": "string"
},
"global": {
"default": false,
"description": "Add the Global decorator to the generated module.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"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": "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?"
},
"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"
},
"service": {
"default": false,
"description": "Include a service with the library.",
"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"
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the name of the module of the library.",
"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.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": 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"
},
"target": {
"default": "es2021",
"description": "The ES target, Nest suggest using es2021 or higher.",
"enum": [
"es5",
"es6",
"esnext",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020",
"es2021"
],
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment for jest, for node applications this should stay as node unless doing DOM testing.",
"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 NestJS Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | 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",
"description": "Nest Module Options Schema.",
"properties": {
"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 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 | e1b76e26f886109706bd1c86cb98cee497484287 | 2023-08-22T14:26:10 | 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"
},
"e2eTestRunner": {
"default": "jest",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"jest",
"none"
],
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string",
"x-priority": "important"
},
"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 node 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"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"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": "Adds strictNullChecks, noImplicitAny, strictBindCallApply, forceConsistentCasingInFileNames and noFallthroughCasesInSwitch to tsconfig.",
"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": [
"name"
],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | f8f09b91dfcabea2a717ffd5650db22a7bb3dea2 | 2021-09-25T01:02:52 | packages/express/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxExpressApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"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"
},
"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 node application?"
},
"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"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to package.json.",
"type": "boolean"
},
"standaloneConfig": {
"default": false,
"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 | 6b7b6815c10c79174d5983a86e39456f214fe594 | 2021-04-29T09:02:04 | packages/react/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "storybook-stories",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from 'project' by default",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"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 | d372be00434f0f7bc08ec2737f678bb47a705631 | 2022-07-22T15:07:03 | 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.",
"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"
},
"federationType": {
"default": "static",
"description": "Use either Static or Dynamic Module Federation pattern for the application.",
"enum": [
"static",
"dynamic"
],
"type": "string",
"x-deprecated": "Use the `host` or `remote` generators instead. Support for generating Module Federation applications using the application generator will be removed in an upcoming version."
},
"host": {
"description": "The name of the host application that the remote application will be consumed by.",
"type": "string",
"x-deprecated": "Use the `host` or `remote` generators instead. Support for generating Module Federation applications using the application generator will be removed in an upcoming version."
},
"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"
},
"mf": {
"default": false,
"description": "Generate a Module Federation configuration for the application",
"type": "boolean",
"x-deprecated": "Use the `host` or `remote` generators instead. Support for generating Module Federation applications using the application generator will be removed in an upcoming version."
},
"mfType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string",
"x-deprecated": "Use the `host` or `remote` generators instead. Support for generating Module Federation applications using the application generator will be removed in an upcoming version."
},
"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"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-deprecated": "Use the `host` or `remote` generators instead. Support for generating Module Federation applications using the application generator will be removed in an upcoming version."
},
"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"
},
"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 | d28f571874bd6a36316a44341c4ad22954b5b223 | 2021-11-12T22:41:30 | packages/js/executors.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"builders": {
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/compat",
"schema": "./src/executors/tsc/schema.json"
}
},
"executors": {
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/tsc.impl",
"schema": "./src/executors/tsc/schema.json"
}
}
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/next/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextNgInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Init Next 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",
"x-priority": "internal"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Init Next Plugin",
"type": "object"
} | MIT | en |
Subsets and Splits