57e70d0e91
The simpleName option is no longer useful as we've moved to using options "as provided" without transformation. Users should provide the exact name, directory, and import path they want to use. ## Changes - Add x-deprecated to schema.json marking for removal in Nx 22 - Add runtime warning when simpleName is used 🤖 Generated with [Claude Code](https://claude.ai/code) <!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior Users are confused with `--simpleName` with using `--name` AND `--directory` ## Expected Behavior We should tell users that only `--name` should be used. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #29508 --------- Co-authored-by: Claude <noreply@anthropic.com>
205 lines
7.0 KiB
JSON
205 lines
7.0 KiB
JSON
{
|
|
"name": "library",
|
|
"factory": "./src/generators/library/library#libraryGeneratorInternal",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxReactLibrary",
|
|
"title": "Create a React Library",
|
|
"description": "Create a React Library for an Nx workspace.",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"command": "nx g @nx/react:lib libs/mylib",
|
|
"description": "Generate a library under `libs/mylib`"
|
|
},
|
|
{
|
|
"command": "nx g @nx/react:lib mylib --appProject=myapp",
|
|
"description": "Generate a library under mylib with routes and add them to `myapp`"
|
|
}
|
|
],
|
|
"properties": {
|
|
"directory": {
|
|
"type": "string",
|
|
"description": "A directory where the lib is placed.",
|
|
"alias": "dir",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "Which directory do you want to create the library in?"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Library name",
|
|
"x-priority": "important"
|
|
},
|
|
"style": {
|
|
"description": "The file extension to be used for style files.",
|
|
"type": "string",
|
|
"default": "css",
|
|
"alias": "s",
|
|
"x-prompt": {
|
|
"message": "Which stylesheet format would you like to use?",
|
|
"type": "list",
|
|
"items": [
|
|
{ "value": "css", "label": "CSS" },
|
|
{
|
|
"value": "scss",
|
|
"label": "SASS(.scss) [ https://sass-lang.com ]"
|
|
},
|
|
{
|
|
"value": "less",
|
|
"label": "LESS [ https://lesscss.org ]"
|
|
},
|
|
{
|
|
"value": "tailwind",
|
|
"label": "tailwind [ https://tailwindcss.com/ ]"
|
|
},
|
|
{
|
|
"value": "styled-components",
|
|
"label": "styled-components [ https://styled-components.com ]"
|
|
},
|
|
{
|
|
"value": "@emotion/styled",
|
|
"label": "emotion [ https://emotion.sh ]"
|
|
},
|
|
{
|
|
"value": "styled-jsx",
|
|
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]"
|
|
},
|
|
{ "value": "none", "label": "None" }
|
|
]
|
|
}
|
|
},
|
|
"bundler": {
|
|
"type": "string",
|
|
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
|
|
"enum": ["none", "vite", "rollup"],
|
|
"default": "none",
|
|
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup.",
|
|
"x-priority": "important"
|
|
},
|
|
"linter": {
|
|
"description": "The tool to use for running lint checks.",
|
|
"type": "string",
|
|
"enum": ["eslint", "none"],
|
|
"default": "none",
|
|
"x-prompt": "Which linter would you like to use?",
|
|
"x-priority": "important"
|
|
},
|
|
"unitTestRunner": {
|
|
"type": "string",
|
|
"enum": ["vitest", "jest", "none"],
|
|
"default": "none",
|
|
"description": "Test runner to use for unit tests.",
|
|
"x-prompt": "What unit test runner should be used?",
|
|
"x-priority": "important"
|
|
},
|
|
"inSourceTests": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files."
|
|
},
|
|
"tags": {
|
|
"type": "string",
|
|
"description": "Add tags to the library (used for linting).",
|
|
"alias": "t"
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"skipTsConfig": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not update `tsconfig.json` for development experience.",
|
|
"x-priority": "internal"
|
|
},
|
|
"routing": {
|
|
"type": "boolean",
|
|
"description": "Generate library with routes."
|
|
},
|
|
"appProject": {
|
|
"type": "string",
|
|
"description": "The application project to add the library route to.",
|
|
"alias": "a"
|
|
},
|
|
"publishable": {
|
|
"type": "boolean",
|
|
"description": "Create a publishable library."
|
|
},
|
|
"buildable": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Generate a buildable library that uses rollup to bundle.",
|
|
"x-deprecated": "Use the `bundler` option for greater control (none, vite, rollup)."
|
|
},
|
|
"importPath": {
|
|
"type": "string",
|
|
"description": "The library name used to import it, like `@myorg/my-awesome-lib`."
|
|
},
|
|
"component": {
|
|
"type": "boolean",
|
|
"description": "Generate a default component.",
|
|
"default": true
|
|
},
|
|
"js": {
|
|
"type": "boolean",
|
|
"description": "Generate JavaScript files rather than TypeScript files.",
|
|
"default": false
|
|
},
|
|
"globalCss": {
|
|
"type": "boolean",
|
|
"description": "When `true`, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
|
|
"default": false
|
|
},
|
|
"strict": {
|
|
"type": "boolean",
|
|
"description": "Whether to enable tsconfig strict mode or not.",
|
|
"default": true
|
|
},
|
|
"setParserOptionsProject": {
|
|
"type": "boolean",
|
|
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
|
|
"default": false
|
|
},
|
|
"compiler": {
|
|
"type": "string",
|
|
"enum": ["babel", "swc"],
|
|
"default": "babel",
|
|
"description": "Which compiler to use."
|
|
},
|
|
"skipPackageJson": {
|
|
"description": "Do not add dependencies to `package.json`.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"minimal": {
|
|
"description": "Create a React library with a minimal setup, no separate test files.",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"simpleName": {
|
|
"description": "Don't include the directory in the name of the module of the library.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-deprecated": "Use the --name option to provide the exact name instead. This option will be removed in Nx 22."
|
|
},
|
|
"useProjectJson": {
|
|
"type": "boolean",
|
|
"description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
|
|
}
|
|
},
|
|
"required": ["directory"],
|
|
"presets": []
|
|
},
|
|
"aliases": ["lib"],
|
|
"x-type": "library",
|
|
"description": "Create a React library.",
|
|
"implementation": "/packages/react/src/generators/library/library#libraryGeneratorInternal.ts",
|
|
"hidden": false,
|
|
"path": "/packages/react/src/generators/library/schema.json",
|
|
"type": "generator"
|
|
}
|