@digigov/cli-build 2.0.0-36b707c1 → 2.0.0-385c7994

package/index.js

@@ -1,107 +1,176 @@
-const { Command } = require("@oclif/command");
-const execa = require("execa");
-const { resolveProject, DigigovCommand } = require("@digigov/cli/lib");
-const path = require("path");
-const fs = require("fs");
-const esbuild = require("esbuild");
-const glob = require("glob");
-
-module.exports = class Build extends DigigovCommand {
-  static description = "build digigov libraries";
-  static id = "build";
-  dirname = __dirname;
-  static examples = [`$ digigov build`];
-  static strict = false;
-  static load() {
-    return Build;
-  }
-  script = "babel";
-  async run() {
-    const { argv } = this.parse(Build);
-    try {
-      await this.exec("rimraf", ["dist"]);
-      const project = resolveProject();
-      const babelArgs = [
-        "--config-file",
-        path.join(__dirname, "babel.config.js"),
-        project.src,
-        "--extensions",
-        ".tsx,.ts,.js,.jsx",
-        "--copy-files",
-        "--out-dir",
-      ];
-      const distDir = path.resolve(project.root, project.distDir);
-      const basename = path.basename(project.root);
-
-      if (project.isTs) {
-        const tsconfigProduction = path.join(
-          project.root,
-          "tsconfig.production.json",
-        );
-        const tsArgs = [];
-        if (fs.existsSync(tsconfigProduction)) {
-          tsArgs.push("--project", tsconfigProduction);
-        }
-        await this.exec("tsc", [
-          "--emitDeclarationOnly",
-          "--outDir",
-          "dist",
-          ...tsArgs,
-        ]);
-        if (fs.existsSync(path.join(distDir, basename))) {
-          const typesIncluded = fs.readdirSync(path.join(distDir));
-          const paths = fs.readdirSync(
-            path.join(distDir, basename, project.src),
-          );
-          paths.forEach((p) => {
-            fs.renameSync(
-              path.join(distDir, basename, project.src, p),
-              path.join(distDir, p),
-            );
-          });
-          typesIncluded.forEach((typesDir) => {
-            fs.rmSync(path.join(distDir, typesDir), { recursive: true });
-          });
-        }
+import { DigigovCommand, resolveProject, logger } from '@digigov/cli/lib';
+import { build } from '@rslib/core';
+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 { generateLazyRegistry, generateRegistry } from './generate-registry.js';
+import transformImportsPlugin from './transform-imports-plugin.js';
+
+const command = new DigigovCommand('build', import.meta.url)
+  .option(
+    '--generate-registry',
+    'Generate a registry file for the build output'
+  )
+  .addOption(
+    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 TEST_GLOBS = [
+  '**/*.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,jsx,ts,tsx}',
+  '**/__stories__/*.{js,jsx,ts,tsx}',
+];
+
+/**
+ * @param {object} options - The command options
+ * @param {boolean} options.generateRegistry - Generate a registry file for the build output
+ * @param {boolean} options.includeStories - Include stories in the generated registry file
+ * @param {DigigovCommand} ctx
+ */
+async function main(options, ctx) {
+  /** @type {string[]} */
+  let filesToDelete = [];
+  let isCleaningUp = false;
+  let signalHandlersRegistered = false;
+
+  const cleanup = async () => {
+    if (isCleaningUp) return;
+    isCleaningUp = true;
+
+    if (options.generateRegistry && filesToDelete.length > 0) {
+      logger.debug('Deleting temporary registry files...');
+      try {
+        await ctx.exec('rimraf', filesToDelete, {}, true);
+      } catch (error) {
+        logger.error('Error during cleanup:', error);
       }
+    }
 
-      const files = glob.sync(
-        path.join(project.root, "src", "**/*.{tsx,ts,js,jsx}"),
-        {
-          ignore: "**/*.{spec,test}.{ts,tsx,js,jsx}",
-        },
+    // Remove signal handlers after cleanup
+    if (signalHandlersRegistered) {
+      process.off('SIGINT', handleSignal);
+      process.off('SIGTERM', handleSignal);
+    }
+  };
+
+  /** @param {string} signal */
+  const handleSignal = async (signal) => {
+    logger.log(`\nReceived ${signal}, cleaning up...`);
+    await cleanup();
+    process.exit(signal === 'SIGINT' ? 130 : 143);
+  };
+
+  // Register signal handlers
+  process.on('SIGINT', handleSignal);
+  process.on('SIGTERM', handleSignal);
+  signalHandlersRegistered = true;
+
+  try {
+    const project = resolveProject();
+
+    await ctx.exec('rimraf', [project.distDir]);
+
+    /**
+     * The project tsconfig, or undefined if the project is not using TypeScript
+     * @type {string | undefined}
+     */
+    let tsconfig;
+    if (project.isTs) {
+      tsconfig = getProjectTsconfig(project.root);
+      assert(tsconfig, 'Expected tsconfig to be in project');
+    }
+
+    if (options.generateRegistry) {
+      logger.debug('Generating registry files...');
+
+      const initialFiles = await glob(path.join(project.root, SRC_GLOB), {
+        ignore: [...TEST_GLOBS, ...STORIES_GLOBS],
+      });
+
+      const filesToIncludeInRegistry = initialFiles.filter(
+        (file) => !(file.includes('native') || file.endsWith('.d.ts'))
       );
-      const commonBuildOptions = {
-        entryPoints: files,
-        platform: "node",
-        sourcemap: true,
-        target: ["esnext"],
-        logLevel: "error",
-      };
-      if (fs.existsSync(path.join(project.root, "tsconfig.production.json"))) {
-        commonBuildOptions["tsconfig"] = "tsconfig.production.json";
-      } else if (fs.existsSync(path.join(project.root, "tsconfig.json"))) {
-        commonBuildOptions["tsconfig"] = "tsconfig.json";
+      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'],
+          }
+        );
       }
 
-      await Promise.all([
-        esbuild.build({
-          ...commonBuildOptions,
-          format: "esm",
-          outdir: `dist`,
-        }),
-        esbuild.build({
-          ...commonBuildOptions,
-          format: "cjs",
-          outdir: `dist/cjs`,
-        }),
-      ]);
-      await execa("node", [path.join(__dirname, "copy-files.js")], {
-        env: {},
-        stdio: "inherit",
-      });
-    } catch (err) {
-      console.error(err);
+      filesToDelete = await Promise.all([
+        storiesFiles
+          ? generateRegistry(project, storiesFiles, 'stories-registry.ts')
+          : null,
+        generateRegistry(project, filesToIncludeInRegistry, 'registry.ts'),
+        generateLazyRegistry(project, filesToIncludeInRegistry, 'lazy.ts'),
+      ]).then((paths) => paths.filter((p) => p !== null));
+
+      logger.log('Generated registry files');
     }
+
+    const IGNORE_BLOBS = [...TEST_GLOBS, ...STORIES_GLOBS].map(
+      (path) => `!${project.root}/${path}`
+    );
+
+    logger.debug('Building...');
+    await build({
+      source: {
+        tsconfigPath: tsconfig,
+        entry: {
+          index: [`${project.root}/${SRC_GLOB}`, ...IGNORE_BLOBS],
+        },
+      },
+      output: {
+        distPath: {
+          root: project.distDir,
+        },
+      },
+      lib: [
+        {
+          redirect: {
+            dts: {
+              extension: true,
+            },
+          },
+          bundle: false,
+          dts: {
+            bundle: false,
+            autoExtension: true,
+          },
+          format: 'esm',
+          plugins: [
+            transformImportsPlugin(project, ['@uides/react-qr-reader']),
+          ],
+        },
+      ],
+    });
+    logger.debug('Building done.');
+
+    logger.debug('Copying files to build directory...');
+    copyFiles();
+    logger.debug('Files copied.');
+  } finally {
+    await cleanup();
   }
-};
+}

package/package.json

@@ -1,48 +1,45 @@
 {
   "name": "@digigov/cli-build",
-  "version": "2.0.0-36b707c1",
+  "version": "2.0.0-385c7994",
   "description": "Build plugin for Digigov CLI",
   "main": "./index.js",
+  "type": "module",
   "author": "GRNET Devs <devs@lists.grnet.gr>",
   "license": "BSD-2-Clause",
   "private": false,
   "dependencies": {
-    "@babel/cli": "7.12.1",
-    "@babel/compat-data": "7.12.5",
-    "@babel/core": "7.12.13",
-    "@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",
-    "glob": "7.1.6",
-    "typescript": "5.6.2",
-    "@types/node": "18.19.0",
-    "babel-plugin-istanbul": "7.0.0",
+    "globby": "11.0.0",
     "publint": "0.1.8",
-    "esbuild": "0.23.0",
-    "@digigov/babel-ts-to-proptypes": "1.1.0"
+    "rimraf": "3.0.2",
+    "commander": "12.1.0",
+    "ts-morph": "25.0.0",
+    "@rslib/core": "0.15.1"
   },
   "devDependencies": {
-    "publint": "0.1.8"
+    "@digigov/cli": "2.0.0-385c7994",
+    "@digigov/cli-lint": "2.0.0-385c7994",
+    "publint": "0.1.8",
+    "vitest": "2.1.3",
+    "@digigov/cli-test": "2.0.0-385c7994",
+    "@types/fs-extra": "11.0.4",
+    "@types/node": "20.17.24",
+    "typescript": "5.6.2",
+    "eslint": "9.16.0",
+    "prettier": "3.4.2"
   },
   "peerDependencies": {
-    "@digigov/cli": "1.1.2-36b707c1",
-    "rimraf": "3.0.2",
+    "@digigov/cli": "2.0.0-385c7994",
     "next": "13.1.1"
   },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    }
+  },
   "scripts": {
-    "publint": "publint"
+    "publint": "publint",
+    "lint": "digigov lint",
+    "typecheck": "tsc"
   }
 }

package/transform-imports-plugin.js

@@ -0,0 +1,263 @@
+import { logger } from '@digigov/cli/lib';
+import path from 'path';
+import fs from 'fs';
+
+/**
+ * @param {Record<string, any>} project
+ * @param {string[]} [pathsToIgnore=[]]
+ * @returns {import('@rslib/core').rsbuild.RsbuildPlugin}
+ */
+export default function transformImportsPlugin(project, pathsToIgnore = []) {
+  const projectName = project['name'];
+  const projectRoot = project['root'];
+  const workspace = project['workspace'];
+
+  if (Object.keys(workspace).length === 0) {
+    throw new Error(
+      `transform-imports-plugin can only be used in workspace projects. ${projectName} is not a workspace project.`
+    );
+  }
+
+  const projectScopes =
+    workspace.config.projects.map((p) => p.packageName) ?? [];
+
+  if (projectScopes.length === 0) {
+    logger.warn(
+      `No project scopes found for ${projectName}. Plugin may not transform any imports.`
+    );
+  }
+
+  const importRegex =
+    /(?:^|[^'"\\])(?:from|import)\s*\(\s*['"]([^'"]+)['"]\s*\)|(?:from|import)\s+['"]([^'"]+)['"]/gm;
+
+  const packageJsonCache = new Map();
+  const fileExistsCache = new Map();
+  const resolvedImportsCache = new Map();
+
+  /**
+   * Check if a package uses exports field
+   * @param {string} packageName
+   * @returns {boolean}
+   */
+  function hasExportsField(packageName) {
+    if (packageJsonCache.has(packageName)) {
+      return packageJsonCache.get(packageName);
+    }
+
+    try {
+      const pkgJsonPath = path.join(
+        projectRoot,
+        'node_modules',
+        packageName,
+        'package.json'
+      );
+
+      if (fs.existsSync(pkgJsonPath)) {
+        const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'));
+        const hasExports = !!pkgJson.exports;
+        packageJsonCache.set(packageName, hasExports);
+        return hasExports;
+      }
+    } catch (error) {
+      logger.warn(`Failed to read package.json for ${packageName}:`, error);
+    }
+
+    packageJsonCache.set(packageName, false);
+    return false;
+  }
+
+  /**
+   * Check if a file exists with any of the given suffixes (with caching)
+   * @param {string} basePath
+   * @param {string[]} suffixes
+   * @returns {string | null} The matching suffix or null
+   */
+  function findFileWithSuffix(basePath, suffixes) {
+    const cacheKey = `${basePath}:${suffixes.join(',')}`;
+
+    if (fileExistsCache.has(cacheKey)) {
+      return fileExistsCache.get(cacheKey);
+    }
+
+    for (const suffix of suffixes) {
+      const fullPath = basePath + suffix;
+      if (fs.existsSync(fullPath)) {
+        fileExistsCache.set(cacheKey, suffix);
+        return suffix;
+      }
+    }
+
+    fileExistsCache.set(cacheKey, null);
+    return null;
+  }
+
+  /**
+   * Extract the package name from an import path
+   * @param {string} importPath
+   * @returns {string} The package name
+   */
+  function getPackageName(importPath) {
+    if (importPath.startsWith('@')) {
+      const parts = importPath.split('/');
+      return parts.slice(0, 2).join('/');
+    }
+    // @ts-expect-error - assured string
+    return importPath.split('/')[0];
+  }
+
+  /**
+   * Check if a package is internal based on project scopes
+   * @param {string} packageName
+   * @returns {boolean}
+   */
+  function isInternalPackage(packageName) {
+    return projectScopes.some((scope) => packageName.startsWith(scope));
+  }
+
+  /**
+   * Determine if an import should be skipped
+   * @param {string} importPath
+   * @returns {boolean}
+   */
+  function shouldSkipImport(importPath) {
+    return (
+      !importPath ||
+      importPath.includes(projectName) ||
+      pathsToIgnore.some((ignorePath) => importPath.startsWith(ignorePath)) ||
+      importPath.endsWith('.js') ||
+      importPath.endsWith('.mjs') ||
+      importPath.endsWith('.cjs') ||
+      importPath.startsWith('.') ||
+      importPath.startsWith('/') ||
+      importPath.startsWith('node:') ||
+      !importPath.includes('/')
+    );
+  }
+
+  /**
+   * Transform an internal package import
+   * @param {string} importPath
+   * @returns {string | null}
+   */
+  function transformInternalPackageImport(importPath) {
+    const parts = importPath.split('/');
+    const dependencyName = parts[1];
+
+    if (!dependencyName) return null;
+
+    // Replace the dependency name to point to /src
+    const srcPath = [...parts];
+    srcPath[1] = `${dependencyName}/src`;
+    const srcImportPath = srcPath.join('/');
+
+    const resolvedBase = path.join(projectRoot, 'node_modules', srcImportPath);
+
+    // Check for direct file match
+    const directMatch = findFileWithSuffix(resolvedBase, [
+      '.js',
+      '.jsx',
+      '.ts',
+      '.tsx',
+    ]);
+    if (directMatch) {
+      return importPath + '.js';
+    }
+
+    // Check for index file
+    const indexMatch = findFileWithSuffix(resolvedBase, [
+      '/index.js',
+      '/index.jsx',
+      '/index.ts',
+      '/index.tsx',
+    ]);
+    if (indexMatch) {
+      return importPath + '/index.js';
+    }
+
+    return null;
+  }
+
+  /**
+   * Transform a third-party package import
+   * @param {string} importPath
+   * @returns {string | null}
+   */
+  function transformThirdPartyImport(importPath) {
+    const resolvedBase = path.join(projectRoot, 'node_modules', importPath);
+
+    // Check for direct .js file
+    if (findFileWithSuffix(resolvedBase, ['.js'])) {
+      return importPath + '.js';
+    }
+
+    // Check for index.js
+    if (findFileWithSuffix(resolvedBase, ['/index.js'])) {
+      return importPath + '/index.js';
+    }
+
+    return null;
+  }
+
+  return {
+    name: 'transform-imports-plugin',
+    setup(api) {
+      api.transform(
+        { test: /\.[jt]sx?$/, order: 'post' },
+        ({ code, resourcePath }) => {
+          const transformedCode = code.replace(
+            importRegex,
+            (fullMatch, dynamicImport, staticImport) => {
+              const importPath = dynamicImport || staticImport;
+
+              // Early return for skippable imports
+              if (shouldSkipImport(importPath)) {
+                return fullMatch;
+              }
+
+              // Check cache first
+              if (resolvedImportsCache.has(importPath)) {
+                const cached = resolvedImportsCache.get(importPath);
+                return cached
+                  ? fullMatch.replace(importPath, cached)
+                  : fullMatch;
+              }
+
+              const packageName = getPackageName(importPath);
+
+              // Skip third-party packages with exports field
+              if (
+                !isInternalPackage(packageName) &&
+                hasExportsField(packageName)
+              ) {
+                logger.debug(`Skipping ${importPath} - uses exports field`);
+                resolvedImportsCache.set(importPath, null);
+                return fullMatch;
+              }
+
+              // Transform based on package type
+              let newImportPath = null;
+              if (isInternalPackage(packageName)) {
+                newImportPath = transformInternalPackageImport(importPath);
+              } else {
+                newImportPath = transformThirdPartyImport(importPath);
+              }
+
+              // Cache the result
+              resolvedImportsCache.set(importPath, newImportPath);
+
+              if (newImportPath) {
+                logger.debug(`Transformed import in ${resourcePath}`);
+                logger.debug(`   ${importPath} => ${newImportPath}\n`);
+                return fullMatch.replace(importPath, newImportPath);
+              }
+
+              return fullMatch;
+            }
+          );
+
+          return { code: transformedCode };
+        }
+      );
+    },
+  };
+}