Add --publicDir and --projectDir argument to only-include-used-icons and copy-dsfr-to-public scripts, add logging

Author: garronej

.github/workflows/ci.yaml

@@ -115,7 +115,7 @@ jobs:
       with:
         registry-url: https://registry.npmjs.org/
     - uses: bahmutov/npm-install@v1
-    - run: yarn build --npm
+    - run: yarn build --prePublish
     - run: npx -y -p [email protected] enable_short_npm_import_path
       env:
         DRY_RUN: "0"

package.json

@@ -22,7 +22,7 @@
         "format:check": "yarn _format --list-different",
         "storybook": "yarn build && yarn only-include-used-icons && start-storybook -p 6006",
         "build-storybook": "yarn build && yarn only-include-used-icons && build-storybook",
-        "only-include-used-icons": "node dist/bin/only-include-used-icons.js"
+        "only-include-used-icons": "node dist/bin/only-include-used-icons.js --publicDir ./dist"
     },
     "bin": {
         "copy-dsfr-to-public": "dist/bin/copy-dsfr-to-public.js",
@@ -60,7 +60,8 @@
     ],
     "homepage": "https://github.com/codegouvfr/react-dsfr",
     "dependencies": {
-        "tsafe": "^1.6.3"
+        "tsafe": "^1.6.3",
+        "yargs-parser": "^21.1.1"
     },
     "devDependencies": {
         "@babel/core": "^7.20.2",
@@ -98,7 +99,6 @@
         "lint-staged": "^11.0.0",
         "memoizee": "^0.4.15",
         "next": "13.5.1",
-        "oppa": "^0.4.0",
         "parse-numeric-range": "^1.3.0",
         "powerhooks": "^0.22.0",
         "prettier": "^2.3.0",

scripts/build/build.ts

@@ -9,16 +9,13 @@ import {
     pathOfIconsJson
 } from "../../src/bin/only-include-used-icons";
 import * as child_process from "child_process";
-import { oppa } from "oppa";
 import { patchCssForMui } from "./patchCssForMui";
+import yargsParser from "yargs-parser";
 
 (async () => {
-    const { args } = oppa()
-        .add({
-            "name": "npm",
-            "type": "boolean"
-        })
-        .parse();
+    const argv = yargsParser(process.argv.slice(2));
+
+    const isPrePublish = argv["prePublish"] === true;
 
     const projectRootDirPath = getProjectRoot();
 
@@ -122,7 +119,12 @@ import { patchCssForMui } from "./patchCssForMui";
     }
 
     //NOTE: From here it's only for local linking, required for storybook and running integration apps.
-    if (!args.npm) {
+
+    local_testing: {
+        if (isPrePublish) {
+            break local_testing;
+        }
+
         fs.writeFileSync(
             pathJoin(distDirPath, "package.json"),
             Buffer.from(
@@ -149,6 +151,7 @@ import { patchCssForMui } from "./patchCssForMui";
         );
 
         fs.cpSync(dsfrDirPath, pathJoin(distDirPath, "dsfr"), { "recursive": true });
+        fs.rmSync(dsfrDirPath, { "recursive": true });
         fs.cpSync(pathJoin(projectRootDirPath, "src"), pathJoin(distDirPath, "src"), {
             "recursive": true
         });

src/bin/copy-dsfr-to-public.ts

@@ -1,5 +1,15 @@
 #!/usr/bin/env node
-/* eslint-disable @typescript-eslint/no-unused-vars */
+
+/**
+ * This script is ran with `npx copy-dsfr-to-public`
+ * It takes two optional arguments:
+ * - `--projectDir <path>` to specify the project directory. Default to the current working directory.
+ *   This can be used in monorepos to specify the react project directory.
+ * - `--publicDir <path>` to specify the public directory.
+ *   In Vite projects we will read the vite.config.ts (or .js) file to find the public directory.
+ *   In other projects we will assume it's <project root>/public.
+ *   This path is expressed relative to the project directory.
+ */
 
 import {
     join as pathJoin,
@@ -9,101 +19,55 @@ import {
 } from "path";
 import * as fs from "fs";
 import { getProjectRoot } from "./tools/getProjectRoot";
-import { assert } from "tsafe/assert";
-import type { Equals } from "tsafe";
+import yargsParser from "yargs-parser";
+import { getAbsoluteAndInOsFormatPath } from "./tools/getAbsoluteAndInOsFormatPath";
+import { readPublicDirPath } from "./readPublicDirPath";
 
 (async () => {
-    const projectDirPath = process.cwd();
+    const argv = yargsParser(process.argv.slice(2));
 
-    const viteConfigFilePath = (() => {
-        for (const ext of [".js", ".ts"]) {
-            const candidateFilePath = pathJoin(projectDirPath, `vite.config${ext}`);
+    const projectDirPath: string = (() => {
+        read_from_argv: {
+            const arg = argv["projectDir"];
 
-            if (!fs.existsSync(candidateFilePath)) {
-                continue;
+            if (arg === undefined) {
+                break read_from_argv;
             }
 
-            return candidateFilePath;
+            return getAbsoluteAndInOsFormatPath({ "pathIsh": arg, "cwd": process.cwd() });
         }
 
-        return undefined;
+        return process.cwd();
     })();
 
     const publicDirPath = await (async () => {
-        command_line_argument: {
-            const arg = process.argv[2];
+        read_from_argv: {
+            const arg = argv["publicDir"];
 
             if (arg === undefined) {
-                break command_line_argument;
+                break read_from_argv;
             }
 
-            return arg;
-        }
+            const publicDirPath = getAbsoluteAndInOsFormatPath({
+                "pathIsh": arg,
+                "cwd": projectDirPath
+            });
 
-        read_from_vite_config: {
-            if (viteConfigFilePath === undefined) {
-                break read_from_vite_config;
+            if (!fs.existsSync(publicDirPath)) {
+                fs.mkdirSync(publicDirPath, { "recursive": true });
             }
 
-            const viteConfig = fs.readFileSync(viteConfigFilePath).toString("utf8");
-
-            if (!viteConfig.includes("publicDir")) {
-                return pathJoin(projectDirPath, "public");
-            }
-
-            const [, afterPublicDir] = viteConfig.split(/\s["']?publicDir["']?\s*:/);
-
-            for (let indexEnd = 0; indexEnd < afterPublicDir.length; indexEnd++) {
-                const {
-                    default: path,
-                    basename,
-                    dirname,
-                    delimiter,
-                    extname,
-                    format,
-                    isAbsolute,
-                    join,
-                    normalize,
-                    parse,
-                    posix,
-                    relative,
-                    resolve,
-                    sep,
-                    toNamespacedPath,
-                    win32,
-                    ...rest
-                } = await import("path");
-                assert<Equals<keyof typeof rest, never>>();
-
-                const part = afterPublicDir
-                    .substring(0, indexEnd)
-                    .replace(/__dirname/g, `"${projectDirPath}"`);
-
-                let candidate: string;
-
-                try {
-                    candidate = eval(part);
-                } catch {
-                    continue;
-                }
-
-                if (typeof candidate !== "string") {
-                    continue;
-                }
-
-                return candidate;
-            }
-
-            console.error(
-                `Can't parse the vite configuration please open an issue about it ${getRepoIssueUrl()}`
-            );
-
-            process.exit(-1);
+            return publicDirPath;
         }
 
-        return pathJoin(projectDirPath, "public");
+        return await readPublicDirPath({ projectDirPath });
     })();
 
+    if (!fs.existsSync(publicDirPath)) {
+        console.error(`Can't locate your public directory, use the --public option to specify it.`);
+        process.exit(-1);
+    }
+
     edit_gitignore: {
         const gitignoreFilePath = pathJoin(projectDirPath, ".gitignore");
 
@@ -128,22 +92,6 @@ import type { Equals } from "tsafe";
         );
     }
 
-    if (!fs.existsSync(publicDirPath)) {
-        if (viteConfigFilePath === undefined) {
-            console.error(
-                [
-                    "There is no public/ directory in the current working directory, we don't know your framework",
-                    "you are not calling this script at the right location or we don't know your React framework",
-                    `please submit an issue about it here ${getRepoIssueUrl()}`
-                ].join(" ")
-            );
-
-            process.exit(-1);
-        }
-
-        fs.mkdirSync(publicDirPath, { "recursive": true });
-    }
-
     const dsfrDirPath = pathJoin(publicDirPath, "dsfr");
 
     if (fs.existsSync(dsfrDirPath)) {