feat(nx): add basic-lib generator for streamlined library creation (#14992)

* 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

libs/nx-plugin/src/generators/basic-lib.ts

@@ -0,0 +1,127 @@
+import { execSync } from "child_process";
+import * as path from "path";
+
+import {
+  formatFiles,
+  generateFiles,
+  Tree,
+  offsetFromRoot,
+  updateJson,
+  runTasksInSerial,
+  GeneratorCallback,
+} from "@nx/devkit";
+
+import { BasicLibGeneratorSchema } from "./schema";
+
+/**
+ * An Nx generator for creating basic libraries.
+ * Generators help automate repetitive tasks like creating new components, libraries, or apps.
+ *
+ * @param {Tree} tree - The virtual file system tree that Nx uses to make changes
+ * @param {BasicLibGeneratorSchema} options - Configuration options for the generator
+ * @returns {Promise<void>} - Returns a promise that resolves when generation is complete
+ */
+export async function basicLibGenerator(
+  tree: Tree,
+  options: BasicLibGeneratorSchema,
+): Promise<GeneratorCallback> {
+  const projectRoot = `${options.directory}/${options.name}`;
+  const srcRoot = `${projectRoot}/src`;
+
+  /**
+   * Generate files from templates in the 'files/' directory.
+   * This copies all template files to the new library location.
+   */
+  generateFiles(tree, path.join(__dirname, "files"), projectRoot, {
+    ...options,
+    // `tmpl` is used in file names for template files. Setting it to an
+    // empty string here lets use be explicit with the naming of template
+    // files, and lets Nx handle stripping out "__tmpl__" from file names.
+    tmpl: "",
+    // `name` is a variable passed to template files for interpolation into
+    // their contents. It is set to the name of the library being generated.
+    name: options.name,
+    root: projectRoot,
+    // `offsetFromRoot` is helper to calculate relative path from the new
+    // library to project root.
+    offsetFromRoot: offsetFromRoot(projectRoot),
+  });
+
+  // Add TypeScript path to the base tsconfig
+  updateTsConfigPath(tree, options.name, srcRoot);
+
+  // Update CODEOWNERS with the new lib
+  updateCodeowners(tree, options.directory, options.name, options.team);
+
+  // Format all new files with prettier
+  await formatFiles(tree);
+
+  const tasks: GeneratorCallback[] = [];
+  // Run npm i after generation. Nx ships a helper function for this called
+  // installPackagesTask. When used here it was leaving package-lock in a
+  // broken state, so a manual approach was used instead.
+  tasks.push(() => {
+    execSync("npm install", { stdio: "inherit" });
+    return Promise.resolve();
+  });
+  return runTasksInSerial(...tasks);
+}
+
+/**
+ * Updates the base tsconfig.json file to include the new library.
+ * This allows importing the library using its alias path.
+ *
+ * @param {Tree} tree - The virtual file system tree
+ * @param {string} name - The library name
+ * @param {string} srcRoot - Path to the library's source files
+ */
+function updateTsConfigPath(tree: Tree, name: string, srcRoot: string) {
+  updateJson(tree, "tsconfig.base.json", (json) => {
+    const paths = json.compilerOptions.paths || {};
+
+    paths[`@bitwarden/${name}`] = [`${srcRoot}/index.ts`];
+
+    json.compilerOptions.paths = paths;
+    return json;
+  });
+}
+
+/**
+ * Updates the CODEOWNERS file to add ownership for the new library
+ *
+ * @param {Tree} tree - The virtual file system tree
+ * @param {string} directory - Directory where the library is created
+ * @param {string} name - The library name
+ * @param {string} team - The team responsible for the library
+ */
+function updateCodeowners(tree: Tree, directory: string, name: string, team: string) {
+  const codeownersPath = ".github/CODEOWNERS";
+
+  if (!tree.exists(codeownersPath)) {
+    console.warn("CODEOWNERS file not found at .github/CODEOWNERS");
+    return;
+  }
+
+  const teamHandleMap: Record<string, string> = {
+    "admin-console": "@bitwarden/team-admin-console-dev",
+    auth: "@bitwarden/team-auth-dev",
+    autofill: "@bitwarden/team-autofill-dev",
+    billing: "@bitwarden/team-billing-dev",
+    "data-insights-and-reporting": "@bitwarden/team-data-insights-and-reporting-dev",
+    "key-management": "@bitwarden/team-key-management-dev",
+    platform: "@bitwarden/team-platform-dev",
+    tools: "@bitwarden/team-tools-dev",
+    "ui-foundation": "@bitwarden/team-ui-foundation",
+    vault: "@bitwarden/team-vault-dev",
+  };
+
+  const teamHandle = teamHandleMap[team] || `@bitwarden/team-${team}-dev`;
+  const libPath = `${directory}/${name}`;
+
+  const newLine = `${libPath} ${teamHandle}\n`;
+
+  const content = tree.read(codeownersPath)?.toString() || "";
+  tree.write(codeownersPath, content + newLine);
+}
+
+export default basicLibGenerator;