@digigov/cli-build 2.0.0-e7d30530 → 2.0.0-eaf330f5

package/generate-registry.js

@@ -1,39 +1,86 @@
-import { logger } from '@digigov/cli/lib';
-import path from 'path';
-import fs from 'fs-extra';
-import { SyntaxKind, Project as TsMorphProject } from 'ts-morph';
-import assert from 'assert';
-
-import { getProjectTsconfig } from './common.js';
-
-/** @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
+import { logger } from "@digigov/cli/lib";
+import path from "path";
+import fs from "fs-extra";
+import { SyntaxKind, Project as TsMorphProject } from "ts-morph";
+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
  */
+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];
+}
 
 /**
- * Generate registry file for the given project
+ * Ensure that the registry file does not already exist at the given path
  *
- * @param {Project} project - The project object
- * @param {string} [registryFilename="registry.js"] - The name of the registry file
+ * @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 {string[]} absoluteFilePaths - The absolute paths of the files to include in the registry
- * @returns {Promise<string>} - The path to the generated registry file
+ * @param {boolean} includeStories - Whether to include stories in the registry
+ * @returns {string} - The registry file content or null if no components are found
  */
-export async function generateRegistry(
+export function generateRegistryFileContent(
   project,
   absoluteFilePaths,
-  registryFilename = 'registry.js'
+  includeStories = false,
 ) {
-  const registryPath = ensureRegistryPath(project, registryFilename);
-
   const relativePaths = absoluteFilePaths.map((path) => {
     assert(
       path.startsWith(project.root),
-      'Expected path to be in project root'
+      "Expected path to be in project root",
     );
     return toNodeResolvablePath(
-      path.replace(`${project.root}/src/`, `${project.name}/`)
+      path.replace(`${project.root}/src/`, `${project.name}/`),
     );
   });
   let registryPaths = relativePaths.map((path) => ({
@@ -43,22 +90,25 @@ export async function generateRegistry(
 
   if (registryPaths.length === 0)
     throw new Error(
-      'Could not generate registry. No exportable modules found.'
+      "Could not generate registry. No exportable modules found.",
     );
 
   const importStatements = registryPaths.map(
-    (file) => `import * as ${file.uid} from "${file.path}";`
+    (file) => `import * as ${file.uid} from "${file.path}";`,
   );
-  const componentsToExport = registryPaths.map(
-    (file) => `  '${file.path}': lazyImport(${file.uid})`
+  const exportStatements = registryPaths.map(
+    (file) => `  '${file.path}': lazyImport(${file.uid})`,
   );
 
-  logger.debug(
-    `Including ${componentsToExport.length} items in ${registryPath}`
-  );
+  const [components, stories] = splitStoriesExports(exportStatements);
+  logger.debug(`Including ${components.length} component modules in registry`);
 
-  let registryFileContent = `
-${importStatements.join('\n')}
+  if (includeStories) {
+    logger.debug(`Including ${stories.length} stories in registry`);
+  }
+
+  let out = `
+${importStatements.join("\n")}
 function lazyImport(pkgImport) {
   return new Proxy(
     {},
@@ -78,29 +128,73 @@ function lazyImport(pkgImport) {
   )
 }
 export default {
-${componentsToExport.join(',\n')}
+${components.join(",\n")}
 };
 `;
-  await fs.writeFile(registryPath, registryFileContent);
 
-  return registryPath;
+  if (includeStories) {
+    out += `
+
+export const stories = {
+${stories.join(",\n")}
+};
+`;
+  }
+  return out;
 }
 
 /**
- * Generate a lazy registry file for the given project
+ * Extract a node-resolvable path
  *
- * @param {Project} project - The project object
- * @param {string[]} filePaths - The files whose exports will be included in the lazy registry
- * @param {string} [lazyFilename="lazy.js"] - The name of the registry file
- * @returns {Promise<string>} - The path to the generated lazy registry file
+ * @param {string} inputPath - The file path
+ * @returns {string} - The node-resolvable path
  */
-export async function generateLazyRegistry(
-  project,
-  filePaths,
-  lazyFilename = 'lazy.js'
-) {
-  const lazyPath = ensureRegistryPath(project, lazyFilename);
+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, "_");
+}
 
+/**
+ * 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];
+}
+
+/**
+ * Generate lazy component registry file content 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 {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
+ */
+export function generateLazyFileContent(project, filePaths) {
   const tsMorphProject = new TsMorphProject({
     tsConfigFilePath: getProjectTsconfig(project.root),
   });
@@ -117,7 +211,7 @@ export async function generateLazyRegistry(
 
     for (const exportedComponent of exports) {
       if (
-        exportedComponent !== 'default' &&
+        exportedComponent !== "default" &&
         exportedComponent.match(/^[A-Z]/)
       ) {
         if (
@@ -125,7 +219,7 @@ export async function generateLazyRegistry(
           allComponents[exportedComponent].length < filePath.length // Make import path more specific
         ) {
           allComponents[exportedComponent] = toNodeResolvablePath(
-            filePath.replace(`${project.root}/src/`, `${project.name}/`)
+            filePath.replace(`${project.root}/src/`, `${project.name}/`),
           );
         }
       }
@@ -136,63 +230,23 @@ export async function generateLazyRegistry(
 
   if (componentCount === 0)
     throw new Error(
-      'Could not generate lazy registry. No exportable components found.'
+      "Could not generate lazy registry. No exportable components found.",
     );
 
-  logger.debug(`Including ${componentCount} components in ${lazyPath}`);
+  logger.debug(`Including ${componentCount} components in lazy registry`);
 
-  const componentsToExport = Object.entries(allComponents)
+  const content = Object.entries(allComponents)
     .map(
       ([component, filePath]) =>
-        `  '${component}': lazy(() => import('${filePath}').then((module) => ({ default: module['${component}'] })))`
+        `  '${component}': lazy(() => import('${filePath}').then((module) => ({ default: module['${component}'] })))`,
     )
-    .join(',\n');
+    .join(",\n");
 
-  const lazyFileContent = `import { lazy } from 'react';
+  return `import { lazy } from 'react';
 export default {
-${componentsToExport}
+${content}
 };
 `;
-
-  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,36 +1,36 @@
-import { DigigovCommand, resolveProject, logger } from '@digigov/cli/lib';
-import { buildFormat, generateTypeDeclarationFiles } from './build.js';
-import { generateLazyRegistry, generateRegistry } from './generate-registry.js';
-import copyFiles from './copy-files.js';
+import { DigigovCommand, resolveProject, logger } from "@digigov/cli/lib";
+import { buildFormat, generateTypeDeclarationFiles } from "./build.js";
+import { generateRegistryFiles } from "./generate-registry.js";
+import copyFiles from "./copy-files.js";
 
-import { Option } from 'commander';
-import path from 'path';
-import glob from 'globby';
-import assert from 'assert';
-import { getProjectTsconfig } from './common.js';
+import { Option } from "commander";
+import path from "path";
+import glob from "globby";
+import assert from "assert";
+import { getProjectTsconfig } from "./common.js";
 
-const command = new DigigovCommand('build', import.meta.url)
+const command = new DigigovCommand("build", import.meta.url)
   .option(
-    '--generate-registry',
-    'Generate a registry file for the build output'
+    "--generate-registry",
+    "Generate a registry file for the build output",
   )
   .addOption(
-    new Option('--include-stories', 'Include stories in the output').implies({
+    new Option("--include-stories", "Include stories in the output").implies({
       generateRegistry: true,
-    })
+    }),
   )
   .action(main);
 export default command;
 
-const SRC_GLOB = 'src/**/*.{tsx,ts,js,jsx}';
+const SRC_GLOB = "src/**/*.{tsx,ts,js,jsx}";
 const TEST_GLOBS = [
-  '**/*.test.{js,jsx,ts,tsx}',
-  '**/*.spec.{js,jsx,ts,tsx}',
-  '**/__tests__/**/*.{js,jsx,ts,tsx}',
+  "**/*.test.{js,jsx,ts,tsx}",
+  "**/*.spec.{js,jsx,ts,tsx}",
+  "**/__tests__/**/*.{js,jsx,ts,tsx}",
 ];
 const STORIES_GLOBS = [
-  '**/*.stories.{js,jsx,ts,tsx}',
-  '**/__stories__/**/*.{js,jsxts,tsx}',
+  "**/*.stories.{js,jsx,ts,tsx}",
+  "**/__stories__/**/*.{js,jsxts,tsx}",
 ];
 
 /**
@@ -42,7 +42,7 @@ const STORIES_GLOBS = [
 async function main(options, ctx) {
   const project = resolveProject();
 
-  await ctx.exec('rimraf', [project.distDir]);
+  await ctx.exec("rimraf", [project.distDir]);
 
   /**
    * The project tsconfig, or undefined if the project is not using TypeScript
@@ -51,68 +51,56 @@ async function main(options, ctx) {
   let tsconfig;
   if (project.isTs) {
     tsconfig = getProjectTsconfig(project.root);
-    assert(tsconfig, 'Expected tsconfig to be in project');
+    assert(tsconfig, "Expected tsconfig to be in project");
     await generateTypeDeclarationFiles(project, tsconfig, ctx);
   }
 
-  const ignore = [...TEST_GLOBS, ...STORIES_GLOBS];
+  const ignore = [...TEST_GLOBS];
+  if (options.includeStories) {
+    logger.debug("Including stories in the build");
+  } else {
+    ignore.push(...STORIES_GLOBS);
+  }
   const filesToBuild = await glob(path.join(project.root, SRC_GLOB), {
     ignore,
   });
-  logger.debug('Bundling ESM and CJS...');
+  logger.debug("Bundling ESM and CJS...");
   await Promise.all([
     buildFormat({
       files: filesToBuild,
       tsconfig: tsconfig,
-      format: 'cjs',
-      outdir: project.distDir + '/cjs',
+      format: "cjs",
+      outdir: project.distDir + "/cjs",
     }),
     buildFormat({
       files: filesToBuild,
       tsconfig,
-      format: 'esm',
+      format: "esm",
       outdir: project.distDir,
     }),
   ]);
-  logger.debug('Bundling done.');
+  logger.debug("Bundling done.");
 
   if (options.generateRegistry) {
-    logger.debug('Generating registry files...');
-
-    const filesToIncludeInRegistry = filesToBuild.filter(
-      (file) => !(file.includes('native') || file.endsWith('.d.ts'))
+    const registryFiles = filesToBuild.filter(
+      (file) => !(file.includes("native") || file.endsWith(".d.ts")),
     );
-    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({
+    logger.debug("Generating registry files...");
+    const registryFilePaths = await generateRegistryFiles(
+      project,
+      registryFiles,
+      options.includeStories,
+    );
+    await buildFormat({
       files: registryFilePaths,
       tsconfig: tsconfig,
-      format: 'cjs',
-      outdir: project.distDir + '/cjs',
-      noLogs: true,
+      format: "cjs",
+      outdir: project.distDir + "/cjs",
     });
-    logger.log('Generated registry files');
+    logger.log("Generated registry files");
   }
 
-  logger.debug('Copying files to build directory...');
+  logger.debug("Copying files to build directory...");
   copyFiles();
-  logger.debug('Files copied.');
+  logger.debug("Files copied.");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digigov/cli-build",
-  "version": "2.0.0-e7d30530",
+  "version": "2.0.0-eaf330f5",
   "description": "Build plugin for Digigov CLI",
   "main": "./index.js",
   "type": "module",
@@ -8,8 +8,27 @@
   "license": "BSD-2-Clause",
   "private": false,
   "dependencies": {
+    "@babel/cli": "7.12.1",
+    "@babel/compat-data": "7.12.5",
+    "@babel/core": "7.26.0",
+    "@babel/helper-validator-identifier": "7.9.5",
+    "@babel/plugin-proposal-class-properties": "7.12.1",
+    "@babel/plugin-proposal-object-rest-spread": "7.12.1",
+    "@babel/plugin-transform-object-assign": "7.12.1",
+    "@babel/plugin-transform-runtime": "7.12.1",
+    "@babel/preset-env": "7.12.13",
+    "@babel/preset-react": "7.12.13",
+    "@babel/preset-typescript": "7.12.1",
+    "babel-plugin-inline-import-data-uri": "1.0.1",
+    "babel-plugin-module-resolver": "4.0.0",
+    "babel-plugin-optimize-clsx": "1.1.1",
+    "babel-plugin-react-remove-properties": "0.3.0",
+    "babel-plugin-transform-dev-warning": "0.1.1",
+    "babel-plugin-transform-react-constant-elements": "6.23.0",
+    "babel-plugin-transform-react-remove-prop-types": "0.4.24",
     "fs-extra": "11.2.0",
     "globby": "11.0.0",
+    "babel-plugin-istanbul": "7.0.0",
     "publint": "0.1.8",
     "rimraf": "3.0.2",
     "esbuild": "0.23.0",
@@ -17,19 +36,15 @@
     "ts-morph": "25.0.0"
   },
   "devDependencies": {
-    "@digigov/cli": "2.0.0-e7d30530",
-    "@digigov/cli-lint": "2.0.0-e7d30530",
     "publint": "0.1.8",
     "vitest": "2.1.3",
-    "@digigov/cli-test": "2.0.0-e7d30530",
+    "@digigov/cli-test": "2.0.0-eaf330f5",
     "@types/fs-extra": "11.0.4",
-    "@types/node": "20.17.24",
-    "typescript": "5.6.2",
-    "eslint": "9.16.0",
-    "prettier": "3.4.2"
+    "@types/node": "18.19.0",
+    "typescript": "5.6.2"
   },
   "peerDependencies": {
-    "@digigov/cli": "2.0.0-e7d30530",
+    "@digigov/cli": "2.0.0-eaf330f5",
     "next": "13.1.1"
   },
   "peerDependenciesMeta": {
@@ -38,8 +53,6 @@
     }
   },
   "scripts": {
-    "publint": "publint",
-    "lint": "digigov lint",
-    "typecheck": "tsc"
+    "publint": "publint"
   }
 }

package/tsconfig.json

@@ -1,8 +1,12 @@
 {
   "extends": "@digigov/cli/tsconfig.cli",
   "compilerOptions": {
-    "types": ["vitest/globals"]
+    "types": [
+      "vitest/globals"
+    ]
   },
-  "include": ["./*.js", "__tests__"],
-  "exclude": ["eslint.config.js", ".prettierrc.cjs"]
+  "include": [
+    "./*.js",
+    "__tests__"
+  ]
 }

package/.prettierrc.cjs

@@ -1 +0,0 @@
-module.exports = require('@digigov/cli-lint/prettierrc')();

package/eslint.config.js

@@ -1,3 +0,0 @@
-import config from '@digigov/cli-lint/eslint.config';
-
-export default [...config];