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

package/index.js

@@ -1,107 +1,118 @@
-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");
+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';
 
-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;
+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)
+  .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,jsxts,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) {
+  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');
+    await generateTypeDeclarationFiles(project, tsconfig, ctx);
   }
-  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 });
-          });
-        }
-      }
+  const ignore = [...TEST_GLOBS, ...STORIES_GLOBS];
+  const filesToBuild = await glob(path.join(project.root, SRC_GLOB), {
+    ignore,
+  });
+  logger.debug('Bundling ESM and CJS...');
+  await Promise.all([
+    buildFormat({
+      files: filesToBuild,
+      tsconfig: tsconfig,
+      format: 'cjs',
+      outdir: project.distDir + '/cjs',
+    }),
+    buildFormat({
+      files: filesToBuild,
+      tsconfig,
+      format: 'esm',
+      outdir: project.distDir,
+    }),
+  ]);
+  logger.debug('Bundling done.');
 
-      const files = glob.sync(
-        path.join(project.root, "src", "**/*.{tsx,ts,js,jsx}"),
+  if (options.generateRegistry) {
+    logger.debug('Generating registry files...');
+
+    const filesToIncludeInRegistry = 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: "**/*.{spec,test}.{ts,tsx,js,jsx}",
-        },
+          ignore: ['**/*.native.*, **/*.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";
-      }
-
-      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);
     }
+
+    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',
+      noLogs: true,
+    });
+    logger.log('Generated registry files');
   }
-};
+
+  logger.debug('Copying files to build directory...');
+  copyFiles();
+  logger.debug('Files copied.');
+}

package/package.json

@@ -1,48 +1,45 @@
 {
   "name": "@digigov/cli-build",
-  "version": "2.0.0-daaf7bdf",
+  "version": "2.0.0-e20fed09",
   "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",
+    "rimraf": "3.0.2",
     "esbuild": "0.23.0",
-    "@digigov/babel-ts-to-proptypes": "1.1.0"
+    "commander": "12.1.0",
+    "ts-morph": "25.0.0"
   },
   "devDependencies": {
-    "publint": "0.1.8"
+    "@digigov/cli": "2.0.0-e20fed09",
+    "@digigov/cli-lint": "2.0.0-e20fed09",
+    "publint": "0.1.8",
+    "vitest": "2.1.3",
+    "@digigov/cli-test": "2.0.0-e20fed09",
+    "@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-daaf7bdf",
-    "rimraf": "3.0.2",
+    "@digigov/cli": "2.0.0-e20fed09",
     "next": "13.1.1"
   },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    }
+  },
   "scripts": {
-    "publint": "publint"
+    "publint": "publint",
+    "lint": "digigov lint",
+    "typecheck": "tsc"
   }
 }

package/tsconfig.base.json

@@ -12,9 +12,6 @@
       "@digigov/auth/*": ["./auth/src/*"],
       "@digigov/auth/": ["./auth/src"],
       "@digigov/auth": ["./auth/src"],
-      "@digigov/benchmark/*": ["./benchmark/src/*"],
-      "@digigov/benchmark/": ["./benchmark/src"],
-      "@digigov/benchmark": ["./benchmark/src"],
       "@digigov/text-search/*": ["./text-search/src/*"],
       "@digigov/text-search/": ["./text-search/src"],
       "@digigov/text-search": ["./text-search/src"],
@@ -36,14 +33,15 @@
       "@digigov/react-experimental/*": ["../libs-ui/react-experimental/src/*"],
       "@digigov/react-experimental/": ["../libs-ui/react-experimental/src"],
       "@digigov/react-experimental": ["../libs-ui/react-experimental/src"],
