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

package/common.js

@@ -0,0 +1,20 @@
+import fs from 'fs-extra';
+import path from 'path';
+
+const POSSIBLE_TS_CONFIGS = ['tsconfig.production.json', 'tsconfig.json'];
+
+/**
+ * Get the tsconfig path for the given project
+ *
+ * @param {string} projectRoot - The project root
+ * @returns {string | undefined} - The tsconfig path or undefined if not found
+ */
+export function getProjectTsconfig(projectRoot) {
+  for (const tsconfig of POSSIBLE_TS_CONFIGS) {
+    const tsconfigPath = path.join(projectRoot, tsconfig);
+    if (fs.existsSync(tsconfigPath)) {
+      return tsconfigPath;
+    }
+  }
+  return;
+}

package/copy-files.js

@@ -1,125 +1,161 @@
-/* eslint-disable no-console */
-const path = require("path");
-const fs = require("fs");
-const fse = require("fs-extra");
-const glob = require("glob");
-const { resolveProject } = require("@digigov/cli/lib");
+import { logger, resolveProject } from '@digigov/cli/lib';
+import fs from 'fs-extra';
+import path from 'path';
+import glob from 'globby';
 
-const project = resolveProject();
 const packagePath = process.cwd();
+const project = resolveProject();
 const buildPath = path.join(project.root, project.distDir);
 
