@digigov/cli-build 2.0.0-13876dba → 2.0.0-16da9467

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,21 +35,23 @@ 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;
@@ -60,24 +62,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)
     );
   });
 }
@@ -89,8 +91,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}`);
 }
 
@@ -100,21 +102,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 {
@@ -128,13 +130,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'));
   });
 }
 
@@ -150,10 +152,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);
 }

package/eslint.config.js

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

package/generate-registry.js

@@ -1,10 +1,10 @@
-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 { 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";
+import { getProjectTsconfig } from './common.js';
 
 /** @typedef {Object} Project - Represents the project to be built
  * @property {string} root - The project root directory
@@ -23,17 +23,17 @@ import { getProjectTsconfig } from "./common.js";
 export async function generateRegistry(
   project,
   absoluteFilePaths,
-  registryFilename = "registry.js",
+  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",
+      '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 +43,22 @@ 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})`,
+    (file) => `  '${file.path}': lazyImport(${file.uid})`
   );
 
   logger.debug(
-    `Including ${componentsToExport.length} items in ${registryPath}`,
+    `Including ${componentsToExport.length} items in ${registryPath}`
   );
 
   let registryFileContent = `
-${importStatements.join("\n")}
+${importStatements.join('\n')}
 function lazyImport(pkgImport) {
   return new Proxy(
     {},
@@ -78,7 +78,7 @@ function lazyImport(pkgImport) {
   )
 }
 export default {
-${componentsToExport.join(",\n")}
+${componentsToExport.join(',\n')}
 };
 `;
   await fs.writeFile(registryPath, registryFileContent);
@@ -97,7 +97,7 @@ ${componentsToExport.join(",\n")}
 export async function generateLazyRegistry(
   project,
   filePaths,
-  lazyFilename = "lazy.js",
+  lazyFilename = 'lazy.js'
 ) {
   const lazyPath = ensureRegistryPath(project, lazyFilename);
 
@@ -117,7 +117,7 @@ export async function generateLazyRegistry(
 
     for (const exportedComponent of exports) {
       if (
-        exportedComponent !== "default" &&
+        exportedComponent !== 'default' &&
         exportedComponent.match(/^[A-Z]/)
       ) {
         if (
@@ -125,7 +125,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,7 +136,7 @@ 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}`);
@@ -144,9 +144,9 @@ export async function generateLazyRegistry(
   const componentsToExport = 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';
 export default {
@@ -182,7 +182,7 @@ function toNodeResolvablePath(inputPath) {
   const dir = path.dirname(inputPath);
   const base = path.basename(inputPath, path.extname(inputPath));
 
-  return base === "index" ? dir : path.join(dir, base);
+  return base === 'index' ? dir : path.join(dir, base);
 }
 
 /**
@@ -192,7 +192,7 @@ function toNodeResolvablePath(inputPath) {
  * @returns {string} - The UID
  */
 function createUid(inputPath) {
-  return inputPath.replace(/[\/@\-.]/g, "_");
+  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 { generateLazyRegistry, generateRegistry } 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,7 +51,7 @@ 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);
   }
 
@@ -59,44 +59,44 @@ async function main(options, ctx) {
   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...");
+    logger.debug('Generating registry files...');
 
     const filesToIncludeInRegistry = filesToBuild.filter(
-      (file) => !(file.includes("native") || file.endsWith(".d.ts")),
+      (file) => !(file.includes('native') || file.endsWith('.d.ts'))
     );
     let storiesFiles = null;
     if (options.includeStories) {
-      logger.debug("Including stories in the registry...");
+      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"],
-        },
+          ignore: ['**/*.native.*, **/*.d.ts'],
+        }
       );
     }
 
-    const [_, ...registryFilePaths] = await Promise.all([
+    const [, ...registryFilePaths] = await Promise.all([
       storiesFiles
-        ? generateRegistry(project, storiesFiles, "stories-registry.js")
+        ? generateRegistry(project, storiesFiles, 'stories-registry.js')
         : null,
       generateRegistry(project, filesToIncludeInRegistry),
       generateLazyRegistry(project, filesToIncludeInRegistry),
@@ -105,14 +105,14 @@ async function main(options, ctx) {
     buildFormat({
       files: registryFilePaths,
       tsconfig: tsconfig,
-      format: "cjs",
-      outdir: project.distDir + "/cjs",
+      format: 'cjs',
+      outdir: project.distDir + '/cjs',
       noLogs: true,
-    }),
-      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-13876dba",
+  "version": "2.0.0-16da9467",
   "description": "Build plugin for Digigov CLI",
   "main": "./index.js",
   "type": "module",
@@ -8,27 +8,8 @@
   "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",
@@ -36,15 +17,19 @@
     "ts-morph": "25.0.0"
   },
   "devDependencies": {
+    "@digigov/cli": "2.0.0-16da9467",
+    "@digigov/cli-lint": "2.0.0-16da9467",
     "publint": "0.1.8",
     "vitest": "2.1.3",
-    "@digigov/cli-test": "2.0.0-13876dba",
+    "@digigov/cli-test": "2.0.0-16da9467",
     "@types/fs-extra": "11.0.4",
-    "@types/node": "18.19.0",
-    "typescript": "5.6.2"
+    "@types/node": "20.17.24",
+    "typescript": "5.6.2",
+    "eslint": "9.16.0",
+    "prettier": "3.4.2"
   },
   "peerDependencies": {
-    "@digigov/cli": "2.0.0-13876dba",
+    "@digigov/cli": "2.0.0-16da9467",
     "next": "13.1.1"
   },
   "peerDependenciesMeta": {
@@ -53,6 +38,8 @@
     }
   },
   "scripts": {
-    "publint": "publint"
+    "publint": "publint",
+    "lint": "digigov lint",
+    "typecheck": "tsc"
   }
 }

package/tsconfig.json

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