-      "@digigov/storybook/*": ["../examples/storybook/stories/*"]
+      "@digigov/storybook/*": ["../examples/storybook/stories/*"],
+      "@uides/stepwise/*": ["./stepwise/src/*"],
+      "@uides/stepwise/": ["./stepwise/src"],
+      "@uides/stepwise": ["./stepwise/src"]
     }
   },
   "include": [
     "../../libs/auth/src/**/*.tsx",
     "../../libs/auth/src/*.tsx",
-    "../../libs/benchmark/src/**/*.tsx",
-    "../../libs/benchmark/src/*.tsx",
     "../../libs/text-search/src/**/*.tsx",
     "../../libs/text-search/src/*.tsx",
     "../../libs/text-search/src/**/*.ts",

package/tsconfig.json

@@ -1,45 +1,8 @@
 {
-  "extends": "./tsconfig.base.json",
+  "extends": "@digigov/cli/tsconfig.cli",
   "compilerOptions": {
-    "types": [
-      "node"
-    ],
-    "outDir": "dist",
-    "paths": {
-      "@digigov/babel-ts-to-proptypes": [
-        "node_modules/@digigov/babel-ts-to-proptypes/src"
-      ],
-      "@digigov/babel-ts-to-proptypes/": [
-        "node_modules/@digigov/babel-ts-to-proptypes/src/"
-      ],
-      "@digigov/babel-ts-to-proptypes/*": [
-        "node_modules/@digigov/babel-ts-to-proptypes/src/*"
-      ],
-      "@digigov/cli": [
-        "node_modules/@digigov/cli/src"
-      ],
-      "@digigov/cli/": [
-        "node_modules/@digigov/cli/src/"
-      ],
-      "@digigov/cli/*": [
-        "node_modules/@digigov/cli/src/*"
-      ],
-      "@digigov/cli-build": [
-        "./src"
-      ],
-      "@digigov/cli-build/": [
-        "./src/"
-      ],
-      "@digigov/cli-build/*": [
-        "./src/*"
-      ]
-    },
-    "baseUrl": "./"
+    "types": ["vitest/globals"]
   },
-  "include": [
-    "index.js"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
+  "include": ["./*.js", "__tests__"],
+  "exclude": ["eslint.config.js", ".prettierrc.cjs"]
 }

package/babel.common.js

@@ -1,119 +0,0 @@
-// Mostly shared from
-// https://github.com/mui-org/material-ui/blob/master/babel.config.js
-const lib = require("@digigov/cli/lib");
-
-function makeBabelConfig(dir, opts = { docs: false, proptypes: false }) {
-  const project = lib.resolveProject(dir);
-  const aliases = !project.externalLockFile ? lib.aliases(null, true) : {};
-
-  const BABEL_ENV = process.env.BABEL_ENV || "esm";
-  const BABEL_PUBLISH = process.env.BABEL_PUBLISH || false;
-  const NODE_ENV = process.env.NODE_ENV;
-  const IS_COMMONJS = BABEL_ENV === "cjs" || NODE_ENV === "test";
-
-  const PRESETS = [
-    [
-      require.resolve("@babel/preset-env"),
-      {
-        modules: IS_COMMONJS ? "commonjs" : false,
-      },
-    ],
-    require.resolve("@babel/preset-react"),
-  ];
-
-  if (project.isTs) {
-    PRESETS.push(require.resolve("@babel/preset-typescript"));
-  }
-
-  const PLUGINS_COMMON = [
-    require.resolve("babel-plugin-optimize-clsx"),
-    [
-      require.resolve("@babel/plugin-proposal-class-properties"),
-      { loose: true },
-    ],
-    [
-      require.resolve("@babel/plugin-proposal-object-rest-spread"),
-      { loose: true },
-    ],
-    // any package needs to declare 7.4.4 as a runtime dependency. default is ^7.0.0
-    [require.resolve("@babel/plugin-transform-runtime"), { version: "^7.4.4" }],
-    // for IE 11 support
-    require.resolve("@babel/plugin-transform-object-assign"),
-    require.resolve("babel-plugin-transform-react-constant-elements"),
-  ];
-
-  const PLUGINS_PUBLISH = [
-    require.resolve("babel-plugin-transform-dev-warning"),
-    [
-      require.resolve("babel-plugin-react-remove-properties"),
-      { properties: ["data-testid"] },
-    ],
-    [
-      require.resolve("babel-plugin-transform-react-remove-prop-types"),
-      {
-        mode: "unsafe-wrap",
-      },
-    ],
-  ];
-
-  const PLUGINS = PLUGINS_COMMON;
-
-  // Apps images are handled using `next-images` plugin. For libraries there is no
-  // explicit way to provide assets to the App using the library. While not
-  // considered a very good practice, one way to provide images via libraries is
-  // to embed the image data into the library code.
-  if (project.isLib || project.isApp) {
-    PLUGINS.push(require.resolve("babel-plugin-inline-import-data-uri"));
-  }
-
-  if (BABEL_PUBLISH) {
-    PLUGINS.push(...PLUGINS_PUBLISH);
-  }
-
-  if (!opts.docs) {
-    let resolverAlias = {};
-    if (NODE_ENV === "test") resolverAlias = aliases;
-    if (BABEL_ENV === "cjs") {
-      resolverAlias = Object.keys(aliases).reduce((acc, key) => {
-        if (key !== project.name) {
-          acc[`^${key}/(.+)`] = `${key}/cjs/\\1`;
-        }
-        return acc;
-      }, {});
-    }
-
-    const RESOLVER = [
-      require.resolve("babel-plugin-module-resolver"),
-      {
-        alias: resolverAlias,
-        extensions: [".js", ".jsx", ".ts", ".tsx", ".json"],
-        loglevel: "silent",
-      },
-    ];
-    PLUGINS.push(RESOLVER);
-  }
-
-  if (project.isApp) {
-    PRESETS.push(require.resolve("next/babel"));
-  }
-
-  const CONFIG = {
-    presets: PRESETS,
-    plugins: PLUGINS,
-    ignore: [/@babel[\\|/]runtime/],
-    env: {
-      coverage: {
-        plugins: [require.resolve("babel-plugin-istanbul")],
-      },
-      test: {
-        sourceMaps: "both",
-        plugins: [],
-      },
-    },
-  };
-  return CONFIG;
-}
-module.exports = {
-  makeBabelConfig,
-  config: makeBabelConfig(),
-};

package/babel.config.js

@@ -1 +0,0 @@
-module.exports = require('./babel.common').config