@digigov/cli-build 2.0.0-750aec28 → 2.0.0-76ec20a0

package/build.js

@@ -62,11 +62,19 @@ export async function generateTypeDeclarationFiles(project, tsconfig, ctx) {
  * @param {string | undefined} options.tsconfig - The tsconfig path
  * @param {"esm" | "cjs"} options.format - The module format
  * @param {string} options.outdir - The output directory
+ * @param {boolean | undefined} [options.noLogs] - Whether to log debug information
  */
-export function buildFormat({ files: entryPoints, tsconfig, format, outdir }) {
+export function buildFormat({
+  files: entryPoints,
+  tsconfig,
+  format,
+  outdir,
+  noLogs,
+}) {
   assert(format === "esm" || format === "cjs", "Invalid format");
 
-  logger.log(`Running: esbuild for ${format.toUpperCase()} format`);
+  if (!noLogs)
+    logger.log(`Running: esbuild for ${format.toUpperCase()} format`);
   return baseEsbuild.build({
     ...BASE_OPTIONS,
     entryPoints,

package/generate-registry.js

@@ -6,74 +6,27 @@ import assert from "assert";
 
 import { getProjectTsconfig } from "./common.js";
 
-/**
- * Generate registry files for the given project
- *
- * @param {object} project - The project object
- * @param {string} project.root - The project root directory
- * @param {string} project.distDir - The project build directory
- * @param {string} project.name - The project name as in package.json
- * @param {string[]} filePaths - The paths of the files to include in the registry
- * @param {boolean} shouldGenerateStoriesRegistry - Whether to export stories in the registry
- * @returns {Promise<[string, string]>} - The paths of the generated registry files
+/** @typedef {Object} Project - Represents the project to be built
+ * @property {string} root - The project root directory
+ * @property {string} name - The project name as in package.json
+ * @property {string} distDir - The project build directory
  */
-export async function generateRegistryFiles(
-  project,
-  filePaths,
-  shouldGenerateStoriesRegistry = false,
-) {
-  const registryPath = ensureRegistryPath(project, "registry.js");
-  const lazyRegistryPath = ensureRegistryPath(project, "lazy.js");
-
-  const registry = generateRegistryFileContent(
-    project,
-    filePaths,
-    shouldGenerateStoriesRegistry,
-  );
-
-  const componentPathsOnly = filePaths.filter(
-    (path) => !path.includes("stories"),
-  );
-  const lazyRegistry = generateLazyFileContent(project, componentPathsOnly);
-
-  await Promise.all([
-    fs.writeFile(registryPath, registry),
-    fs.writeFile(lazyRegistryPath, lazyRegistry),
-  ]);
-
-  return [registryPath, lazyRegistryPath];
-}
 
 /**
- * Ensure that the registry file does not already exist at the given path
+ * Generate registry file for the given project
  *
- * @param {object} project - The project object
- * @param {string} project.root - The project root directory
- * @param {string} project.distDir - The project build directory
- * @param {string} fileName - The name of the registry file
- */
-function ensureRegistryPath(project, fileName) {
-  const registryPath = path.join(project.root, project.distDir, fileName);
-  if (fs.existsSync(registryPath))
-    throw new Error(`A "${fileName}" file already exists at ${registryPath}.`);
-  return registryPath;
-}
-
-/**
- * Generate registry file content for the given files
- *
- * @param {object} project - The project object
- * @param {string} project.root - The project root directory
- * @param {string} project.name - The project name as in package.json
+ * @param {Project} project - The project object
+ * @param {string} [registryFilename="registry.js"] - The name of the registry file
  * @param {string[]} absoluteFilePaths - The absolute paths of the files to include in the registry
- * @param {boolean} includeStories - Whether to include stories in the registry
- * @returns {string} - The registry file content or null if no components are found
+ * @returns {Promise<string>} - The path to the generated registry file
  */
-export function generateRegistryFileContent(
+export async function generateRegistry(
   project,
   absoluteFilePaths,
-  includeStories = false,
+  registryFilename = "registry.js",
 ) {
+  const registryPath = ensureRegistryPath(project, registryFilename);
+
   const relativePaths = absoluteFilePaths.map((path) => {
     assert(
       path.startsWith(project.root),
@@ -96,18 +49,15 @@ export function generateRegistryFileContent(
   const importStatements = registryPaths.map(
     (file) => `import * as ${file.uid} from "${file.path}";`,
   );
-  const exportStatements = registryPaths.map(
+  const componentsToExport = registryPaths.map(
     (file) => `  '${file.path}': lazyImport(${file.uid})`,
   );
 
-  const [components, stories] = splitStoriesExports(exportStatements);
-  logger.debug(`Including ${components.length} component modules in registry`);
-
-  if (includeStories) {
-    logger.debug(`Including ${stories.length} stories in registry`);
-  }
+  logger.debug(
+    `Including ${componentsToExport.length} items in ${registryPath}`,
+  );
 
-  let out = `
+  let registryFileContent = `
 ${importStatements.join("\n")}
 function lazyImport(pkgImport) {
   return new Proxy(
@@ -128,73 +78,29 @@ function lazyImport(pkgImport) {
   )
 }
 export default {
-${components.join(",\n")}
-};
-`;
-
-  if (includeStories) {
-    out += `
-
-export const stories = {
-${stories.join(",\n")}
+${componentsToExport.join(",\n")}
 };
 `;
-  }
-  return out;
-}
-
-/**
- * Extract a node-resolvable path
- *
- * @param {string} inputPath - The file path
- * @returns {string} - The node-resolvable path
- */
-export function toNodeResolvablePath(inputPath) {
-  const dir = path.dirname(inputPath);
-  const base = path.basename(inputPath, path.extname(inputPath));
-
-  return base === "index" ? dir : path.join(dir, base);
-}
-
-/**
- * Create a UID from a path
- *
- * @param {string} inputPath - The path
- * @returns {string} - The UID
- */
-export function createUid(inputPath) {
-  return inputPath.replace(/[\/@\-.]/g, "_");
-}
+  await fs.writeFile(registryPath, registryFileContent);
 
-/**
- * Split the given files into components and stories
- *
- * @param {string[]} exportStatements - The export statements
- * @returns {[string[], string[]]} - The split components and stories exports
- */
-export function splitStoriesExports(exportStatements) {
-  const stories = [];
-  const components = [];
-  for (const exportStatement of exportStatements) {
-    if (exportStatement.includes("_stories")) {
-      stories.push(exportStatement);
-    } else {
-      components.push(exportStatement);
-    }
-  }
-  return [components, stories];
+  return registryPath;
 }
 
 /**
- * Generate lazy component registry file content for the given project
+ * Generate a lazy registry file for the given project
  *
- * @param {object} project - The project object
- * @param {string} project.root - The project root directory
- * @param {string} project.name - The project name as in package.json
+ * @param {Project} project - The project object
  * @param {string[]} filePaths - The files whose exports will be included in the lazy registry
- * @returns {string} - The lazy component registry file content or null if no components are found
+ * @param {string} [lazyFilename="lazy.js"] - The name of the registry file
+ * @returns {Promise<string>} - The path to the generated lazy registry file
  */
-export function generateLazyFileContent(project, filePaths) {
+export async function generateLazyRegistry(
+  project,
+  filePaths,
+  lazyFilename = "lazy.js",
+) {
+  const lazyPath = ensureRegistryPath(project, lazyFilename);
+
   const tsMorphProject = new TsMorphProject({
     tsConfigFilePath: getProjectTsconfig(project.root),
   });
@@ -233,20 +139,60 @@ export function generateLazyFileContent(project, filePaths) {
       "Could not generate lazy registry. No exportable components found.",
     );
 
-  logger.debug(`Including ${componentCount} components in lazy registry`);
+  logger.debug(`Including ${componentCount} components in ${lazyPath}`);
 
-  const content = Object.entries(allComponents)
+  const componentsToExport = Object.entries(allComponents)
     .map(
       ([component, filePath]) =>
         `  '${component}': lazy(() => import('${filePath}').then((module) => ({ default: module['${component}'] })))`,
     )
     .join(",\n");
 
-  return `import { lazy } from 'react';
+  const lazyFileContent = `import { lazy } from 'react';
 export default {
-${content}
+${componentsToExport}
 };
 `;
+
+  await fs.writeFile(lazyPath, lazyFileContent);
+
+  return lazyPath;
+}
+
+/**
+ * Ensure that the registry file does not already exist at the given path
+ *
+ * @param {Project} project - The project object
+ * @param {string} fileName - The name of the registry file
+ */
+function ensureRegistryPath(project, fileName) {
+  const registryPath = path.join(project.root, project.distDir, fileName);
+  if (fs.existsSync(registryPath))
+    throw new Error(`A "${fileName}" file already exists at ${registryPath}.`);
+  return registryPath;
+}
+
+/**
+ * Extract a node-resolvable path
+ *
+ * @param {string} inputPath - The file path
+ * @returns {string} - The node-resolvable path
+ */
+function toNodeResolvablePath(inputPath) {
+  const dir = path.dirname(inputPath);
+  const base = path.basename(inputPath, path.extname(inputPath));
+
+  return base === "index" ? dir : path.join(dir, base);
+}
+
+/**
+ * Create a UID from a path
+ *
+ * @param {string} inputPath - The path
+ * @returns {string} - The UID
+ */
+function createUid(inputPath) {
+  return inputPath.replace(/[\/@\-.]/g, "_");
 }
 
 /**

package/index.js

@@ -1,6 +1,6 @@
 import { DigigovCommand, resolveProject, logger } from "@digigov/cli/lib";
 import { buildFormat, generateTypeDeclarationFiles } from "./build.js";
-import { generateRegistryFiles } from "./generate-registry.js";
+import { generateLazyRegistry, generateRegistry } from "./generate-registry.js";
 import copyFiles from "./copy-files.js";
 
 import { Option } from "commander";
@@ -55,12 +55,7 @@ async function main(options, ctx) {
     await generateTypeDeclarationFiles(project, tsconfig, ctx);
   }
 
-  const ignore = [...TEST_GLOBS];
-  if (options.includeStories) {
-    logger.debug("Including stories in the build");
-  } else {
-    ignore.push(...STORIES_GLOBS);
-  }
+  const ignore = [...TEST_GLOBS, ...STORIES_GLOBS];
   const filesToBuild = await glob(path.join(project.root, SRC_GLOB), {
     ignore,
   });
@@ -82,22 +77,39 @@ async function main(options, ctx) {
   logger.debug("Bundling done.");
 
   if (options.generateRegistry) {
-    const registryFiles = filesToBuild.filter(
-      (file) => !(file.includes("native") || file.endsWith(".d.ts")),
-    );
     logger.debug("Generating registry files...");
-    const registryFilePaths = await generateRegistryFiles(
-      project,
-      registryFiles,
-      options.includeStories,
+
+    const filesToIncludeInRegistry = filesToBuild.filter(
+      (file) => !(file.includes("native") || file.endsWith(".d.ts")),
     );
-    await buildFormat({
+    let storiesFiles = null;
+    if (options.includeStories) {
+      logger.debug("Including stories in the registry...");
+
+      storiesFiles = await glob(
+        STORIES_GLOBS.map((glob) => path.join(project.root, project.src, glob)),
+        {
+          ignore: ["**/*.native.*, **/*.d.ts"],
+        },
+      );
+    }
+
+    const [_, ...registryFilePaths] = await Promise.all([
+      storiesFiles
+        ? generateRegistry(project, storiesFiles, "stories-registry.js")
+        : null,
+      generateRegistry(project, filesToIncludeInRegistry),
+      generateLazyRegistry(project, filesToIncludeInRegistry),
+    ]);
+
+    buildFormat({
       files: registryFilePaths,
       tsconfig: tsconfig,
       format: "cjs",
       outdir: project.distDir + "/cjs",
-    });
-    logger.log("Generated registry files");
+      noLogs: true,
+    }),
+      logger.log("Generated registry files");
   }
 
   logger.debug("Copying files to build directory...");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digigov/cli-build",
-  "version": "2.0.0-750aec28",
+  "version": "2.0.0-76ec20a0",
   "description": "Build plugin for Digigov CLI",
   "main": "./index.js",
   "type": "module",
@@ -38,13 +38,13 @@
   "devDependencies": {
     "publint": "0.1.8",
     "vitest": "2.1.3",
-    "@digigov/cli-test": "2.0.0-750aec28",
+    "@digigov/cli-test": "2.0.0-76ec20a0",
     "@types/fs-extra": "11.0.4",
     "@types/node": "18.19.0",
     "typescript": "5.6.2"
   },
   "peerDependencies": {
-    "@digigov/cli": "2.0.0-750aec28",
+    "@digigov/cli": "2.0.0-76ec20a0",
     "next": "13.1.1"
   },
   "peerDependenciesMeta": {