-async function includeFileInBuild(file) {
+/**
+ * Copy a file from the package to the build directory
+ *
+ * @param {string} file - The file to include in the build
+ */
+function includeFileInBuild(file) {
   const sourcePath = path.resolve(packagePath, file);
   const targetPath = path.resolve(buildPath, path.basename(file));
-  await fse.copy(sourcePath, targetPath);
-  console.log(`Copied ${sourcePath} to ${targetPath}`);
+  fs.copySync(sourcePath, targetPath);
+  logger.debug(`Copied ${sourcePath} to build directory`);
+}
+
+function copyRegistryFilesToSrc() {
+  const registryPath = path.resolve(buildPath, 'registry/index.js');
+  const lazyPath = path.resolve(buildPath, 'lazy/index.js');
+  if (!fs.existsSync(registryPath) || !fs.existsSync(lazyPath)) return;
+
+  const srcPath = path.resolve(buildPath, 'src');
+  logger.debug(`Copying registry and lazy files to ${srcPath}`);
+  fs.copySync(registryPath, path.resolve(srcPath, 'registry.js'));
+  fs.copySync(lazyPath, path.resolve(srcPath, 'lazy.js'));
 }
 
-async function createRootPackageFile() {
-  const packageData = await fse.readFile(
-    path.resolve(packagePath, "./package.json"),
-    "utf8",
+/**
+ * Create a package.json file in the build directory
+ */
+function createRootPackageFile() {
+  const packageData = fs.readFileSync(
+    path.resolve(packagePath, './package.json'),
+    'utf8'
   );
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { nyc, scripts, devDependencies, workspaces, ...packageDataOther } =
     JSON.parse(packageData);
   const newPackageData = {
     ...packageDataOther,
     private: false,
-    main: "./cjs/index.js",
-    module: "./index.js",
-    typings: "./index.d.ts",
+    main: './cjs/index.js',
+    module: './index.js',
+    typings: './index.d.ts',
   };
-  const targetPath = path.resolve(buildPath, "./package.json");
+  const targetPath = path.resolve(buildPath, './package.json');
 
-  await fse.writeFile(
-    targetPath,
-    JSON.stringify(newPackageData, null, 2),
-    "utf8",
-  );
-  console.log(`Created package.json in ${targetPath}`);
+  fs.writeFileSync(targetPath, JSON.stringify(newPackageData, null, 2), 'utf8');
+  logger.debug(`Created package.json in build directory`);
 
   return newPackageData;
 }
 
+/**
+ * Create nested package.json files in the build directory
+ *
+ */
 function createNestedPackageFiles() {
-  const indexPaths = glob.sync(path.join(buildPath, "!(cjs)/**/index.js"));
+  const indexPaths = glob.sync(path.join(buildPath, '**/index.js'), {
+    ignore: [path.join(buildPath, 'cjs/**')],
+  });
 
   indexPaths.forEach((indexPath) => {
-    if (indexPath === path.join(buildPath, "index.js")) return;
+    if (indexPath === path.join(buildPath, 'index.js')) return;
     const packageData = {
       sideEffects: false,
-      module: "./index.js",
-      types: "./index.d.ts",
+      module: './index.js',
+      types: './index.d.ts',
       main: path.relative(
         path.dirname(indexPath),
-        indexPath.replace(buildPath, path.join(buildPath, "/cjs")),
+        indexPath.replace(buildPath, path.join(buildPath, '/cjs'))
       ),
     };
     fs.writeFileSync(
-      path.join(path.dirname(indexPath), "package.json"),
-      JSON.stringify(packageData, null, 2),
+      path.join(path.dirname(indexPath), 'package.json'),
+      JSON.stringify(packageData, null, 2)
     );
   });
 }
 
-async function prepend(file, string) {
-  const data = await fse.readFile(file, "utf8");
-  await fse.writeFile(file, string + data, "utf8");
+/**
+ * Prepend a string to a file
+ *
+ * @param {string} file - The file to prepend to
+ * @param {string} string - The string to prepend
+ */
+function prepend(file, string) {
+  const data = fs.readFileSync(file, 'utf8');
+  fs.writeFileSync(file, string + data, 'utf8');
+  logger.debug(`Prepended license to ${file}`);
 }
 
-async function addLicense(packageData) {
-  const license = `/** @license Digigov v${packageData.version}
+/**
+ * Add license to the top of the files
+ *
+ * @param {object} packageData - The package data
+ */
+function addLicense(packageData) {
+  const license = `/** @license Digigov v${packageData['version']}
  *
  * This source code is licensed under the BSD-2-Clause license found in the
  * LICENSE file in the root directory of this source tree.
  */
 `;
-  await Promise.all(
-    ["./index.js", "./index.mjs"].map(async (file) => {
-      try {
-        await prepend(path.resolve(buildPath, file), license);
-      } catch (err) {
-        if (err.code === "ENOENT") {
-          console.log(`Skipped license for ${file}`);
-        } else {
-          throw err;
-        }
+  ['./index.js', './index.mjs'].map(async (file) => {
+    try {
+      prepend(path.resolve(buildPath, file), license);
+    } catch (err) {
+      if (
+        typeof err === 'object' &&
+        err &&
+        'code' in err &&
+        err.code === 'ENOENT'
+      ) {
+        logger.debug(`Skipped license for ${file}`);
+      } else {
+        throw err;
       }
-    }),
-  );
+    }
+  });
 }
 
+/**
+ * Create separate index modules for each directory
+ */
 function createSeparateIndexModules() {
-  const files = glob.sync(path.join(buildPath, "**/!(index).js"));
+  const files = glob.sync(path.join(buildPath, '**/*.js'), {
+    ignore: [path.join(buildPath, '**/index.js')],
+  });
 
   files.forEach((file) => {
-    fs.mkdirSync(file.replace(".js", ""));
-    fs.renameSync(file, file.replace(".js", "/index.js"));
+    fs.mkdirSync(file.replace(/\.js$/, ''));
+    fs.renameSync(file, file.replace(/\.js$/, '/index.js'));
   });
 }
 
-async function run() {
-  try {
-    const packageData = await createRootPackageFile();
-    createSeparateIndexModules();
-    createNestedPackageFiles();
-
-    await Promise.all(
-      [
-        // use enhanced readme from workspace root for `@digigov/ui`
-        // packageData.name === '@digigov/ui' ? '../../README.md' : './README.md',
-        "./src",
-        "./README.md",
-        "./CHANGELOG.md",
-        "../../LICENSE",
-      ].map((file) => includeFileInBuild(file)),
-    );
+/**
+ * Run the copy files script
+ */
+export default function run() {
+  const packageData = createRootPackageFile();
+  createSeparateIndexModules();
+  createNestedPackageFiles();
+  copyRegistryFilesToSrc();
 
-    await addLicense(packageData);
-  } catch (err) {
-    console.error(err);
-  }
+  [
+    // use enhanced readme from workspace root for `@digigov/ui`
+    // packageData.name === '@digigov/ui' ? '../../README.md' : './README.md',
+    './src',
+    './README.md',
+    './CHANGELOG.md',
+    '../../LICENSE',
+  ].map((file) => includeFileInBuild(file));
+  addLicense(packageData);
 }
-
-run();

package/eslint.config.js

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

package/generate-registry.js

@@ -0,0 +1,214 @@
+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
+ */
+
+/**
+ * Generate registry file for the given project
+ *
+ * @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
+ * @returns {Promise<string>} - The path to the generated registry file
+ */
+export async function generateRegistry(
+  project,
+  absoluteFilePaths,
+  registryFilename = 'registry.js'
+) {
+  const registryPath = ensureRegistryPath(project, registryFilename);
+
+  const relativePaths = absoluteFilePaths.map((path) => {
+    assert(
+      path.startsWith(project.root),
+      'Expected path to be in project root'
+    );
+    return toNodeResolvablePath(
+      path.replace(`${project.root}/src/`, `${project.name}/`)
+    );
+  });
+  let registryPaths = relativePaths.map((path) => ({
+    path,
+    uid: createUid(path),
+  }));
+
+  if (registryPaths.length === 0)
+    throw new Error(
+      'Could not generate registry. No exportable modules found.'
+    );
+
+  const importStatements = registryPaths.map(
+    (file) => `import * as ${file.uid} from "${file.path}";`
+  );
+  const componentsToExport = registryPaths.map(
+    (file) => `  '${file.path}': lazyImport(${file.uid})`
+  );
+
+  logger.debug(
+    `Including ${componentsToExport.length} items in ${registryPath}`
+  );
+
+  let registryFileContent = `
+${importStatements.join('\n')}
+function lazyImport(pkgImport) {
+  return new Proxy(
+    {},
+    {
+      get: (_target, name) => {
+        if (name === '__esModule' || name === 'default') {
+          return pkgImport.default;
+        } else if(
+          name === '*'
+        ) {
+          return pkgImport;
+        } else {
+          return pkgImport[name];
+        }
+      },
+    }
+  )
+}
+export default {
+${componentsToExport.join(',\n')}
+};
+`;
+  await fs.writeFile(registryPath, registryFileContent);
+
+  return registryPath;
+}
+
+/**
+ * Generate a lazy registry file for the given project
+ *
+ * @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
+ */
+export async function generateLazyRegistry(
+  project,
+  filePaths,
+  lazyFilename = 'lazy.js'
+) {
+  const lazyPath = ensureRegistryPath(project, lazyFilename);
+
+  const tsMorphProject = new TsMorphProject({
+    tsConfigFilePath: getProjectTsconfig(project.root),
+  });
+
+  /** @type {Record<string, string>} */
+  let allComponents = {};
+
+  for (const filePath of filePaths) {
+    const sourceFile = tsMorphProject.addSourceFileAtPath(filePath);
+    const exports = sourceFile
+      .getExportSymbols()
+      .filter(isJsExport)
+      .map((symbol) => symbol.getName());
+
+    for (const exportedComponent of exports) {
+      if (
+        exportedComponent !== 'default' &&
+        exportedComponent.match(/^[A-Z]/)
+      ) {
+        if (
+          !allComponents[exportedComponent] ||
+          allComponents[exportedComponent].length < filePath.length // Make import path more specific
+        ) {
+          allComponents[exportedComponent] = toNodeResolvablePath(
+            filePath.replace(`${project.root}/src/`, `${project.name}/`)
+          );
+        }
+      }
+    }
+  }
+
+  const componentCount = Object.keys(allComponents).length;
+
+  if (componentCount === 0)
+    throw new Error(
+      'Could not generate lazy registry. No exportable components found.'
+    );
+
+  logger.debug(`Including ${componentCount} components in ${lazyPath}`);
+
+  const componentsToExport = Object.entries(allComponents)
+    .map(
+      ([component, filePath]) =>
+        `  '${component}': lazy(() => import('${filePath}').then((module) => ({ default: module['${component}'] })))`
+    )
+    .join(',\n');
+
+  const lazyFileContent = `import { lazy } from 'react';
+export default {
+${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, '_');
+}
+
+/**
+ * Check if a symbol is a JS export
+ *
+ * @param {import("ts-morph").Symbol} symbol - The symbol to check
+ */
+function isJsExport(symbol) {
+  const declarations = symbol.getDeclarations();
+  return declarations.some((declaration) => {
+    const kind = declaration.getKind();
+    return (
+      kind === SyntaxKind.FunctionDeclaration ||
+      kind === SyntaxKind.ClassDeclaration ||
+      kind === SyntaxKind.VariableDeclaration ||
+      kind === SyntaxKind.ExportSpecifier
+    );
+  });
+}