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

package/babel.common.cjs

@@ -0,0 +1,119 @@
+// 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(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.cjs

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

package/build.js

@@ -1,9 +1,9 @@
-import { logger } from '@digigov/cli/lib';
+import { DigigovCommand, logger } from "@digigov/cli/lib";
 
-import assert from 'assert';
-import path from 'path';
-import fs from 'fs-extra';
-import baseEsbuild from 'esbuild';
+import assert from "assert";
+import path from "path";
+import fs from "fs-extra";
+import baseEsbuild from "esbuild";
 
 /**
  * Generate TypeScript declaration files
@@ -13,24 +13,24 @@ import baseEsbuild from 'esbuild';
  * @param {string} project.src - The project source directory
  * @param {string} project.distDir - The project build directory
  * @param {string} tsconfig - The tsconfig path
- * @param {import("@digigov/cli/lib").DigigovCommand} ctx - The command context
+ * @param {DigigovCommand} ctx - The command context
  */
 export async function generateTypeDeclarationFiles(project, tsconfig, ctx) {
-  logger.debug('Building types...');
+  logger.debug("Building types...");
 
   const distDir = path.resolve(project.root, project.distDir);
   const projectBasename = path.basename(project.root);
 
-  await ctx.exec('tsc', [
-    '--emitDeclarationOnly',
-    '--outDir',
-    'dist',
-    '--project',
+  await ctx.exec("tsc", [
+    "--emitDeclarationOnly",
+    "--outDir",
+    "dist",
+    "--project",
     tsconfig,
   ]);
 
   const projectBasePath = path.join(distDir, projectBasename);
-  logger.debug('Project base path', projectBasePath);
+  logger.debug("Project base path", projectBasePath);
   if (await fs.exists(projectBasePath)) {
     const typesIncluded = await fs.readdir(path.join(distDir));
     const srcPath = path.join(distDir, projectBasename, project.src);
@@ -39,19 +39,19 @@ export async function generateTypeDeclarationFiles(project, tsconfig, ctx) {
     await Promise.all([
       // Move src files to dist
       ...paths.map((p) => {
-        logger.debug('Moving types file', p);
+        logger.debug("Moving types file", p);
         fs.move(path.join(srcPath, p), path.join(distDir, p));
       }),
       // Remove dirs
       ...typesIncluded.map((typesDir) => {
-        logger.debug('Removing types directory', typesDir);
+        logger.debug("Removing types directory", typesDir);
         fs.rm(path.join(distDir, typesDir), { recursive: true });
       }),
     ]).catch((err) => {
-      logger.error('Error while building types', err);
+      logger.error("Error while building types", err);
     });
   }
-  logger.debug('Types built.');
+  logger.debug("Types built.");
 }
 
 /**
@@ -62,19 +62,11 @@ 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,
-  noLogs,
-}) {
-  assert(format === 'esm' || format === 'cjs', 'Invalid format');
+export function buildFormat({ files: entryPoints, tsconfig, format, outdir }) {
+  assert(format === "esm" || format === "cjs", "Invalid format");
 
-  if (!noLogs)
-    logger.log(`Running: esbuild for ${format.toUpperCase()} format`);
+  logger.log(`Running: esbuild for ${format.toUpperCase()} format`);
   return baseEsbuild.build({
     ...BASE_OPTIONS,
     entryPoints,
@@ -86,8 +78,8 @@ export function buildFormat({
 
 /** @type {baseEsbuild.BuildOptions} */
 export const BASE_OPTIONS = {
-  logLevel: 'error',
-  platform: 'node',
+  logLevel: "error",
+  platform: "node",
   sourcemap: true,
-  target: ['esnext'],
+  target: ["esnext"],
 };

package/common.js

@@ -1,7 +1,7 @@
-import fs from 'fs-extra';
-import path from 'path';
+import fs from "fs-extra";
+import path from "path";
 
-const POSSIBLE_TS_CONFIGS = ['tsconfig.production.json', 'tsconfig.json'];
+const POSSIBLE_TS_CONFIGS = ["tsconfig.production.json", "tsconfig.json"];
 
 /**
  * Get the tsconfig path for the given project

package/copy-files.js

@@ -1,7 +1,7 @@
-import { logger, resolveProject } from '@digigov/cli/lib';
-import fs from 'fs-extra';
-import path from 'path';
-import glob from 'globby';
+import { logger, resolveProject } from "@digigov/cli/lib";
+import fs from "fs-extra";
+import path from "path";
+import glob from "globby";
 
 const packagePath = process.cwd();
 const project = resolveProject();
@@ -20,14 +20,14 @@ function includeFileInBuild(file) {
 }
 
 function copyRegistryFilesToSrc() {
-  const registryPath = path.resolve(buildPath, 'registry/index.js');
-  const lazyPath = path.resolve(buildPath, 'lazy/index.js');
+  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');
+  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'));
+  fs.copySync(registryPath, path.resolve(srcPath, "registry.js"));
+  fs.copySync(lazyPath, path.resolve(srcPath, "lazy.js"));
 }
 
 /**
@@ -35,23 +35,21 @@ function copyRegistryFilesToSrc() {
  */
 function createRootPackageFile() {
   const packageData = fs.readFileSync(
-    path.resolve(packagePath, './package.json'),
-    'utf8'
+    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");
 
-  fs.writeFileSync(targetPath, JSON.stringify(newPackageData, null, 2), 'utf8');
+  fs.writeFileSync(targetPath, JSON.stringify(newPackageData, null, 2), "utf8");
   logger.debug(`Created package.json in build directory`);
 
   return newPackageData;
@@ -62,24 +60,24 @@ function createRootPackageFile() {
  *
  */
 function createNestedPackageFiles() {
-  const indexPaths = glob.sync(path.join(buildPath, '**/index.js'), {
-    ignore: [path.join(buildPath, 'cjs/**')],
+  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),
     );
   });
 }
@@ -91,8 +89,8 @@ function createNestedPackageFiles() {
  * @param {string} string - The string to prepend
  */
 function prepend(file, string) {
-  const data = fs.readFileSync(file, 'utf8');
-  fs.writeFileSync(file, string + data, 'utf8');
+  const data = fs.readFileSync(file, "utf8");
+  fs.writeFileSync(file, string + data, "utf8");
   logger.debug(`Prepended license to ${file}`);
 }
 
@@ -102,21 +100,21 @@ function prepend(file, string) {
  * @param {object} packageData - The package data
  */
 function addLicense(packageData) {
-  const license = `/** @license Digigov v${packageData['version']}
+  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.
  */
 `;
-  ['./index.js', './index.mjs'].map(async (file) => {
+  ["./index.js", "./index.mjs"].map(async (file) => {
     try {
       prepend(path.resolve(buildPath, file), license);
     } catch (err) {
       if (
-        typeof err === 'object' &&
+        typeof err === "object" &&
         err &&
-        'code' in err &&
-        err.code === 'ENOENT'
+        "code" in err &&
+        err.code === "ENOENT"
       ) {
         logger.debug(`Skipped license for ${file}`);
       } else {
@@ -130,13 +128,13 @@ function addLicense(packageData) {
  * Create separate index modules for each directory
  */
 function createSeparateIndexModules() {
-  const files = glob.sync(path.join(buildPath, '**/*.js'), {
-    ignore: [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"));
   });
 }
 
@@ -152,10 +150,10 @@ export default function run() {
   [
     // 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);
+    "./src",
+    "./README.md",
+    "./CHANGELOG.md",
+    "../../LICENSE",
+  ].map((file) => includeFileInBuild(file)),
+    addLicense(packageData);
 }