{ "name": "library", "factory": "./src/generators/library/library#libraryGenerator", "schema": { "$schema": "http://json-schema.org/schema", "$id": "NxTypescriptLibrary", "cli": "nx", "title": "Create a TypeScript Library", "description": "Create a TypeScript Library.", "type": "object", "properties": { "name": { "type": "string", "description": "Library name.", "$default": { "$source": "argv", "index": 0 }, "x-prompt": "What name would you like to use for the library?", "pattern": "^[a-zA-Z].*$" }, "directory": { "type": "string", "description": "A directory where the lib is placed.", "x-priority": "important" }, "linter": { "description": "The tool to use for running lint checks.", "type": "string", "enum": ["eslint", "none"], "default": "eslint" }, "unitTestRunner": { "type": "string", "enum": ["jest", "vitest", "none"], "description": "Test runner to use for unit tests.", "x-prompt": "Which unit test runner would you like to use?" }, "tags": { "type": "string", "description": "Add tags to the library (used for linting)." }, "skipFormat": { "description": "Skip formatting files.", "type": "boolean", "default": false, "x-priority": "internal" }, "skipTsConfig": { "type": "boolean", "description": "Do not update tsconfig.json for development experience.", "default": false, "x-priority": "internal" }, "includeBabelRc": { "type": "boolean", "description": "Include a .babelrc configuration to compile TypeScript files" }, "testEnvironment": { "type": "string", "enum": ["jsdom", "node"], "description": "The test environment to use if unitTestRunner is set to jest.", "default": "jsdom" }, "importPath": { "type": "string", "description": "The library name used to import it, like @myorg/my-awesome-lib." }, "pascalCaseFiles": { "type": "boolean", "description": "Use pascal case file names.", "alias": "P", "default": false }, "js": { "type": "boolean", "description": "Generate JavaScript files rather than TypeScript files.", "default": false }, "strict": { "type": "boolean", "description": "Whether to enable tsconfig strict mode or not.", "default": true }, "publishable": { "type": "boolean", "default": false, "description": "Generate a publishable library.", "x-priority": "important" }, "buildable": { "type": "boolean", "default": true, "description": "Generate a buildable library.", "x-priority": "important" }, "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 }, "config": { "type": "string", "enum": ["workspace", "project", "npm-scripts"], "default": "project", "description": "Determines whether the project's executors should be configured in `workspace.json`, `project.json` or as npm scripts.", "x-priority": "internal" }, "compiler": { "type": "string", "enum": ["tsc", "swc"], "default": "tsc", "description": "The compiler used by the build and test targets", "x-priority": "important" }, "bundler": { "description": "The bundler to use.", "type": "string", "enum": ["none", "esbuild", "rollup", "vite", "webpack"], "default": "none", "x-priority": "important" }, "skipTypeCheck": { "type": "boolean", "description": "Whether to skip TypeScript type checking for SWC compiler.", "default": false } }, "required": ["name"], "examplesFile": "## Examples\n\n{% tabs %}\n\n{% tab label=\"Using directory flag\" %}\n\nGenerate a library named `mylib` and put it under a directory named `myapp` (`libs/myapp/mylib`)\n\n```shell\nnpx nx g lib mylib --directory=myapp\n```\n\n{% /tab %}\n\n{% tab label=\"Use SWC compiler\" %}\n\nGenerate a library using [SWC](https://swc.rs) as the compiler\n\n```shell\nnpx nx g lib mylib --compiler=swc\n```\n\n{% /tab %}\n\n{% tab label=\"Minimal publishing target\" %}\n\nGenerate a **publishable** library with a minimal publishing target\n\n```shell\nnpx nx g lib mylib --publishable\n```\n\n{% /tab %}\n\n{% /tabs %}\n", "presets": [] }, "aliases": ["lib"], "x-type": "library", "description": "Create a library", "implementation": "/packages/js/src/generators/library/library#libraryGenerator.ts", "hidden": false, "path": "/packages/js/src/generators/library/schema.json", "type": "generator" }