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 | 7482944eeaf786edc9db453a0872bbf4432b8caf | 2021-01-14T13:54:38 | packages/jest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "NxJestInit",
"properties": {
"babelJest": {
"alias": "babel-jest",
"default": false,
"description": "Use babel-jest instead of ts-jest",
"type": "boolean"
}
},
"required": [],
"title": "Add Jest Configuration to a workspace",
"type": "object"
} | MIT | en |
nrwl/nx | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | packages/workspace/src/generators/remove/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceRemove",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Remove a project from the workspace.",
"examples": [
{
"command": "nx g @nx/workspace:remove my-feature-lib",
"description": "Remove `my-feature-lib` from the workspace"
},
{
"command": "nx g @nx/workspace:remove my-feature-lib --forceRemove",
"description": "Force removal of `my-feature-lib` from the workspace"
}
],
"properties": {
"forceRemove": {
"aliases": [
"force-remove"
],
"default": false,
"description": "When `true`, forces removal even if the project is still in use.",
"type": "boolean"
},
"importPath": {
"description": "The library name used at creation time",
"type": "string"
},
"projectName": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "project",
"description": "The name of the project to remove.",
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"projectName"
],
"title": "Nx Remove",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/detox/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://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"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Add Detox Schematics",
"type": "object"
} | MIT | en |
nrwl/nx | 6b16230499bc265ebcfd9b9bfedaf5634e65e536 | 2023-09-20T12:57:13 | packages/js/src/executors/release-publish/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "DO NOT INVOKE DIRECTLY WITH `nx run`. Use `nx release publish` instead.",
"properties": {
"dryRun": {
"description": "Whether to run the command without actually publishing the package to the registry.",
"type": "boolean"
},
"packageRoot": {
"description": "The root directory of the directory (containing a manifest file at its root) to publish. Defaults to the project root.",
"type": "string"
},
"registry": {
"description": "The registry to publish the package to.",
"type": "string"
},
"tag": {
"description": "The distribution tag to apply to the published package.",
"type": "string"
}
},
"required": [],
"title": "Implementation details of `nx release publish`",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | 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": {
"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 | 047dc22aed99ee0870357fa1508cd5decb8009a7 | 2024-01-16T14:29:44 | packages/node/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Node Plugin.",
"properties": {
"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 Node Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | fb54f6758103973b530cc729a04df12e5a5c8a3f | 2023-04-20T18:35:04 | packages/plugin/src/generators/plugin/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginPlugin",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Plugin for Nx.",
"examples": [
{
"command": "nx g plugin my-plugin --directory=plugins --importPath=@myorg/my-plugin",
"description": "Generate `libs/plugins/my-plugin`"
}
],
"properties": {
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"directory": {
"description": "A directory where the plugin is placed.",
"type": "string"
},
"e2eTestRunner": {
"default": "none",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"importPath": {
"description": "How the plugin will be published, like `@myorg/my-awesome-plugin`. Note this must be a valid NPM name.",
"type": "string",
"x-priority": "important"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Plugin name",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the plugin?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not eslint configuration for plugin json files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Plugin for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 631a948ded5db2f9f1220bff7e9a560cd56c8f48 | 2023-05-30T18:06:50 | 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"
},
"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 | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | 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 nx/js.",
"properties": {
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"description": "Skip adding package.json dependencies",
"type": "boolean",
"x-priority": "internal"
},
"tsConfigName": {
"description": "Customize the generated tsconfig file name.",
"type": "string",
"x-priority": "internal"
}
},
"title": "Init nx/js"
} | MIT | en |
nrwl/nx | 229f71ef1758ee625869aaa6fa6355dc3284fa5b | 2022-03-03T20:47:06 | packages/js/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": true,
"description": "Generate a buildable library.",
"type": "boolean"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"config": {
"default": "project",
"description": "Determines whether the project's executors should be configured in workspace.json, project.json or as npm scripts",
"enum": [
"workspace",
"project",
"npm-scripts"
],
"type": "string"
},
"directory": {
"description": "A directory where the lib is placed",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"skipTypeCheck": {
"default": false,
"description": "Whether to skip TypeScript type checking for SWC compiler.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the library (used for linting)",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if unitTestRunner is set to jest",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a TypeScript Library",
"type": "object"
} | MIT | en |
nrwl/nx | 338dc64d91e778c892d2a7d997b997d89b184343 | 2023-04-19T19:29:31 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "http://json-schema.org/schema",
"additionalProperties": true,
"cli": "nx",
"description": "Create an empty workspace.",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"nextAppDir": {
"default": false,
"description": "Enable experimental app directory for the project",
"type": "boolean"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"nxCloud": {
"default": false,
"description": "Connect the workspace to the free tier of the distributed cache provided by Nx Cloud.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 4a4a149bce59b28fd245d15ed7787b00c9f87ed3 | 2022-11-02T18:20:56 | 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"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library",
"type": "object"
} | MIT | en |
nrwl/nx | a2d95775539f768df3495b175d0776df5c31ff6a | 2022-07-12T13:55:22 | packages/storybook/src/generators/cypress-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "cypress-configure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add cypress E2E app to test a ui library that is set up for Storybook.",
"properties": {
"directory": {
"description": "A directory where the project is placed.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate the cypress E2E app.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "For which project do you want to generate the Cypress E2E app?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Cypress Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | 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": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"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 | a2d95775539f768df3495b175d0776df5c31ff6a | 2022-07-12T13:55:22 | packages/angular/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookStoriesGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates Storybook stories/specs for all Angular components declared in a project.",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `name` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What's the name of the project for which you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Create Storybook stories/specs",
"type": "object"
} | MIT | en |
nrwl/nx | 1fc52349a7ccaeeb5791a4ea157ca6b5594d2439 | 2022-10-09T12:49:29 | packages/angular/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsAngularModuleInit",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Initializes the `@nrwl/angular` plugin. NOTE: Does not work in the `--dry-run` mode.",
"examples": [
{
"command": "nx g @nrwl/angular:init --style=scss",
"description": "Installs angular dependencies and initializes the `@nrwl/angular` plugin with the `scss` stylesheet format."
}
],
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing after adding `@nrwl/workspace`.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
}
},
"title": "Init Angular Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/express/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxExpressInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Init Express 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 Express Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | d20cf91e6c5e1b71fb8af4e6413d27b15e82d2ce | 2023-01-13T16:50:01 | packages/next/src/generators/page/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextReactPage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Page for Next.",
"examplesFile": "../../../docs/page-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "Create the page under this directory (can be nested). Will be created under `pages/`.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"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?"
},
"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?"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-priority": "important",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ 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 | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/js/executors.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://json-schema.org/schema",
"executors": {
"node": {
"description": "Execute a Node application.",
"implementation": "./src/executors/node/node.impl",
"schema": "./src/executors/node/schema.json"
},
"release-publish": {
"description": "DO NOT INVOKE DIRECTLY WITH `nx run`. Use `nx release publish` instead.",
"hidden": true,
"implementation": "./src/executors/release-publish/release-publish.impl",
"schema": "./src/executors/release-publish/schema.json"
},
"swc": {
"description": "Build a project using SWC.",
"implementation": "./src/executors/swc/swc.impl",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"batchImplementation": "./src/executors/tsc/tsc.batch-impl",
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/tsc.impl",
"schema": "./src/executors/tsc/schema.json"
},
"verdaccio": {
"description": "Start local registry with verdaccio",
"implementation": "./src/executors/verdaccio/verdaccio.impl",
"schema": "./src/executors/verdaccio/schema.json"
}
}
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react/src/generators/component-cypress-spec/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponentCypressSpec",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a Cypress spec for a UI component that has a story.",
"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 for which to generate a test?"
},
"cypressProject": {
"description": "The Cypress project to generate the stories under. By default, inferred from `project`.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"description": "The project name for which to generate tests.",
"examples": [
"shared-ui-component"
],
"type": "string",
"x-priority": "important",
"x-prompt": "What's name of the project for which to generate tests?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project",
"componentPath"
],
"title": "Create component Cypress spec",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/jest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJestInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add Jest Configuration to a workspace.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Jest init",
"type": "object"
} | MIT | en |
nrwl/nx | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | 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-priority": "important"
},
"preserveAngularCliLayout": {
"default": false,
"description": "Preserve the Angular CLI layout instead of moving the app into apps. NOTE: only used if running the generator in an Angular CLI workspace.",
"type": "boolean",
"x-priority": "important"
},
"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 | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/provider/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestProviderGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Provider Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"language": {
"description": "Nest provider language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the provider.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Provider Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 5fba936254cd3dab72335d5f6907e922394296b4 | 2023-01-05T12:46:54 | packages/angular/src/generators/ngrx/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNgrxGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds NgRx support to an application or library.",
"examples": [
{
"command": "nx g @nrwl/angular:ngrx --root --module=apps/my-app/src/app/app.module.ts --facade=false placeholder",
"description": "Add root ngrx configration to the `my-app` application"
},
{
"command": "nx g @nrwl/angular:ngrx --module=libs/my-lib/src/lib/my-lib.module.ts --facade=true --root=false users",
"description": "Add a `users` state with a facade to the `my-lib` library. It will be tracked under the default `+state` folder in the lib"
}
],
"properties": {
"barrels": {
"default": false,
"description": "Use barrels to re-export actions, state and selectors.",
"type": "boolean"
},
"directory": {
"default": "+state",
"description": "The name of the folder used to contain/group the generated NgRx files.",
"type": "string"
},
"facade": {
"default": false,
"description": "Create a Facade class for the the feature.",
"type": "boolean",
"x-prompt": "Would you like to use a Facade with your NgRx state?"
},
"minimal": {
"default": true,
"description": "Only register the root state management setup or feature state.",
"type": "boolean"
},
"module": {
"description": "The path to the `NgModule` where the feature state will be registered. The host directory will create/use the new state directory.",
"type": "string",
"x-deprecated": "This option will be removed in a future version of Nx. Please switch to using --parent instead."
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.",
"type": "string",
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`."
},
"parent": {
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. The host directory will create/use the new state directory.",
"type": "string",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?"
},
"root": {
"default": false,
"description": "Setup root or feature state management with NgRx.",
"type": "boolean",
"x-prompt": "Is this the root state of the application?"
},
"route": {
"default": "''",
"description": "The route that the Standalone NgRx Providers should be added to.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Generate NgRx feature files without registering the feature in the NgModule.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not update the `package.json` with NgRx dependencies.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Add NgRx support to an application or library.",
"type": "object"
} | MIT | en |
nrwl/nx | 29a9f8eba8ccc11aabdbf144314e8f20bc7e83ef | 2023-07-19T14:42:13 | packages/storybook/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Storybook configuration to a UI library or an application.",
"examplesFile": "../../../docs/configuration-generator-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"type": "string",
"x-priority": "important"
},
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"configureStaticServe": {
"default": false,
"description": "Add a static-storybook to serve the static storybook built files.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Added at root by default.",
"type": "string",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
},
"uiFramework": {
"aliases": [
"storybook7UiFramework"
],
"description": "Storybook UI Framework to use.",
"enum": [
"@storybook/angular",
"@storybook/html-webpack5",
"@storybook/nextjs",
"@storybook/preact-webpack5",
"@storybook/react-webpack5",
"@storybook/react-vite",
"@storybook/server-webpack5",
"@storybook/svelte-webpack5",
"@storybook/svelte-vite",
"@storybook/sveltekit",
"@storybook/vue-webpack5",
"@storybook/vue-vite",
"@storybook/vue3-webpack5",
"@storybook/vue3-vite",
"@storybook/web-components-webpack5",
"@storybook/web-components-vite"
],
"hidden": false,
"type": "string",
"x-priority": "important",
"x-prompt": "Choose the Storybook framework that you need to use."
}
},
"required": [
"name",
"uiFramework"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 9c93c907fd1f735ad9cbeb74d455f6b9f11cbcf4 | 2022-08-03T08:39:06 | packages/react/src/generators/setup-tailwind/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactTailwindSetupGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds the Tailwind CSS configuration files for a given React project and installs, if needed, the packages required for Tailwind CSS to work.",
"examples": [
{
"command": "nx g setup-tailwind --project=my-app",
"description": "Initialize Tailwind configuration for the `my-app` project."
}
],
"properties": {
"buildTarget": {
"default": "build",
"description": "The name of the target used to build the project. This option is not needed in most cases.",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "p",
"description": "The name of the project to add the Tailwind CSS setup for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What project would you like to add the Tailwind CSS setup?"
},
"skipFormat": {
"description": "Skips formatting the workspace after the generator completes.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Configures Tailwind CSS for an application or a buildable/publishable library.",
"type": "object"
} | MIT | en |
nrwl/nx | 8b48ba9ac25ce15adec257a92c05c570ed8fa5a2 | 2023-04-14T17:56:57 | packages/react/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Remote Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss.",
"type": "boolean"
},
"host": {
"description": "The host / shell application for this remote.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the remote application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the remote application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "DEPRECATD: Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 74bd0bb00ca07d8765c43f10a5baeff1b5f894ec | 2022-11-29T22:03:19 | packages/jest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJestInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Jest Configuration to a workspace.",
"properties": {
"babelJest": {
"alias": "babel-jest",
"default": false,
"description": "Use `babel-jest` instead of `ts-jest`.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript for config files",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "initialize Jest for an application at the root of the workspace",
"hidden": true,
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Jest init",
"type": "object"
} | MIT | en |
nrwl/nx | 33acb41afbaf5160d948147b1d2c10c71b1b68c1 | 2021-02-12T20:29:31 | packages/next/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g component my-component --project=mylib",
"description": "Generate a component in the mylib library"
},
{
"command": "g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the mylib library"
}
],
"id": "NxReactApp",
"properties": {
"directory": {
"alias": "d",
"description": "Create the component under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project index.ts (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-prompt": "What name would you like to use for the component?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this component?"
},
"skipTests": {
"default": false,
"description": "When true, does not create \"spec.ts\" test files for the new component.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component for Next",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup. No nx starter template.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "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",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/plugin/src/generators/executor/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginExecutor",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Executor for an Nx Plugin.",
"examples": [
{
"command": "nx g executor my-executor --project=my-plugin",
"description": "Generate `libs/my-plugin/src/executors/my-executor`"
}
],
"examplesFile": "../../../docs/generators/executor-examples.md",
"properties": {
"description": {
"description": "Executor description.",
"type": "string",
"x-priority": "important"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the executor file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string",
"x-priority": "important"
},
"includeHasher": {
"default": false,
"description": "Should the boilerplate for a custom hasher be generated?",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Executor name.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the executor?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the executor in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not add an eslint configuration for plugin json files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create an Executor for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 88971468dbbed3fb5a0d86c6d37a0f558ac75573 | 2022-04-23T02:43:59 | packages/next/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextNgInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Next Plugin.",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified e2e test runner.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init Next Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | c43b22dc887b10d527aa3a11e7f7af2a9961e7f8 | 2024-01-17T18:22:51 | 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"
},
"src": {
"default": true,
"description": "Generate a `src` directory for the project.",
"type": "boolean",
"x-prompt": "Would you like to use `src/` directory?"
},
"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 | 8ca7d4bbd61b8768b48358a75f5b7b33f9c9e590 | 2022-06-27T12:28:17 | packages/angular/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookStoriesGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates Storybook stories/specs for all Angular components declared in a project.",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `name` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project.",
"type": "string",
"x-prompt": "What's the name of the project for which you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Create Storybook stories/specs",
"type": "object"
} | MIT | en |
nrwl/nx | 9352f2ee987f543a634d20a2af59c7189aa0acf4 | 2022-07-11T12:27:33 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds Storybook configuration to a project to be able to use and create stories.",
"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",
"x-dropdown": "projects"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | 5d1c8eacd7b3f919a28018a8069fa6a4e7711a45 | 2023-01-30T10:56:19 | packages/nest/src/generators/module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestModuleGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Module Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest module language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "The path to import the module.",
"format": "path",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the module.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"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 | f8b4f91f37c1dd5ff463cea3253e45ef1c3ac464 | 2023-05-25T14:36:42 | 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-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": [
"name"
],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | cfa081538556738b8e9d4c75d39df6d597f1d360 | 2024-02-21T15:20:12 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "https://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": {
"description": "Bundler to use to build the application. It defaults to `esbuild` for Angular versions >= 17.0.0. Otherwise, it defaults to `webpack`. _Note: The `esbuild` bundler is only considered stable from Angular v17._",
"enum": [
"webpack",
"esbuild"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"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",
"default": "app",
"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"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"routing": {
"default": true,
"description": "Enable routing for the application.",
"type": "boolean",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"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": "Creates an application with Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) enabled.",
"type": "boolean",
"x-prompt": "Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)?"
},
"standalone": {
"default": true,
"description": "Generate an application that is setup to use standalone components.",
"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) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ https://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"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 | 8d5ef222cc5fc985f26fe06c937d9a179cd9f28c | 2023-06-13T17:30:52 | packages/js/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a TypeScript Library.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"buildable": {
"default": true,
"description": "Generate a buildable library.",
"type": "boolean",
"x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
},
"bundler": {
"default": "tsc",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"swc",
"tsc",
"rollup",
"vite",
"esbuild",
"none"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets",
"enum": [
"tsc",
"swc"
],
"type": "string",
"x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
},
"config": {
"default": "project",
"description": "Determines whether the project's executors should be configured in `workspace.json`, `project.json` or as npm scripts.",
"enum": [
"workspace",
"project",
"npm-scripts"
],
"type": "string",
"x-priority": "internal"
},
"directory": {
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Required for publishable library.",
"type": "string",
"x-priority": "important"
},
"includeBabelRc": {
"description": "Include a .babelrc configuration to compile TypeScript files",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a library with a minimal setup. No README.md generated.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the generated file name.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"skipTypeCheck": {
"default": false,
"description": "Whether to skip TypeScript type checking for SWC compiler.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment to use if unitTestRunner is set to jest or vitest.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [
"name"
],
"title": "Create a TypeScript Library",
"type": "object"
} | MIT | en |
nrwl/nx | 0bc693342ef321495c979bac6900fcc9df13700a | 2023-10-16T15:52:19 | packages/eslint/src/generators/workspace-rules-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceRulesProject",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create the Workspace Lint Rules Project.",
"examples": [
{
"command": "nx g @nx/eslint:workspace-rules-project",
"description": "Create the Workspace Lint Rules Project"
}
],
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Create the Workspace Lint Rules Project",
"type": "object"
} | MIT | en |
nrwl/nx | 46e7b4d49c71718d50fe7293254fea50ffbcfaef | 2022-04-12T18:05:55 | 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 | ee3413b5173097476ba438826b235a219071ca38 | 2023-02-27T21:03:09 | 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": "Migrates v1 config to v2 standalone configuration.",
"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": "@nrwl/workspace:fix-configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 6141f44203898277adb8244db4200fcc3cea207f | 2024-01-17T19:22:58 | packages/nest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInitGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Init Nest Plugin.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Init Nest Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/storybook/src/generators/cypress-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "cypress-configure",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add cypress E2E app to test a ui library that is set up for Storybook.",
"properties": {
"ciTargetName": {
"description": "The name of the devServerTarget to use for the Cypress CI configuration. Used to control if using <storybook-project>:static-storybook:ci or <storybook-project>:storybook:ci",
"type": "string",
"x-priority": "internal"
},
"directory": {
"description": "A directory where the project is placed.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate the cypress E2E app.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate the Cypress E2E app?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"name"
],
"title": "Cypress Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 44820f2c4b84d790d762bd3db43a746481838f24 | 2024-04-30T16:47:12 | packages/cypress/src/generators/convert-to-inferred/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressConvertToInferred",
"$schema": "https://json-schema.org/schema",
"description": "Convert existing Cypress project(s) using `@nx/cypress:cypress` executor to use `@nx/cypress/plugin`.",
"properties": {
"project": {
"description": "The project to convert from using the `@nx/cypress:cypress` executor to use `@nx/cypress/plugin`.",
"type": "string",
"x-priority": "important"
},
"skipFormat": {
"default": false,
"description": "Whether to format files at the end of the migration.",
"type": "boolean"
}
},
"title": "Convert Cypress project from executor to plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/next/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"
},
"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 for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | 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.",
"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"
},
"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"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"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?"
},
"parentModule": {
"description": "Update the router configuration of the parent module 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"
},
"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"
},
"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": "Create a library with stricter type checking and build optimization options.",
"type": "boolean"
},
"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"
}
},
"required": [
"name"
],
"title": "Create a library",
"type": "object"
} | MIT | en |
nrwl/nx | e772ee22bd4a5bdf26a0ac671b0485a5c9a335c0 | 2023-03-21T15:46:12 | 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-priority": "important",
"x-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"none"
],
"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"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ 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": {
"description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 1139c616e1b7e27c519e385a3982ac8b486dbb0f | 2021-12-22T15:33:02 | packages/js/executors.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"builders": {
"node": {
"description": "Build Node.js applications",
"implementation": "./src/executors/node/compat",
"schema": "./src/executors/node/schema.json"
},
"swc": {
"description": "Build a project using SWC",
"implementation": "./src/executors/swc/compat",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/compat",
"schema": "./src/executors/tsc/schema.json"
}
},
"executors": {
"node": {
"description": "Build Node.js applications",
"implementation": "./src/executors/node/node.impl",
"schema": "./src/executors/node/schema.json"
},
"swc": {
"description": "Build a project using SWC",
"implementation": "./src/executors/swc/swc.impl",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/tsc.impl",
"schema": "./src/executors/tsc/schema.json"
}
}
} | MIT | en |
nrwl/nx | bdcbac4445df85a8f861ac70465eb641e025e8de | 2021-10-15T22:07:12 | packages/angular/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"addModuleSpec": {
"default": false,
"description": "Add a module spec file.",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"directory": {
"description": "A directory where the library is placed.",
"type": "string"
},
"enableIvy": {
"default": false,
"description": "Enable Ivy for library in `tsconfig.lib.prod.json`. Should not be used with publishable libraries.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"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?"
},
"parentModule": {
"description": "Update the router configuration of the parent module 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"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using `--directory`).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create a library with stricter type checking and build optimization options.",
"type": "boolean"
},
"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"
}
},
"required": [],
"title": "Create a library",
"type": "object"
} | MIT | en |
nrwl/nx | 513e2346b39b4610958a1847a8350008389d54a6 | 2023-10-16T20:04:01 | packages/next/src/generators/page/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextReactPage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Page for Next.",
"examplesFile": "../../../docs/page-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "The directory at which to create the page file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the component?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-priority": "important",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ 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"
}
},
"withTests": {
"default": false,
"description": "When true, creates a `spec.ts` test file for the new page.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Create a Page for Next",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/vite/src/executors/test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Test using Vitest.",
"examplesFile": "../../../docs/test-examples.md",
"properties": {
"configFile": {
"aliases": [
"config"
],
"description": "The path to the local vitest config",
"type": "string",
"x-completion-glob": "@(vitest|vite).config@(.js|.ts)",
"x-completion-type": "file"
},
"reportsDirectory": {
"description": "Directory to write coverage report to.",
"type": "string"
},
"testFiles": {
"aliases": [
"testFile"
],
"items": {
"type": "string"
},
"type": "array"
},
"watch": {
"description": "Watch files for changes and rerun tests related to changed files.",
"type": "boolean"
}
},
"required": [],
"title": "Vitest executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 3befa3a22d423d3b2d41dc69b95130be874e628a | 2023-12-06T18:10:44 | tools/workspace-plugin/src/generators/create-nodes-plugin/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "Generator",
"$schema": "http://json-schema.org/schema",
"description": "A generator for creating a new nodes plugin.",
"properties": {},
"required": [],
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | 406018ca2de8ffe67d61cbf0e83b74590df923a7 | 2023-10-20T16:28:47 | packages/vue/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Vue 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": {
"directory": {
"alias": "dir",
"description": "The directory at which to create the component file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string",
"x-priority": "important"
},
"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",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"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?"
},
"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"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"type": "boolean",
"x-deprecated": "Provide the desired `directory` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean",
"x-deprecated": "Provide the desired `name` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"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"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"vitest",
"jest",
"none"
],
"type": "string",
"x-prompt": "What unit test runner should be used?"
}
},
"required": [
"name",
"project"
],
"title": "Create a Vue Component",
"type": "object"
} | MIT | en |
nrwl/nx | 2876996a39751bb90b8e8d7608c1466852af77cf | 2023-02-01T19:53:19 | packages/vite/src/generators/vitest/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "Vitest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a Vitest setup for a project.",
"properties": {
"coverageProvider": {
"default": "c8",
"description": "Coverage provider to use.",
"enum": [
"c8",
"istanbul"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "Do not generate separate spec files and set up in-source testing.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project to test.",
"type": "string"
},
"skipViteConfig": {
"default": false,
"description": "Skip generating a vite config file.",
"type": "boolean"
},
"testTarget": {
"description": "The test target of the project to be transformed to use the @nrwl/vite:test executor.",
"hidden": true,
"type": "string"
},
"uiFramework": {
"default": "none",
"description": "UI framework to use with vitest.",
"enum": [
"react",
"none"
],
"type": "string"
}
},
"required": [
"project"
],
"title": "Vitest",
"type": "object"
} | MIT | en |
nrwl/nx | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | packages/react/src/generators/cypress-component-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactCypressComponentTestConfiguration",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress component testing configuration to an existing project.",
"examples": [
{
"command": "nx g @nx/react:cypress-component-configuration --project=my-react-project",
"description": "Add component testing to your react project"
},
{
"command": "nx g @nx/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"
}
],
"examplesFile": "../../../docs/cypress-component-configuration-examples.md",
"properties": {
"buildTarget": {
"description": "A build target used to configure Cypress component testing in the format of `project:target[:configuration]`. The build target should be from a React app. If not provided we will try to infer it from your projects usage.",
"pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$",
"type": "string"
},
"bundler": {
"description": "The bundler to use for Cypress Component Testing.",
"enum": [
"vite",
"webpack"
],
"hidden": true,
"type": "string",
"x-priority": "internal"
},
"generateTests": {
"default": false,
"description": "Generate default component tests for existing components in the project",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate tests for components declared in this project?"
},
"project": {
"description": "The name of the project to add cypress component testing configuration to",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project should we add Cypress component testing to?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Add Cypress component testing",
"type": "object"
} | MIT | en |
nrwl/nx | b3dd65adbc8ebd386ed0eddbd67fcdc1d8b3fa48 | 2023-03-22T21:38:32 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"bundler": {
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"x-priority": "important"
},
"configureCypress": {
"default": true,
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"storybook7Configuration": {
"aliases": [
"storybook7betaConfiguration"
],
"default": 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 | ef3d5de7591ebde68af0c2e651ee470fe2a92701 | 2023-01-23T15:29:13 | packages/jest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJestInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Jest Configuration to a workspace.",
"properties": {
"babelJest": {
"alias": "babel-jest",
"default": false,
"description": "Use `babel-jest` instead of `ts-jest`.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript for config files",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "initialize Jest for an application at the root of the workspace",
"hidden": true,
"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 | e4758358b0cf9d3013ddfd30ae9ea387866f5144 | 2024-01-22T18:51:41 | packages/angular/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsAngularModuleInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initializes the `@nx/angular` plugin. NOTE: Does not work in the `--dry-run` mode.",
"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"
},
"skipInstall": {
"default": false,
"description": "Skip installing after adding `@nx/workspace`.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"title": "Init Angular Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 6c59cbbb3b31bb03c878a8780e0d025948286cb9 | 2022-11-29T19:49:15 | packages/react/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": {
"appComponentImportPath": {
"default": "app/app",
"description": "The import path of the <App/> component, relative to project sourceRoot.",
"type": "string"
},
"extraInclude": {
"default": [],
"description": "Extra include entries in tsconfig.",
"hidden": true,
"items": {
"type": "string"
},
"type": "array"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to add SSR support to.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to add SSR support to?"
},
"serverPort": {
"default": 4200,
"description": "The port for the Express server.",
"type": "number"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Generate Angular Universal (SSR) setup for an Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/next/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextApp",
"$schema": "https://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"
},
"src": {
"default": true,
"description": "Generate a `src` directory for the project.",
"type": "boolean",
"x-prompt": "Would you like to use `src/` directory?"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"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 | a2d95775539f768df3495b175d0776df5c31ff6a | 2022-07-12T13:55:22 | packages/react/src/generators/component-story/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponentStory",
"$schema": "http://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-prompt": "What's path of the component relative to the project's lib root?"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "The project where to add the components.",
"examples": [
"shared-ui-component"
],
"type": "string",
"x-prompt": "What's name of the project where the component lives?"
}
},
"required": [
"project",
"componentPath"
],
"title": "Create component story",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | 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.",
"properties": {
"library": {
"description": "The name of the library to create the secondary entry point for.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"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-prompt": "What name would you like to use for the secondary entry point?"
},
"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 | 33acb41afbaf5160d948147b1d2c10c71b1b68c1 | 2021-02-12T20:29:31 | packages/next/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "NxNextNgInit",
"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 Next Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | c87884ad6ed95eabab9970fb472eff5212123c73 | 2024-02-12T20:42:11 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "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"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup. No nx starter template.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS. When --js is used, this flag is ignored.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 1a9df531b643a30616571797ef24c923144d634c | 2022-09-13T14:17:49 | 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.",
"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-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-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-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-prompt": "What project is the component located in?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"project",
"componentName",
"componentDir",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 6141f44203898277adb8244db4200fcc3cea207f | 2024-01-17T19:22:58 | packages/node/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Node Plugin.",
"properties": {
"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 Node Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | d4537f75cc99d4694171d7c793ad6b112229fd5e | 2021-06-14T14:20:58 | 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": "Name of the project from angular.json.",
"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 | 56dbb0d602df65d0f708e0bcf53ff82b16833213 | 2022-06-09T14:42:49 | 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"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | ecf9a80bae64d59f203b84326600992fefd0ef9e | 2022-12-09T09:48:23 | 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"
},
"flat": {
"default": false,
"description": "Ensure the generated standalone component is not placed in a subdirectory. 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",
"x-deprecated": "Use `simpleName` instead. It will be removed in v16."
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the name of the module or standalone component entry of the library.",
"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"
},
"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 | 0ad3eb34cb5c793688f82cb321c705a0f0a2b015 | 2022-03-28T19:28:28 | packages/workspace/src/generators/remove/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceRemove",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Remove a project from the workspace.",
"examples": [
{
"command": "nx g @nrwl/workspace:remove my-feature-lib",
"description": "Remove `my-feature-lib` from the workspace"
},
{
"command": "nx g @nrwl/workspace:remove my-feature-lib --forceRemove",
"description": "Force removal of `my-feature-lib` from the workspace"
}
],
"properties": {
"forceRemove": {
"aliases": [
"force-remove"
],
"default": false,
"description": "When `true`, forces removal even if the project is still in use.",
"type": "boolean"
},
"importPath": {
"description": "The library name used at creation time",
"type": "string"
},
"projectName": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "project",
"description": "The name of the project to remove.",
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"projectName"
],
"title": "Nx Remove",
"type": "object"
} | MIT | en |
nrwl/nx | 1fe3ba60eb55c71e3ed8887f9e8bc8725336dc63 | 2022-06-09T15:16:23 | 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.",
"properties": {
"configureCypress": {
"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. 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",
"tslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library or application name.",
"type": "string"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"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"
},
"uiFramework": {
"description": "Storybook UI Framework to use.",
"enum": [
"@storybook/angular",
"@storybook/react"
],
"type": "string",
"x-prompt": "What UI framework plugin should storybook use?"
}
},
"required": [
"name"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/resource/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResourceGenerator",
"$schema": "https://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 v20."
},
"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 v20."
},
"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 | 1fe3ba60eb55c71e3ed8887f9e8bc8725336dc63 | 2022-06-09T15:16: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.",
"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 `*.spec.ts` files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-prompt": "Automatically generate *.spec.ts 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
},
"description": "Project name",
"type": "string"
},
"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 | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/nest/src/generators/decorator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestDecoratorGenerator",
"$schema": "https://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. 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 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?"
},
"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"
}
},
"required": [
"name"
],
"title": "Nest Decorator Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 949466f02ba188c0da8bb5f4abfc6b4e71e4b49c | 2023-10-17T20:33:04 | packages/nuxt/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNuxtApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Nuxt Application for Nx.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "none",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [],
"title": "Create a Nuxt Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/js/src/generators/setup-verdaccio/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SetupVerdaccio",
"$schema": "https://json-schema.org/schema",
"description": "Setup Verdaccio local-registry.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Setup Verdaccio",
"type": "object"
} | MIT | en |
nrwl/nx | 8c8b257a3c853d4041051fbe0f366755a16cfe6c | 2022-01-06T11:49:04 | 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",
"properties": {
"addModuleSpec": {
"default": false,
"description": "Add a module spec file.",
"type": "boolean"
},
"addTailwind": {
"default": false,
"description": "Whether to configure TailwindCSS 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"
},
"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"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"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?"
},
"parentModule": {
"description": "Update the router configuration of the parent module 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"
},
"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"
},
"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": "Create a library with stricter type checking and build optimization options.",
"type": "boolean"
},
"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"
}
},
"required": [
"name"
],
"title": "Create a library",
"type": "object"
} | MIT | en |
nrwl/nx | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | packages/angular/src/generators/component-cypress-spec/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularComponentCypressSpecGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates a Cypress spec for a UI component that has a story.",
"examplesFile": "../../../docs/component-cypress-spec-examples.md",
"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"
},
"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",
"x-priority": "important"
},
"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"
},
"specDirectory": {
"description": "Directory where to place the generated spec file. By default matches the value of the `componentPath` option.",
"type": "string"
}
},
"required": [
"projectName",
"projectPath",
"componentName",
"componentPath",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 09c6ccb2666f98014a206e23187a2794642a579c | 2022-09-28T15:08: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.",
"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"
],
"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 | 25eeddc3389f60875a0e5611ca2ba7812c898c31 | 2024-04-24T13:06:23 | packages/playwright/src/generators/convert-to-inferred/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPlaywrightConvertToInferred",
"$schema": "https://json-schema.org/schema",
"description": "Convert existing Playwright project(s) using `@nx/playwright:playwright` executor to use `@nx/playwright/plugin`. Defaults to migrating all projects. Pass '--project' to migrate only one target.",
"properties": {
"project": {
"description": "The project to convert from using the `@nx/playwright:playwright` executor to use `@nx/playwright/plugin`.",
"type": "string",
"x-priority": "important"
},
"skipFormat": {
"default": false,
"description": "Whether to format files at the end of the migration.",
"type": "boolean"
}
},
"title": "Convert Playwright project from executor to plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 9eaa240b4dbf91b41942d680108f73e8356dd4b9 | 2023-07-03T15:22:37 | 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",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a Angular app with a minimal setup.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"description": "Generate an application that is setup to use standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean",
"x-priority": "important"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | 5d1c8eacd7b3f919a28018a8069fa6a4e7711a45 | 2023-01-30T10:56:19 | packages/nest/src/generators/resolver/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResolverGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Resolver Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest resolver language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resolver.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Resolver Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react/src/generators/setup-tailwind/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactTailwindSetupGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds the Tailwind CSS configuration files for a given React project and installs, if needed, the packages required for Tailwind CSS to work.",
"examples": [
{
"command": "nx g setup-tailwind --project=my-app",
"description": "Initialize Tailwind configuration for the `my-app` project."
}
],
"properties": {
"buildTarget": {
"default": "build",
"description": "The name of the target used to build the project. This option is not needed in most cases.",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "p",
"description": "The name of the project to add the Tailwind CSS setup for.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project would you like to add the Tailwind CSS setup?"
},
"skipFormat": {
"description": "Skips formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Configures Tailwind CSS for an application or a buildable/publishable library.",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/decorator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestDecoratorGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"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 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 | 09c6ccb2666f98014a206e23187a2794642a579c | 2022-09-28T15:08:01 | packages/detox/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Create Detox Configuration for the workspace.",
"properties": {
"directory": {
"description": "A directory where the project is placed.",
"type": "string"
},
"framework": {
"description": "App framework to test",
"enum": [
"react-native",
"expo"
],
"type": "string",
"x-prompt": "What app framework should detox test?"
},
"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": "Name of the E2E Project.",
"type": "string",
"x-prompt": "What name would you like to use for the E2E project?"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the frontend project to test.",
"type": "string",
"x-prompt": "What is the name of the frontend project to test?"
},
"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"
}
},
"required": [
"name",
"project",
"framework"
],
"title": "Create Detox Configuration for the workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | 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 v20."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | bdcbac4445df85a8f861ac70465eb641e025e8de | 2021-10-15T22:07:12 | 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",
"properties": {
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to package.json.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/next/src/generators/page/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextReactPage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Page for Next.",
"examples": [
{
"command": "nx g page my-new-page --project=my-app",
"description": "Generate a page in the my-app application"
}
],
"properties": {
"directory": {
"alias": "dir",
"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 | d98d2462aab5803d43a942ed253c9abb3159392b | 2023-01-12T16:11:33 | 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-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"
},
"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-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library",
"type": "object"
} | MIT | en |
nrwl/nx | 41f276b84e9922d5881e55e6c16aded0808925ff | 2023-11-02T15:08:39 | packages/vue/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Vue Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=libs/mylib",
"description": "Generate `libs/mylib`"
},
{
"command": "nx g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to `myapp`"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"bundler": {
"default": "none",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"none",
"vite"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
},
"component": {
"default": false,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Create a Vue library with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"vitest",
"none"
],
"type": "string",
"x-prompt": "What unit test runner should be used?"
}
},
"required": [
"name"
],
"title": "Create a Vue Library",
"type": "object"
} | MIT | en |
nrwl/nx | cfa081538556738b8e9d4c75d39df6d597f1d360 | 2024-02-21T15:20:12 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack",
"esbuild"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"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"
},
"prefix": {
"description": "The prefix to use for Angular component and directive selectors.",
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"preset",
"name"
],
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/resolver/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResolverGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Resolver Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"language": {
"description": "Nest resolver language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resolver.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Resolver Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 8826a7737dd0d23a6da9a634b5511a4f8fa07919 | 2023-10-12T16:49:45 | packages/next/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.",
"examplesFile": "../../../docs/library-examples.md",
"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",
"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"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"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"
},
"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"
}
],
"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 for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a2d95775539f768df3495b175d0776df5c31ff6a | 2022-07-12T13:55:22 | 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.",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `project` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-prompt": "For which project do you want to generate stories?"
}
},
"required": [
"project"
],
"title": "Generate React Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | b85a25b02f8474deed10b9f0313504cd9bca6614 | 2023-10-17T19:46:17 | 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": {
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "Create a project at the root of the workspace",
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add Vue Router to this application?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"required": [],
"title": "Init Vue Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 17e6db55688b249962ad28ae2857890814f68ab0 | 2023-05-04T15:02:18 | packages/storybook/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Storybook configuration to a UI library or an application.",
"examplesFile": "../../../docs/configuration-generator-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"type": "string",
"x-priority": "important"
},
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureStaticServe": {
"default": false,
"description": "Add a static-storybook to serve the static storybook built files.",
"type": "boolean"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Added at root by default.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"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": {
"aliases": [
"storybook7UiFramework"
],
"description": "Storybook UI Framework to use.",
"enum": [
"@storybook/angular",
"@storybook/html-webpack5",
"@storybook/nextjs",
"@storybook/preact-webpack5",
"@storybook/react-webpack5",
"@storybook/react-vite",
"@storybook/server-webpack5",
"@storybook/svelte-webpack5",
"@storybook/svelte-vite",
"@storybook/sveltekit",
"@storybook/vue-webpack5",
"@storybook/vue-vite",
"@storybook/vue3-webpack5",
"@storybook/vue3-vite",
"@storybook/web-components-webpack5",
"@storybook/web-components-vite"
],
"hidden": false,
"type": "string",
"x-priority": "important"
}
},
"required": [
"name",
"uiFramework"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 5d1c8eacd7b3f919a28018a8069fa6a4e7711a45 | 2023-01-30T10:56:19 | 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",
"x-priority": "internal"
},
"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 | 047dc22aed99ee0870357fa1508cd5decb8009a7 | 2024-01-16T14:29:44 | packages/webpack/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebpackInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initialize the Webpack Plugin.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Init Webpack Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 65e86eacac68881f749223f41d54beda96d9f0ee | 2024-01-31T20:38:02 | packages/react-native/src/generators/component-story/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeComponentStory",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Generate storybook story for a react-native component.",
"properties": {
"componentPath": {
"description": "Relative path to the component file from the library root.",
"examples": [
"lib/components"
],
"type": "string",
"x-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": "React native component story",
"type": "object"
} | MIT | en |
Subsets and Splits