mirror of
https://github.com/bitwarden/browser
synced 2025-12-18 17:23:37 +00:00
e8224fdbe3
* feat(nx): add basic-lib generator for streamlined library creation This adds a new nx-plugin library with a generator for creating "common" type Bitwarden libs. It is set up to accept a lib name, description, team, and directory. It then - Creates a folder in the directory (default to libs) - Sets up complete library scaffolding: - README with team ownership - Build, lint and test task configuration - Test infrastructure - Configures TypeScript path mapping - Updates CODEOWNERS with team ownership - Runs npm i This will make library creation more consistent and reduce manual boilerplate setup. The plugin design itself was generated by `npx nx g plugin`. This means we used a plugin to generate a plugin that exports generators. To create our generator generator, we first needed a generator. * fix(dirt/card): correct tsconfig path in jest configuration Fix the relative path to tsconfig.base in the dirt/card library's Jest config. The path was incorrectly using four parent directory traversals (../../../../) when only three (../../../) were needed to reach the project root. * chore(codeowners): clarify some nx ownership stuff
86 lines
3.6 KiB
TypeScript
86 lines
3.6 KiB
TypeScript
import { Tree, readProjectConfiguration } from "@nx/devkit";
|
|
import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
|
|
|
|
import { basicLibGenerator } from "./basic-lib";
|
|
import { BasicLibGeneratorSchema } from "./schema";
|
|
|
|
describe("basic-lib generator", () => {
|
|
let tree: Tree;
|
|
const options: BasicLibGeneratorSchema = {
|
|
name: "test",
|
|
description: "test",
|
|
team: "platform",
|
|
directory: "libs",
|
|
};
|
|
|
|
beforeEach(() => {
|
|
tree = createTreeWithEmptyWorkspace();
|
|
});
|
|
|
|
it("should update tsconfig.base.json paths", async () => {
|
|
tree.write("tsconfig.base.json", JSON.stringify({ compilerOptions: { paths: {} } }));
|
|
await basicLibGenerator(tree, options);
|
|
const tsconfigContent = tree.read("tsconfig.base.json");
|
|
expect(tsconfigContent).not.toBeNull();
|
|
const tsconfig = JSON.parse(tsconfigContent?.toString() ?? "");
|
|
expect(tsconfig.compilerOptions.paths[`@bitwarden/${options.name}`]).toEqual([
|
|
`libs/test/src/index.ts`,
|
|
]);
|
|
});
|
|
|
|
it("should update CODEOWNERS file", async () => {
|
|
tree.write(".github/CODEOWNERS", "# Existing content\n");
|
|
await basicLibGenerator(tree, options);
|
|
const codeownersContent = tree.read(".github/CODEOWNERS");
|
|
expect(codeownersContent).not.toBeNull();
|
|
const codeowners = codeownersContent?.toString();
|
|
expect(codeowners).toContain(`libs/test @bitwarden/team-platform-dev`);
|
|
});
|
|
|
|
it("should generate expected files", async () => {
|
|
await basicLibGenerator(tree, options);
|
|
|
|
const config = readProjectConfiguration(tree, "test");
|
|
expect(config).toBeDefined();
|
|
|
|
expect(tree.exists(`libs/test/README.md`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/eslint.config.mjs`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/jest.config.js`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/package.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/tsconfig.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/tsconfig.lib.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/tsconfig.spec.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/src/index.ts`)).toBeTruthy();
|
|
});
|
|
|
|
it("should handle missing CODEOWNERS file gracefully", async () => {
|
|
const consoleSpy = jest.spyOn(console, "warn").mockImplementation();
|
|
await basicLibGenerator(tree, options);
|
|
expect(consoleSpy).toHaveBeenCalledWith("CODEOWNERS file not found at .github/CODEOWNERS");
|
|
consoleSpy.mockRestore();
|
|
});
|
|
|
|
it("should map team names to correct GitHub handles", async () => {
|
|
tree.write(".github/CODEOWNERS", "");
|
|
await basicLibGenerator(tree, { ...options, team: "vault" });
|
|
const codeownersContent = tree.read(".github/CODEOWNERS");
|
|
expect(codeownersContent).not.toBeNull();
|
|
const codeowners = codeownersContent?.toString();
|
|
expect(codeowners).toContain(`libs/test @bitwarden/team-vault-dev`);
|
|
});
|
|
|
|
it("should generate expected files", async () => {
|
|
await basicLibGenerator(tree, options);
|
|
expect(tree.exists(`libs/test/README.md`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/eslint.config.mjs`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/jest.config.js`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/package.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/project.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/tsconfig.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/tsconfig.lib.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/tsconfig.spec.json`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/src/index.ts`)).toBeTruthy();
|
|
expect(tree.exists(`libs/test/src/test.spec.ts`)).toBeTruthy();
|
|
});
|
|
});
|