b481063810
* fix(nx): add rootDir to existing project.json files
The @nx/js:tsc executor was creating builds with a structural mismatch where TypeScript
output files lived in a nested src/ directory, but package.json pointed to non-existent
dist/ paths. This caused "Cannot find module" errors throughout the dependency chain.
This fix adds the rootDir configuration to flatten the build output structure and updates
all package.json main/types fields to match the actual file locations.
Changes applied systematically across all affected libraries:
• Added "rootDir": "libs/{name}/src" to project.json build options
• Updated package.json "main" from "dist/index.js" to "index.js"
• Updated package.json "types" from "dist/index.d.ts" to "index.d.ts"
* fix(nx-plugin): set rootDir for any newly generated libs
The basic-lib generator was creating new libraries with the same package.json path bugs
that we just fixed in existing libraries. Without this template fix, any newly generated
library would inherit the broken configuration pattern.
Updated the generator templates to include:
• Added rootDir configuration to project.json template
• Fixed package.json template paths to use flattened structure
• Corrected template syntax bug (missing space in <%= name %>)
This ensures all future libraries created with "nx generate @bitwarden/nx-plugin:basic-lib"
will have proper build configuration from the start, preventing regression of the
systematic rootDir issue.
@bitwarden/nx-plugin
The @bitwarden/nx-plugin library is a custom Nx plugin developed specifically for Bitwarden projects. It
provides generators tailored to Bitwarden's architecture and coding standards.
Overview
This plugin extends Nx's capabilities with Bitwarden-specific nx generators that help maintain consistency across the codebase.
What are Nx Generators?
Nx generators are code generation tools that follow templates to create or modify files in your project. They can:
- Create new files from templates
- Modify existing files
- Update configuration files
- Ensure consistent project structure
- Automate repetitive tasks
If you're familiar with the code generation tools of say, the angular CLI, then you can just think of =nx= generators as that but on a larger scale. Generators can be run using the Nx CLI with the nx generate command (or the shorthand nx g).
When to Use Generators
Use generators when:
- Creating new libraries, components, or features that follow a standard pattern
- You want to ensure consistency across similar parts of your application
- You need to automate repetitive setup tasks
- You want to reduce the chance of human error in project setup
How @bitwarden/nx-plugin Fits Into the Project Architecture
@bitwarden/nx-plugin is designed to:
- Enforce Bitwarden's architectural decisions and code organization
- Streamline the creation of new libraries and components
- Ensure consistent configuration across the project
- Automate updates to project metadata and configuration files
- Reduce the learning curve for new contributors
By using this plugin, we maintain a consistent approach to code organization and structure across the entire project.
Installation and Setup
The plugin is included as a development dependency in the project. If you're working with a fresh clone of the repository, it will be installed when you run:
npm install
No additional setup is required to use the generators provided by the plugin.
Available Generators
The plugin currently includes the following generators:
basic-lib: Creates a new library with standard configuration and structure. Specific documentation for thebasic-libgenerator can be found here
Additional generators may be added in the future to support other common patterns in the Bitwarden codebase.
Creating A Nx Generator
This library is maintained by platform, but anyone from any team can add a generator if there is any amount of value added. If you need to create a new generator please do so by running
npx nx generate @nx/plugin:generator libs/nx-plugin/src/generators/your-generator-name-here}
This will create a basic generator structure for you to get started with.
Further Learning
To learn more about Nx plugins and how they work: