Create a TypeScript Library.
The @nx/js:lib generator will generate a library for you, and it will configure it according to the options you provide.
npx nx g @nx/js:lib libs/mylib
By default, the library that is generated when you use this executor without passing any options, like the example above, will be a buildable library, using the @nx/js:tsc executor as a builder.
You may configure the tools you want to use to build your library, or bundle it too, by passing the --bundler flag. The --bundler flag controls the compiler and/or the bundler that will be used to build your library. If you choose tsc or swc, the result will be a buildable library using either tsc or swc as the compiler. If you choose rollup or vite, the result will be a buildable library using rollup or vite as the bundler. In the case of rollup, it will default to the tsc compiler. If you choose esbuild, you may use the esbuildOptions property in your project.json under the build target options to specify whether you wish to bundle your library or not.
Generate a buildable library using the @nx/js:tsc executor. This uses tsc as the compiler.
npx nx g @nx/js:lib libs/mylib
By default, Nx will search for library in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
Show what will be generated without writing to disk:
nx g library ... --dry-run
A directory where the lib is placed.
string
Default: tsc
Accepted values: swc, tsc, rollup, vite, esbuild, none
The bundler to use. Choosing 'none' means this library is not buildable.
The library name used to import it, like @myorg/my-awesome-lib. Required for publishable library.
string
Accepted values: none, eslint
The tool to use for running lint checks.
Configure the library ready for use with nx release (https://nx.dev/core-features/manage-releases).
string
Accepted values: none, jest, vitest
Test runner to use for unit tests.
Include a .babelrc configuration to compile TypeScript files
Generate JavaScript files rather than TypeScript files.
Generate a library with a minimal setup. No README.md generated.
Whether to enable tsconfig strict mode or not.
Whether or not to configure the ESLint parserOptions.project option. We do not do this by default for lint performance reasons.
Whether to skip TypeScript type checking for SWC compiler.
Add tags to the library (used for linting).
string
Default: node
Accepted values: jsdom, node
The test environment to use if unitTestRunner is set to jest or vitest.
Use a project.json configuration file instead of inlining the Nx configuration in the package.json file.
string
Default: project
Accepted values: workspace, project, npm-scripts
Determines whether the project's executors should be configured in workspace.json, project.json or as npm scripts.
Do not add dependencies to package.json.
Do not update tsconfig.json for development experience.
Generate a buildable library.
Use the bundler option for greater control (swc, tsc, rollup, vite, esbuild, none).
string
Accepted values: tsc, swc
The compiler used by the build and test targets
Use the bundler option for greater control (swc, tsc, rollup, vite, esbuild, none).
Don't include the directory in the generated file name.
Use the --name option to provide the exact name instead. This option will be removed in Nx 22.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4