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 | 4eb7cc7bf170cd48dd87fdd0dd387d3592beec69 | 2023-03-31T15:22:18 | packages/react-native/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookStories",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a React Native project.",
"properties": {
"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"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-prompt": "For which project do you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate React Native Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | 8826a7737dd0d23a6da9a634b5511a4f8fa07919 | 2023-10-12T16:49:45 | 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"
}
],
"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 | 678818a58b37bb395415665232f7acaac4bd21f6 | 2021-05-12T16:20:12 | 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",
"examples": [
{
"command": "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 | dcef0770325d40d8a41f5841c179ffeb6a1b2549 | 2024-01-16T13:44:38 | packages/remix/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initialize the Remix Plugin.",
"properties": {
"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 Remix Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a97212b6014c6188552b895d29261426c34fdfb9 | 2023-02-16T16:17:30 | 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",
"none"
],
"type": "string"
},
"skipBabelConfig": {
"default": false,
"description": "Do not generate a root babel.config.json (if babel is not needed).",
"type": "boolean"
},
"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 | 9477e5472e7180c2e136ca0056641717ae96d979 | 2021-06-08T08:13:43 | packages/angular/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsAngularModuleInit",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "NOTE: Does not work in the --dry-run mode",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing after adding @nrwl/workspace",
"type": "boolean"
},
"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 | bc53592ad6424e4a48cd905b821421ad2693a6a0 | 2022-10-12T21:30:11 | 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 | aa7625b76fcd3f53f6eda91220ecfd0a549928de | 2023-10-17T22:14:36 | packages/nest/src/generators/resource/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResourceGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Resource Options Schema.",
"properties": {
"crud": {
"default": true,
"description": "When true, CRUD entry points are generated.",
"type": "boolean",
"x-prompt": {
"message": "Would you like to generate CRUD entry points?",
"type": "confirmation"
}
},
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. 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 class language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resource.",
"type": "string",
"x-prompt": "What name would you like to use for this resource (plural, e.g., `users`)?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
},
"type": {
"default": "rest",
"description": "The transport layer.",
"enum": [
"rest",
"graphql-code-first",
"graphql-schema-first",
"microservice",
"ws"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "REST API",
"value": "rest"
},
{
"label": "GraphQL (code first)",
"value": "graphql-code-first"
},
{
"label": "GraphQL (schema first)",
"value": "graphql-schema-first"
},
{
"label": "Microservice (non-HTTP)",
"value": "microservice"
},
{
"label": "WebSockets",
"value": "ws"
}
],
"message": "What transport layer do you use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Resource Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/middleware/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestMiddlewareGenerator",
"$schema": "https://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 | bfa06ce8b088d3071eeb1f10f09cbdeaf0458562 | 2021-08-20T18:10:00 | packages/workspace/src/generators/npm-package/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNpmPackage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Package name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name of your npm package?"
}
},
"required": [
"name"
],
"title": "Add a minimal npm package",
"type": "object"
} | MIT | en |
nrwl/nx | 46b37673038af7d655186d42d56b21dad01b33e7 | 2023-03-10T16:19:55 | 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.",
"pattern": "^[a-zA-Z].*$",
"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": {
"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 Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 29a9f8eba8ccc11aabdbf144314e8f20bc7e83ef | 2023-07-19T14:42:13 | packages/angular/src/generators/component-story/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularComponentStoryGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates a `stories.ts` file for an Angular component.",
"properties": {
"componentFileName": {
"description": "Component file name without the `.ts` extension.",
"examples": [
"awesome.component"
],
"type": "string",
"x-priority": "important"
},
"componentName": {
"description": "Class name of the component.",
"examples": [
"AwesomeComponent"
],
"type": "string",
"x-priority": "important"
},
"componentPath": {
"description": "Relative path to the component file from the project root.",
"examples": [
"awesome"
],
"type": "string",
"x-priority": "important"
},
"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?"
},
"projectPath": {
"description": "Path to the project.",
"examples": [
"libs/ui-samples"
],
"type": "string",
"x-priority": "important"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"projectPath",
"componentName",
"componentPath",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 1dcb80d447f115c0054b8782fdf1a2dd118d0cdd | 2023-08-02T15:59:00 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular application.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"bundler": {
"default": "webpack",
"description": "Bundler to use to build the application.",
"enum": [
"webpack",
"esbuild"
],
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a Angular app with a minimal setup.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"description": "Generate an application that is setup to use standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean",
"x-priority": "important"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/resource/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResourceGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Resource Options Schema.",
"properties": {
"crud": {
"default": true,
"description": "When true, CRUD entry points are generated.",
"type": "boolean",
"x-prompt": {
"message": "Would you like to generate CRUD entry points?",
"type": "confirmation"
}
},
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest class language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resource.",
"type": "string",
"x-prompt": "What name would you like to use for this resource (plural, e.g., `users`)?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
},
"type": {
"default": "rest",
"description": "The transport layer.",
"enum": [
"rest",
"graphql-code-first",
"graphql-schema-first",
"microservice",
"ws"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "REST API",
"value": "rest"
},
{
"label": "GraphQL (code first)",
"value": "graphql-code-first"
},
{
"label": "GraphQL (schema first)",
"value": "graphql-schema-first"
},
{
"label": "Microservice (non-HTTP)",
"value": "microservice"
},
{
"label": "WebSockets",
"value": "ws"
}
],
"message": "What transport layer do you use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Resource Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 9116c29c1848c08c77d425ce62c959b93c45e3b8 | 2023-09-18T19:11:44 | packages/js/src/generators/release-version/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJSReleaseVersionGenerator",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "DO NOT INVOKE DIRECTLY WITH `nx generate`. Use `nx release version` instead.",
"properties": {
"currentVersionResolver": {
"default": "disk",
"description": "Which approach to use to determine the current version of the project.",
"enum": [
"registry",
"disk"
],
"type": "string"
},
"currentVersionResolverMetadata": {
"default": {},
"description": "Additional metadata to pass to the current version resolver.",
"type": "object"
},
"packageRoot": {
"description": "The root directory of the directory (containing a manifest file at its root) to publish. Defaults to the project root",
"type": "string"
},
"preid": {
"description": "The optional prerelease identifier to apply to the version, in the case that specifier has been set to prerelease.",
"type": "string"
},
"projectGraph": {
"description": "ProjectGraph instance",
"type": "object"
},
"projects": {
"description": "The ProjectGraphProjectNodes being versioned in the current execution.",
"items": {
"type": "object"
},
"type": "array"
},
"specifier": {
"description": "Exact version or semver keyword to apply to the selected release group. NOTE: This should be set on the release group level, not the project level.",
"type": "string"
}
},
"required": [
"projects",
"projectGraph",
"specifier"
],
"title": "Implementation details of `nx release version`",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/node/src/generators/setup-docker/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxSetupDocker",
"$schema": "https://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"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project",
"type": "string",
"x-priority": "important",
"x-prompt": "What project would you like to add a Dockerfile to?"
},
"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 | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | 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": [
"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 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 | 6093247df2be83fd065470cb716a2594cfca7582 | 2023-01-26T16:02:12 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite"
],
"type": "string"
},
"cli": {
"description": "CLI powering the workspace.",
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"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": {
"description": "The name of the application.",
"type": "string"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "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"
}
}
},
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | ed7db7c1149cd229321aa3dc29c546edad4f8079 | 2022-09-20T16:05:58 | packages/esbuild/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebpackInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init 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"
}
},
"required": [],
"title": "Init Webpack Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 6141f44203898277adb8244db4200fcc3cea207f | 2024-01-17T19:22:58 | 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": {
"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"
}
},
"required": [],
"title": "Add Detox Schematics",
"type": "object"
} | MIT | en |
nrwl/nx | 5e51cd6eb5e3555c0e6565608424fe2bb03082b1 | 2023-08-02T20:14:17 | packages/playwright/src/executors/playwright/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Run Playwright tests.",
"properties": {
"browser": {
"description": "Browser to use for tests, one of 'all', 'chromium', 'firefox' or 'webkit'. If a playwright config is provided/discovered then the browserName value is expected from the configured 'projects'",
"type": "string",
"x-priority": "important"
},
"config": {
"description": "Configuration file, or a test directory with optional",
"type": "string",
"x-completion-glob": "playwright?(*)@(.js|.cjs|.mjs|.ts|.cts|.mtx)",
"x-completion-type": "file",
"x-priority": "important"
},
"debug": {
"description": "Run tests with Playwright Inspector. Shortcut for 'PWDEBUG=1' environment variable and '--timeout=0',--max-failures=1 --headed --workers=1' options",
"type": "boolean"
},
"forbidOnly": {
"description": "Fail if test.only is called",
"type": "boolean"
},
"fullyParallel": {
"description": "Run all tests in parallel",
"type": "boolean"
},
"globalTimeout": {
"description": "Maximum time this test suite can run in milliseconds",
"type": "number"
},
"grep": {
"alias": "g",
"description": "Only run tests matching this regular expression",
"type": "string"
},
"grepInvert": {
"alias": "gv",
"description": "Only run tests that do not match this regular expression",
"type": "string"
},
"headed": {
"description": "Run tests in headed browsers",
"type": "boolean",
"x-priority": "important"
},
"ignoreSnapshots": {
"description": "Ignore screenshot and snapshot expectations",
"type": "boolean"
},
"list": {
"description": "Collect all the tests and report them, but do not run",
"type": "boolean"
},
"maxFailures": {
"alias": "x",
"description": "Stop after the first N failures",
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"noDeps": {
"description": "Do not run project dependencies",
"type": "boolean"
},
"output": {
"description": "Folder for output artifacts",
"type": "string"
},
"passWithNoTests": {
"default": true,
"description": "Makes test run succeed even if no tests were found",
"type": "boolean"
},
"project": {
"description": "Only run tests from the specified list of projects",
"items": {
"type": "string"
},
"type": "array"
},
"quiet": {
"alias": "q",
"description": "Suppress stdio",
"type": "boolean"
},
"repeatEach": {
"description": "Run each test N times",
"type": "number"
},
"reporter": {
"description": "Reporter to use, comma-separated, can be 'list', 'line', 'dot', 'json', 'junit', 'null', 'github', 'html', 'blob'. To configure reporter options, use the playwright configuration.",
"enum": [
"list",
"line",
"dot",
"json",
"junit",
"null",
"github",
"html",
"blob"
],
"type": "string"
},
"retries": {
"description": "Maximum retry count for flaky tests, zero for no retries",
"type": "number"
},
"shard": {
"description": "Shard tests and execute only the selected shard, specify in the form 'current/all', 1-based, for example '3/5'",
"type": "string"
},
"skipInstall": {
"default": false,
"description": "Skip running playwright install before running playwright tests. This is to ensure that playwright browsers are installed before running tests.",
"type": "boolean"
},
"timeout": {
"description": "Specify test timeout threshold in milliseconds, zero for unlimited",
"type": "number"
},
"trace": {
"description": "Force tracing mode, can be 'on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure'",
"enum": [
"on",
"off",
"on-first-retry",
"on-all-retries",
"retain-on-failure"
],
"type": "string"
},
"ui": {
"description": "Run tests in interactive UI mode",
"type": "boolean"
},
"uiHost": {
"description": "Host to serve UI on; specifying this option opens UI in a browser tab",
"type": "string"
},
"uiPort": {
"description": "Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab",
"type": "string"
},
"updateSnapshots": {
"alias": "u",
"description": "Update snapshots with actual results. Snapshots will be created if missing.",
"type": "boolean"
},
"workers": {
"alias": "j",
"description": "Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker",
"type": "string"
}
},
"required": [],
"title": "Playwright executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | d70b9ec7c61f6972f1834620b5732d6a499cf4c8 | 2023-01-26T00:41:22 | packages/workspace/src/generators/convert-to-nx-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsConvertToNxProject",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a custom target to run any command.",
"examples": [
{
"command": "nx g @nrwl/workspace:convert-to-nx-project --project my-feature-lib",
"description": "Convert the `my-feature-lib` project to use `project.json` file instead of `workspace.json`"
},
{
"command": "nx g @nrwl/workspace:convert-to-nx-project --all",
"description": "Convert all projects in `workspace.json` to separate `project.json` files"
}
],
"properties": {
"all": {
"description": "Convert all projects",
"type": "boolean"
},
"project": {
"description": "Convert a single project",
"type": "string"
},
"reformat": {
"description": "Just reformats the configuration",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
}
},
"title": "Create a custom target to run any command",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/decorator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestDecoratorGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Decorator 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 decorator language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the decorator.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Nest Decorator Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | e71cef0ba9db87823cfa94fbe74550a1e20761d0 | 2021-02-11T05:39:49 | packages/next/src/generators/page/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"examples": [
{
"command": "g component my-component --project=mylib",
"description": "Generate a component in the mylib library"
},
{
"command": "g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the mylib library"
}
],
"id": "NxReactApp",
"properties": {
"directory": {
"alias": "d",
"description": "Create the page under this directory (can be nested). Will be created under 'pages/'.",
"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?"
},
"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"
}
},
"withTests": {
"default": false,
"description": "When true, creates a \"spec.ts\" test file for the new page.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Create a Page for Next",
"type": "object"
} | MIT | en |
nrwl/nx | f1911a71f3ccecd26ecde0c1c1c765e89df04e17 | 2021-06-23T00:30:38 | packages/next/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g app myapp --directory=myorg",
"description": "Generate apps/myorg/myapp and apps/myorg/myapp-e2e"
}
],
"properties": {
"directory": {
"alias": "d",
"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"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"server": {
"description": "The server script path to be used with next.",
"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"
},
"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": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"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"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Next.js Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | b4c4501979de85aa975b4f5119d9988f51478007 | 2022-08-01T18:25:26 | 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.",
"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?"
},
"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?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | 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`.",
"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"
}
},
"required": [
"project"
],
"title": "Generate Angular Universal (SSR) setup for an Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | b0732e1554090a5f75f0a3f7d6c4732cd1d95c24 | 2023-05-31T14:28:23 | 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 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-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"
},
"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) [ 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 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 | 6141f44203898277adb8244db4200fcc3cea207f | 2024-01-17T19:22:58 | packages/vue/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initialize a Vue 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 Vue Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | f04f316271645304c19ad01c6145792cebb9f926 | 2023-04-19T18:00:24 | 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",
"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-priority": "important",
"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",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"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"
},
"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": [],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | b311cbf8e33a9c11740bcda291a9f76e4ca19352 | 2023-07-21T15:09:09 | 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"
},
"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"
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean"
},
"generateStories": {
"default": true,
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/web/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Init Web 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 Web Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 8154191eb1042b15ef2e477f6901b119009b07a9 | 2022-07-08T19:34:00 | packages/react/src/generators/cypress-component-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactCypressComponentTestConfiguration",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress component testing configuration to an existing project.",
"examples": [
{
"command": "nx g @nrwl/react:cypress-component-configuration --project=my-react-project",
"description": "Add component testing to your react project"
},
{
"command": "nx g @nrwl/react:cypress-component-configuration --project=my-react-project --generate-tests",
"description": "Add component testing to your react project and generate component tests for your existing components"
}
],
"properties": {
"generateTests": {
"default": false,
"description": "Generate default component tests for existing components in the project",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project to add cypress component testing configuration to",
"type": "string",
"x-prompt": "What project should we add Cypress component testing to?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Add Cypress component testing",
"type": "object"
} | MIT | en |
nrwl/nx | 3b5bf6d1d177188017d0c92d251bcd61a62686b4 | 2023-12-13T16:07:08 | packages/remix/src/generators/route/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixRoute",
"$schema": "http://json-schema.org/schema",
"description": "Generate a route.",
"examples": [
{
"command": "g route 'path/to/page'",
"description": "Generate route at /path/to/page"
}
],
"properties": {
"action": {
"default": false,
"description": "Generate an action function",
"type": "boolean"
},
"loader": {
"default": false,
"description": "Generate a loader function",
"type": "boolean"
},
"meta": {
"default": false,
"description": "Generate a meta function",
"type": "boolean"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the route in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and path relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar')"
},
"project": {
"$default": {
"$source": "projectName"
},
"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.",
"x-prompt": "What project is this route for?"
},
"skipChecks": {
"default": false,
"description": "Skip route error detection",
"type": "boolean"
},
"style": {
"default": "css",
"description": "Generate a stylesheet",
"enum": [
"none",
"css"
],
"type": "string"
}
},
"required": [
"path"
],
"title": "Create a Route",
"type": "object"
} | MIT | en |
nrwl/nx | f1911a71f3ccecd26ecde0c1c1c765e89df04e17 | 2021-06-23T00:30:38 | 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",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"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"
},
"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": false,
"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 | 95421c6945df2db7d32d6d815c25da7add1233b0 | 2023-05-12T20:09:20 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack",
"esbuild"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"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"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"preset",
"name"
],
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | packages/nest/src/generators/module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestModuleGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"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 | 726877d103fdd4e2e7694bb86938798842df1417 | 2021-12-15T17:23:50 | 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"
},
"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 | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/guard/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGuardGenerator",
"$schema": "http://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.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"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?"
},
"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 Guard Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | d0c6f5d31741c28b87f753039d3e93cb24b7c135 | 2023-05-11T15:21:53 | packages/angular/src/generators/ngrx/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNgrxGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds NgRx support to an application or library.",
"examples": [
{
"command": "nx g @nx/angular:ngrx --root --parent=apps/my-app/src/app/app.module.ts --facade=false placeholder",
"description": "Add root ngrx configration to the `my-app` application"
},
{
"command": "nx g @nx/angular:ngrx --parent=libs/my-lib/src/lib/my-lib.module.ts --facade=true --root=false users",
"description": "Add a `users` state with a facade to the `my-lib` library. It will be tracked under the default `+state` folder in the lib"
},
{
"command": "nx g @nx/angular:ngrx --parent=apps/my-app/src/app/app.config.ts --root",
"description": "Add a root state configuration to `my-app` when `my-app` uses Standalone APIs"
},
{
"command": "nx g @nx/angular:ngrx --parent=libs/my-lib/src/lib.routes.ts users",
"description": "Add a `users` feature state to the Route definition of a library using Standalone APIs"
}
],
"properties": {
"barrels": {
"default": false,
"description": "Use barrels to re-export actions, state and selectors.",
"type": "boolean"
},
"directory": {
"default": "+state",
"description": "The name of the folder used to contain/group the generated NgRx files.",
"type": "string"
},
"facade": {
"default": false,
"description": "Create a Facade class for the the feature.",
"type": "boolean",
"x-prompt": "Would you like to use a Facade with your NgRx state?"
},
"minimal": {
"default": true,
"description": "Only register the root state management setup or feature state.",
"type": "boolean"
},
"module": {
"description": "The path to the `NgModule` where the feature state will be registered. The host directory will create/use the new state directory.",
"type": "string",
"x-deprecated": "This option will be removed in a future version of Nx. Please switch to using --parent instead."
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.",
"type": "string",
"x-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 `app.module.ts` for your root state, or your Feature Module for feature state. For Standalone API usage, this will be your `app.config.ts` file for your root state, or the Routes definition file for your feature state. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?"
},
"root": {
"default": false,
"description": "Setup root or feature state management with NgRx.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Is this the root state of the application?"
},
"route": {
"default": "''",
"description": "The route that the Standalone NgRx Providers should be added to. _Note: This is only supported in Angular versions >= 14.1.0_.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"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": "Add NgRx support to an application or library.",
"type": "object",
"x-deprecated": "This generator is deprecated and will be removed in a future version of Nx. Use the 'ngrx-root-store' and 'ngrx-feature-store' generators instead."
} | MIT | en |
nrwl/nx | e5212ec4430c5905df957f0f15f0d2a348848b42 | 2022-03-25T19:08:08 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Library for an Nx workspace",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate `libs/myapp/mylib`"
},
{
"command": "nx g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to `myapp`"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "Which compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When `true`, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library",
"type": "object"
} | MIT | en |
nrwl/nx | 204c5cb5d83649841a93fb5193319a8bbfda216b | 2022-10-15T12:45:59 | 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.",
"examplesFile": "../../../docs/custom-server-examples.md",
"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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/action/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "action",
"$schema": "https://json-schema.org/schema",
"description": "Generate an action for a given route.",
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the action 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"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | cf7a18bd14244d7779b5603d42afff335130179e | 2022-02-01T21:32:47 | packages/cypress/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"title": "Add Cypress Configuration to the workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 9be869ff7bf7c39bfa05c35bb5cd9f73ba34ed2d | 2023-10-10T14:36:28 | 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 @nx/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",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"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"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remotes": {
"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"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"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 | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | packages/cypress/src/generators/migrate-to-cypress-11/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressMigrateTo11",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Migrate Cypress e2e project from v8/v9 to Cypress v11.",
"examples": [
{
"command": "nx g @nx/cypress:migrate-to-cypress-11",
"description": "Migrate existing cypress projects to Cypress v11"
}
],
"properties": {},
"title": "Migrate e2e project to Cypress 11",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/express/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxExpressApp",
"$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"
},
"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"
],
"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"
},
"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"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"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": [],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/plugin/src/generators/migration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginMigration",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Migration for an Nx Plugin.",
"examples": [
{
"command": "nx g migration my-migration --project=my-plugin --version=1.0.0",
"description": "Adds a new migration to the project `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
}
],
"properties": {
"description": {
"description": "Migration description.",
"type": "string"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the migration file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Migration name.",
"type": "string",
"x-priority": "important"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the migration in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"packageJsonUpdates": {
"alias": "p",
"default": false,
"description": "Whether or not to include `package.json` updates.",
"type": "boolean"
},
"packageVersion": {
"alias": "v",
"description": "Version to use for the migration.",
"type": "string",
"x-priority": "important",
"x-prompt": "What version would you like to use for the migration?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipLintChecks": {
"default": false,
"description": "Do not eslint configuration for plugin json files.",
"type": "boolean"
}
},
"required": [
"packageVersion"
],
"title": "Create a Migration for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | 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 v19."
},
"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 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 Service Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react-native/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookStories",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a React Native project.",
"properties": {
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-prompt": "For which project do you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate React Native Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | 949466f02ba188c0da8bb5f4abfc6b4e71e4b49c | 2023-10-17T20:33:04 | packages/next/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Next.js Application for Nx.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"appDir": {
"default": true,
"description": "Enable the App Router for this project.",
"type": "boolean",
"x-prompt": "Would you like to use the App Router (recommended)?"
},
"customServer": {
"default": false,
"description": "Use a custom Express server for the Next.js application.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"swc": {
"default": true,
"description": "Enable the Rust-based compiler SWC to compile JS/TS files.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Next.js Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | f394608658fb19e46c82fc120de612fdc840026b | 2022-11-21T18:18:40 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "http://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-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"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": [
"cypress",
"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 application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the 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"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "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 | 9579aec307620f4b4caccc934443c152842a2851 | 2022-04-05T16:16:25 | 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.",
"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?"
},
"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 `*.spec.ts` files in the generated Cypress e2e app.",
"type": "boolean",
"x-prompt": "Automatically generate *.spec.ts 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?"
},
"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 project.",
"type": "string"
},
"projectBuildConfig": {
"description": "Provide a custom projectBuildConfig for the Angular executor. If left blank, Nx will use the default.",
"type": "string"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 277bdd22551bf1abfdaf1fc26820850f7072d09b | 2021-07-01T09:11:36 | 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",
"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"
}
},
"required": [
"projectName",
"projectPath",
"componentName",
"componentPath",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 17e6db55688b249962ad28ae2857890814f68ab0 | 2023-05-04T15:02:18 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds Storybook configuration to a project to be able to use and create stories.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"default": true,
"description": "Specifies whether to configure Cypress or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a Cypress e2e app to run against the storybook instance?"
},
"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": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the generated Cypress e2e app?"
},
"generateStories": {
"default": true,
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 901b70a4fec92d2af875acd4f947acc7a91636e4 | 2023-07-25T22:15:26 | packages/plugin/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginPreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initializes a workspace with an nx-plugin inside of it. Use as: `create-nx-plugin` or `create-nx-workspace --preset @nx/nx-plugin`.",
"examples": [
{
"command": "npx create-nx-plugin",
"description": "Creates a new Nx workspace containing an Nx plugin."
},
{
"command": "npx create-nx-workspace --preset @nx/plugin",
"description": "Creates a new Nx workspace containing an Nx plugin."
}
],
"properties": {
"createPackageName": {
"description": "Name of package which creates a workspace",
"type": "string"
},
"pluginName": {
"aliases": [
"name"
],
"description": "Plugin name",
"type": "string"
}
},
"required": [
"pluginName"
],
"title": "Generator ran by create-nx-plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 2f7d647f52a2ab99aef880c0e0c9523ee51f3161 | 2022-09-27T17:03:23 | 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",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a web application using `swc` or `babel` as compiler.",
"properties": {
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"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": [
"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].*$",
"type": "string",
"x-prompt": "What name would you like to use for the 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"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/angular/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookStoriesGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates Storybook stories/specs for all Angular components declared in a project.",
"examplesFile": "../../../docs/stories-examples.md",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `name` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.",
"type": "boolean"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What's the name of the project for which you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"name"
],
"title": "Create Storybook stories/specs",
"type": "object"
} | MIT | en |
nrwl/nx | 212fb00548ee91d56ba01ed03cd5abd605b803aa | 2021-03-25T00:11:32 | packages/react/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"
},
{
"command": "g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to myapp"
}
],
"id": "NxReactLibrary",
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "d",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '*.css' rather than '*.module.css').",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"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": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | 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",
"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 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"
},
"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 | d20cf91e6c5e1b71fb8af4e6413d27b15e82d2ce | 2023-01-13T16:50:01 | 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 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. Only applies to `bundler: 'rollup'`.",
"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-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"
},
"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"
},
"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 | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/react-native/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React-Native app or library",
"properties": {
"generateStories": {
"default": true,
"description": "Automatically generate *.stories.ts files for components declared in this project?",
"type": "boolean",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"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": "Project name.",
"type": "string"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React native Storybook configuration",
"type": "object"
} | MIT | en |
nrwl/nx | ec633e3dfbc1f1cb5a0ed4c42990b15f11d1e13a | 2021-10-01T22:19:43 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"cli": {
"default": "nx",
"description": "CLI used for generating code and running tasks",
"enum": [
"nx",
"angular"
],
"type": "string"
},
"commit": {
"default": true,
"description": "Initial repository commit information.",
"oneOf": [
{
"type": "boolean"
},
{
"properties": {
"email": {
"format": "email",
"type": "string"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"email"
],
"type": "object"
}
]
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"tslint",
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"nxCloud": {
"default": false,
"description": "Connect the workspace to the free tier of the distributed cache provided by Nx Cloud",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace",
"type": "string"
},
"skipGit": {
"alias": "g",
"default": false,
"description": "Skip initializing a git repository.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | b994a297a9175d0758da2c130ecdbe4e229cc719 | 2023-10-18T20:27:29 | packages/react-native/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookStories",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a React Native project.",
"properties": {
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-prompt": "For which project do you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate React Native Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | 54670c93e0e35b041d0b6a2d1a0057e5ec109782 | 2022-11-15T14:15:19 | packages/vite/src/executors/test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Test using Vitest.",
"examplesFile": "../../../docs/test-examples.md",
"properties": {
"config": {
"description": "The path to the local vitest config",
"type": "string",
"x-completion-glob": "@(vitest|vite).config@(.js|.ts)",
"x-completion-type": "file"
},
"coverage": {
"default": false,
"description": "Enable coverage report",
"type": "boolean"
},
"mode": {
"default": "test",
"description": "The mode that vitest will run on",
"enum": [
"test",
"benchmark",
"typecheck"
],
"type": "string"
},
"passWithNoTests": {
"default": true,
"description": "Pass the test even if no tests are found",
"type": "boolean"
},
"reporters": {
"description": "An array of reporters to pass to vitest",
"items": {
"type": "string"
},
"type": "array"
},
"testNamePattern": {
"description": "Run tests with full names matching the pattern",
"type": "string"
},
"update": {
"alias": "u",
"default": false,
"description": "Update snapshots",
"type": "boolean"
},
"watch": {
"default": false,
"description": "Enable watch mode",
"type": "boolean"
}
},
"required": [],
"title": "Vitest executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 047dc22aed99ee0870357fa1508cd5decb8009a7 | 2024-01-16T14:29:44 | 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": {
"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": "Jest init",
"type": "object"
} | MIT | en |
nrwl/nx | 6a3af4b5a68d5e5de59f6db63cc1711819322ce9 | 2023-05-30T14:10:54 | packages/angular/src/generators/ngrx-root-store/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNgrxRootStoreGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds NgRx support to an application.",
"properties": {
"addDevTools": {
"default": false,
"description": "Instrument the Store Devtools.",
"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 also generate a global feature state.",
"type": "boolean",
"x-priority": "important"
},
"name": {
"description": "Name of the NgRx state, such as `products` or `users`. Recommended to use the plural form of the name.",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the NgRx configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate a NgRx configuration for?"
},
"route": {
"default": "''",
"description": "The route that the Standalone NgRx Providers should be added to. _Note: This is only supported in Angular versions >= 14.1.0_.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"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": [
"project"
],
"title": "Add NgRx support to an application.",
"type": "object"
} | MIT | en |
nrwl/nx | 678818a58b37bb395415665232f7acaac4bd21f6 | 2021-05-12T16:20:12 | 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"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to package.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 | 5378128851eaea8a130eb7d1b94a3326453d5015 | 2022-03-29T15:45:19 | 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",
"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"
},
"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"
},
"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"
},
"mfe": {
"default": false,
"description": "Generate a Module Federation configuration for the application",
"type": "boolean"
},
"mfeType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"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"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"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 | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | packages/plugin/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginPreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initializes a workspace with an nx-plugin inside of it. Use as: `create-nx-plugin` or `create-nx-workspace --preset @nx/nx-plugin`.",
"properties": {
"createPackageName": {
"description": "Name of package which creates a workspace",
"type": "string"
},
"pluginName": {
"aliases": [
"name"
],
"description": "Plugin name",
"type": "string"
}
},
"required": [
"pluginName"
],
"title": "Generator ran by create-nx-plugin",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/interceptor/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInterceptorGenerator",
"$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 interceptor language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the interceptor.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"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 Interceptor Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/nest/src/generators/pipe/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestPipeGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Pipe 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 v19."
},
"language": {
"description": "Nest pipe language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the pipe.",
"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 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 Pipe Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 6b928bc250406aa5c31cb56b07361596d64e90dd | 2023-05-15T20:06:24 | packages/angular/src/generators/ng-add/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularNgAddGenerator",
"$schema": "http://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"
},
"npmScope": {
"description": "Npm scope for importing libs. NOTE: only used if running the generator in an Angular CLI workspace.",
"type": "string",
"x-deprecated": "This will be inferred from your root package.json"
},
"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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/vite/src/executors/preview-server/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"definitions": {},
"description": "Preview Server for Vite.",
"examplesFile": "../../../docs/preview-server-examples.md",
"presets": [
{
"keys": [
"buildTarget"
],
"name": "Default minimum setup"
},
{
"keys": [
"buildTarget",
"port"
],
"name": "Using a Different Port"
}
],
"properties": {
"buildTarget": {
"description": "Target which builds the application.",
"type": "string"
},
"proxyConfig": {
"description": "Path to the proxy configuration file.",
"type": "string",
"x-completion-type": "file"
},
"staticFilePath": {
"description": "Path where the build artifacts are located. If not provided then it will be infered from the buildTarget executor options as outputPath",
"type": "string",
"x-completion-type": "directory"
}
},
"required": [
"buildTarget"
],
"title": "Vite Preview Server",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 3b384c78ac3d94b92b1233c251edcdcf203a5826 | 2024-02-14T17:51:37 | packages/react/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactRemote",
"$schema": "https://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",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean",
"x-priority": "internal"
},
"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"
},
"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"
},
"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"
},
"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"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "tailwind [ https://tailwindcss.com/ ]",
"value": "tailwind"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS. When --js is used, this flag is ignored.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | 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": {
"alias": "d",
"description": "Create the hook under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the hook is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this hook be exported in the project?"
},
"flat": {
"default": false,
"description": "Create hook at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the hook.",
"type": "string",
"x-prompt": "What name would you like to use for the hook?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `useHook/useHook.ts`).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case hook file name (e.g. `useHook.ts`).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this hook?"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new hook.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Create a React Hook for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestApplicationGenerator",
"$schema": "https://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 | 5e0cb7cf595aa552d250a341dfd8b1d63ba9c773 | 2023-03-14T19:11:26 | 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"
},
"storybook7Configuration": {
"aliases": [
"storybook7betaConfiguration"
],
"default": false,
"description": "Configure your workspace using Storybook version 7.",
"hidden": true,
"type": "boolean"
},
"storybook7UiFramework": {
"description": "Storybook UI Framework to use, for Storybook version 7.",
"enum": [
"@storybook/angular",
"@storybook/html-webpack5",
"@storybook/nextjs",
"@storybook/preact-webpack5",
"@storybook/react-webpack5",
"@storybook/react-vite",
"@storybook/server-webpack5",
"@storybook/svelte-webpack5",
"@storybook/svelte-vite",
"@storybook/sveltekit",
"@storybook/vue-webpack5",
"@storybook/vue-vite",
"@storybook/vue3-webpack5",
"@storybook/vue3-vite",
"@storybook/web-components-webpack5",
"@storybook/web-components-vite"
],
"hidden": true,
"type": "string"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
},
"uiFramework": {
"description": "Storybook UI Framework to use.",
"enum": [
"@storybook/angular",
"@storybook/react",
"@storybook/react-native",
"@storybook/html",
"@storybook/web-components",
"@storybook/vue",
"@storybook/vue3",
"@storybook/svelte"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What UI framework plugin should storybook use?"
}
},
"required": [
"name"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 3e94d4cb3ad98b032c853e3a23f96a76ca7ae5ed | 2022-04-11T13:47:08 | packages/js/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init generator placeholder for nrwl/js",
"title": "Init nrwl/js"
} | MIT | en |
nrwl/nx | 8ccd88cfcb78964f828c3839c2d3912cf2fb4954 | 2023-10-06T20:54:29 | 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",
"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.",
"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?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-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"
}
},
"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 | d9aef75bd564cb2cec0bdbb5929b63bef2a65585 | 2021-02-11T02:30:55 | packages/react/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "NxReactNgInit",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified e2e test runner.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init React Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | c43b22dc887b10d527aa3a11e7f7af2a9961e7f8 | 2024-01-17T18:22:51 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack",
"esbuild"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"playwright",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"nextAppDir": {
"default": true,
"description": "Enable the App Router for this project.",
"type": "boolean"
},
"nextSrcDir": {
"default": true,
"description": "Generate a `src` directory for this project.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "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) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"preset",
"name"
],
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 724b0c0e3cc05232c29e6ad0accc1cf58ae254a1 | 2021-10-13T04:34:28 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g app myapp --directory=myorg",
"description": "Generate apps/myorg/myapp and apps/myorg/myapp-e2e"
},
{
"command": "g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "g app myapp --routing",
"description": "Set up React Router"
}
],
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a React Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 037c1b94b85c1e8a2fd5beca2f6b837d10816d3e | 2021-01-28T23:52:08 | packages/cypress/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "NxCypressInit",
"properties": {},
"title": "Add Cypress Configuration to the workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 626605ef9741180c1bd75986eedcdf1c91e7fed3 | 2023-12-18T16:05:44 | packages/angular/src/generators/library-secondary-entry-point/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularLibrarySecondaryEntryPoint",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates a secondary entry point for an Angular publishable library.",
"examplesFile": "../../../docs/library-secondary-entry-point-examples.md",
"properties": {
"library": {
"description": "The name of the library to create the secondary entry point for.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What library would you like to create the secondary entry point for?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the secondary entry point.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the secondary entry point?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipModule": {
"default": false,
"description": "Skip generating a module for the secondary entry point.",
"type": "boolean"
}
},
"required": [
"name",
"library"
],
"title": "Creates a secondary entry point for a library",
"type": "object"
} | MIT | en |
nrwl/nx | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | packages/angular/src/generators/component-test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularComponentTestGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a `*.cy.ts` file for Cypress component testing for an Angular component.",
"examplesFile": "../../../docs/component-test-examples.md",
"properties": {
"componentDir": {
"description": "Relative path to the folder that contains the component from the project root.",
"examples": [
"src/lib/my-fancy-button"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What is the path to the component directory from the project root?"
},
"componentFileName": {
"description": "File name that contains the component without the `.ts` extension.",
"examples": [
"my-fancy-button.component"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What is the file name that contains the component?"
},
"componentName": {
"description": "Class name of the component to create a test for.",
"examples": [
"MyFancyButtonComponent"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What is the class name of the component to create a test for?"
},
"project": {
"description": "The name of the project where the component is located.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project is the component located in?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project",
"componentName",
"componentDir",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 5e0cb7cf595aa552d250a341dfd8b1d63ba9c773 | 2023-03-14T19:11:26 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds Storybook configuration to a project to be able to use and create stories.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"default": true,
"description": "Specifies whether to configure Cypress or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a Cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the generated Cypress e2e app?"
},
"generateStories": {
"default": true,
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"storybook7Configuration": {
"aliases": [
"storybook7betaConfiguration"
],
"default": false,
"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",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | b311cbf8e33a9c11740bcda291a9f76e4ca19352 | 2023-07-21T15:09:09 | 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"
},
"generateCypressSpecs": {
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean"
},
"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 | dbe2c3b1e6c65951e1bf75b30d6c8a849420474c | 2023-01-20T13:18:32 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite"
],
"type": "string"
},
"cli": {
"description": "CLI powering the workspace.",
"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": {
"description": "The name of the application.",
"type": "string"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"standaloneConfig": {
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "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"
}
}
},
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | b6cbb2ac6db6eec82e4b7db22fb2cf95f746baa3 | 2024-01-12T18:46:10 | packages/remix/src/generators/style/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixRouteStyle",
"$schema": "http://json-schema.org/schema",
"description": "Generate a style import and file for a given route.",
"examples": [
{
"command": "g style --path='apps/demo/app/routes/path/to/page.tsx'",
"description": "Generate route at apps/demo/app/routes/path/to/page.tsx"
}
],
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the styles in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Route path",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
}
},
"required": [
"path"
],
"title": "Add style import to a route",
"type": "object"
} | MIT | en |
nrwl/nx | 1fc52349a7ccaeeb5791a4ea157ca6b5594d2439 | 2022-10-09T12:49:29 | packages/angular/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularLibrary",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular library.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"addModuleSpec": {
"default": false,
"description": "Add a module spec file.",
"type": "boolean"
},
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application. It can only be used with buildable and publishable libraries. Non-buildable libraries will use the application's Tailwind configuration.",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"changeDetection": {
"alias": "c",
"default": "Default",
"description": "The change detection strategy to use in the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"enum": [
"Default",
"OnPush"
],
"type": "string"
},
"compilationMode": {
"description": "Specifies the compilation mode to use. If not specified, it will default to `partial` for publishable libraries and to `full` for buildable libraries. The `full` value can not be used for publishable libraries.",
"enum": [
"full",
"partial"
],
"type": "string"
},
"directory": {
"description": "A directory where the library is placed.",
"type": "string"
},
"displayBlock": {
"alias": "b",
"default": false,
"description": "Specifies if the component generated style will contain `:host { display: block; }`. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"lazy": {
"default": false,
"description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false.",
"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 library.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"parent": {
"description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to.",
"type": "string"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Add router configuration. See `lazy` for more information.",
"type": "boolean"
},
"selector": {
"description": "The HTML selector to use for this component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"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"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using `--directory`).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipModule": {
"default": false,
"description": "Whether to skip the creation of a default module when generating the library.",
"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"
},
"skipSelector": {
"default": false,
"description": "Specifies if the component should have a selector or not. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"skipTests": {
"default": false,
"description": "Do not create `spec.ts` test files for the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Generate a library that uses a standalone component instead of a module as the entry point.",
"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 a library with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension or preprocessor to use for style files, or `none` to skip generating the style file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"enum": [
"css",
"scss",
"sass",
"less",
"none"
],
"type": "string"
},
"tags": {
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"alias": "v",
"description": "The view encapsulation strategy to use in the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a library",
"type": "object"
} | MIT | en |
nrwl/nx | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
},
{
"command": "g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to myapp"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "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"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | aa7625b76fcd3f53f6eda91220ecfd0a549928de | 2023-10-17T22:14:36 | 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",
"description": "Nest Controller 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 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?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Controller Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 5e0cb7cf595aa552d250a341dfd8b1d63ba9c773 | 2023-03-14T19:11:26 | 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?"
},
"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": false,
"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 | 09c6ccb2666f98014a206e23187a2794642a579c | 2022-09-28T15:08:01 | 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"
}
],
"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"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"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"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/workspace/src/generators/ci-workflow/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceCIWorkflow",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Generate a CI workflow.",
"properties": {
"ci": {
"description": "CI provider.",
"enum": [
"github",
"circleci",
"azure",
"bitbucket-pipelines",
"gitlab"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "GitHub Actions",
"value": "github"
},
{
"label": "Circle CI",
"value": "circleci"
},
{
"label": "Azure DevOps",
"value": "azure"
},
{
"label": "BitBucket Pipelines",
"value": "bitbucket-pipelines"
},
{
"label": "Gitlab",
"value": "gitlab"
}
],
"message": "What is your target CI provider?",
"type": "list"
}
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"default": "CI",
"description": "Workflow name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "How should we name your workflow?"
}
},
"required": [
"ci",
"name"
],
"title": "Generate a CI workflow.",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react/src/generators/component-story/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponentStory",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Generate storybook story for a react component.",
"properties": {
"componentPath": {
"description": "Relative path to the component file from the library root.",
"examples": [
"lib/components"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What's path of the component relative to the project's lib root?"
},
"interactionTests": {
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "The project where to add the components.",
"examples": [
"shared-ui-component"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What's name of the project where the component lives?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project",
"componentPath"
],
"title": "Create component story",
"type": "object"
} | MIT | en |
nrwl/nx | 3af649dc3ffdbd96b71608e0d7c9f5db870d3cf3 | 2023-03-31T16:20:03 | 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.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"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"
},
"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 | f04f316271645304c19ad01c6145792cebb9f926 | 2023-04-19T18:00:24 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"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"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
Subsets and Splits