Merge pull request #151 from tommy351/import-option-2

Add `import` option
tommy351 · Nov 1, 2024 · 044798d · 044798d
2 parents e644798 + 096411e
commit 044798d
Show file tree

Hide file tree

Showing 13 changed files with 111 additions and 26 deletions.
diff --git a/.changeset/honest-trains-travel.md b/.changeset/honest-trains-travel.md
@@ -0,0 +1,5 @@
+---
+"@kosko/cli": minor
+---
+
+Add `--import` option to `generate` and `validate` command.
diff --git a/.changeset/tasty-eggs-melt.md b/.changeset/tasty-eggs-melt.md
@@ -0,0 +1,5 @@
+---
+"@kosko/config": minor
+---
+
+Add `import` option.
diff --git a/packages/cli/integration/generate-cjs/__tests__/__snapshots__/index.ts.snap b/packages/cli/integration/generate-cjs/__tests__/__snapshots__/index.ts.snap
@@ -75,10 +75,12 @@ Options:
       --bail      Stop immediately when an error occurred.             [boolean]
   -s, --set       Set values on the command line KEY=VAL (can be used multiple
                   times)                                   [array] [default: []]
-  -r, --require   Require modules. Modules set in config file will also be
-                  required.                                              [array]
+  -r, --require   Require CommonJS modules. Modules set in config file will also
+                  be required.                                           [array]
       --loader    Module loader. Loaders set in config file will also be loaded.
                                                                          [array]
+      --import    Preload ES modules at startup. Modules set in config file are
+                  also imported.                                         [array]
   -o, --output    Output format
                             [string] [choices: "yaml", "json"] [default: "yaml"]
       --validate  Validate components                  [boolean] [default: true]
@@ -240,10 +242,12 @@ Options:
       --bail      Stop immediately when an error occurred.             [boolean]
   -s, --set       Set values on the command line KEY=VAL (can be used multiple
                   times)                                   [array] [default: []]
-  -r, --require   Require modules. Modules set in config file will also be
-                  required.                                              [array]
+  -r, --require   Require CommonJS modules. Modules set in config file will also
+                  be required.                                           [array]
       --loader    Module loader. Loaders set in config file will also be loaded.
                                                                          [array]
+      --import    Preload ES modules at startup. Modules set in config file are
+                  also imported.                                         [array]
   -o, --output    Output format
                             [string] [choices: "yaml", "json"] [default: "yaml"]
       --validate  Validate components                  [boolean] [default: true]
@@ -327,10 +331,12 @@ Options:
       --bail      Stop immediately when an error occurred.             [boolean]
   -s, --set       Set values on the command line KEY=VAL (can be used multiple
                   times)                                   [array] [default: []]
-  -r, --require   Require modules. Modules set in config file will also be
-                  required.                                              [array]
+  -r, --require   Require CommonJS modules. Modules set in config file will also
+                  be required.                                           [array]
       --loader    Module loader. Loaders set in config file will also be loaded.
                                                                          [array]
+      --import    Preload ES modules at startup. Modules set in config file are
+                  also imported.                                         [array]
   -o, --output    Output format
                             [string] [choices: "yaml", "json"] [default: "yaml"]
       --validate  Validate components                  [boolean] [default: true]

diff --git a/packages/cli/integration/generate-ts-mjs/__tests__/__snapshots__/index.ts.snap b/packages/cli/integration/generate-ts-mjs/__tests__/__snapshots__/index.ts.snap
@@ -1,5 +1,19 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`should load ES modules specified in args 1`] = `
+"apiVersion: v1
+kind: Pod
+metadata:
+  name: test-pod"
+`;
+
+exports[`should load ES modules specified in config 1`] = `
+"apiVersion: v1
+kind: Pod
+metadata:
+  name: test-pod"
+`;
+
 exports[`should load loaders specified in args 1`] = `
 "apiVersion: v1
 kind: Pod

diff --git a/packages/cli/integration/generate-ts-mjs/__tests__/index.ts b/packages/cli/integration/generate-ts-mjs/__tests__/index.ts
@@ -19,3 +19,23 @@ test("should load loaders specified in config", async () => {
   );
   expect(result.stdout).toMatchSnapshot();
 });
+
+test("should load ES modules specified in args", async () => {
+  const result = await runNodeCLI(
+    [
+      "generate",
+      "--import",
+      `data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from "node:url"; register("ts-node/esm", pathToFileURL("./"));`
+    ],
+    { cwd: testDir }
+  );
+  expect(result.stdout).toMatchSnapshot();
+});
+
+test("should load ES modules specified in config", async () => {
+  const result = await runNodeCLI(
+    ["generate", "--config", "kosko-import.toml"],
+    { cwd: testDir }
+  );
+  expect(result.stdout).toMatchSnapshot();
+});
diff --git a/packages/cli/integration/generate-ts-mjs/kosko-import.toml b/packages/cli/integration/generate-ts-mjs/kosko-import.toml
@@ -0,0 +1,3 @@
+components = ["*"]
+loaders = ['data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from "node:url"; register("ts-node/esm", pathToFileURL("./"));']
+extensions = ["ts"]
diff --git a/packages/cli/src/commands/generate/command.ts b/packages/cli/src/commands/generate/command.ts
@@ -48,14 +48,20 @@ export function generateBuilder(
         type: "string",
         array: true,
         describe:
-          "Require modules. Modules set in config file will also be required.",
+          "Require CommonJS modules. Modules set in config file will also be required.",
         alias: "r"
       })
       .option("loader", {
         type: "string",
         array: true,
         describe:
           "Module loader. Loaders set in config file will also be loaded."
+      })
+      .option("import", {
+        type: "string",
+        array: true,
+        describe:
+          "Preload ES modules at startup. Modules set in config file are also imported."
       });
   }
 

diff --git a/packages/cli/src/commands/generate/config.ts b/packages/cli/src/commands/generate/config.ts
@@ -14,13 +14,16 @@ export async function loadConfig(args: BaseGenerateArguments) {
   const envs = [base.baseEnvironment, args.env].filter(
     (env): env is string => typeof env === "string"
   );
-  const { components, require, loaders, plugins } = getConfig(base, envs);
+  const envConfig = getConfig(base, envs);
   const config = {
     ...base,
-    plugins,
-    components: args.components?.length ? args.components : components,
-    require: [...require, ...(args.require || [])],
-    loaders: [...loaders, ...(args.loader || [])],
+    plugins: envConfig.plugins,
+    components: args.components?.length
+      ? args.components
+      : envConfig.components,
+    require: [...envConfig.require, ...(args.require || [])],
+    loaders: [...envConfig.loaders, ...(args.loader || [])],
+    import: [...envConfig.import, ...(args.import || [])],
     bail: args.bail ?? base.bail
   };
 

diff --git a/packages/cli/src/commands/generate/types.ts b/packages/cli/src/commands/generate/types.ts
@@ -9,6 +9,7 @@ export interface BaseGenerateArguments extends GlobalArguments {
   validate?: boolean;
   set?: SetOption[];
   loader?: string[];
+  import?: string[];
   config?: string;
   bail?: boolean;
 }

diff --git a/packages/cli/src/commands/generate/worker.ts b/packages/cli/src/commands/generate/worker.ts
@@ -23,7 +23,11 @@ export interface WorkerOptions {
 export async function handler(options: WorkerOptions) {
   const { printFormat, args, config, ignoreLoaders } = options;
 
-  if (BUILD_TARGET === "node" && !ignoreLoaders && config.loaders.length) {
+  if (
+    BUILD_TARGET === "node" &&
+    !ignoreLoaders &&
+    (config.loaders.length || config.import.length)
+  ) {
     await runWithLoaders(options);
     return;
   }
@@ -90,6 +94,8 @@ async function runWithLoaders(options: WorkerOptions) {
         ...execArgv,
         // ESM loaders
         ...options.config.loaders.flatMap((loader) => ["--loader", loader]),
+        // ESM import
+        ...options.config.import.flatMap((imp) => ["--import", imp]),
         // Entry file
         join(fileURLToPath(import.meta.url), "../worker-bin." + TARGET_SUFFIX)
       ],

diff --git a/packages/config/src/__tests__/config.ts b/packages/config/src/__tests__/config.ts
@@ -52,7 +52,8 @@ describe("getConfig", () => {
       components: [],
       require: [],
       loaders: [],
-      plugins: []
+      plugins: [],
+      import: []
     });
   });
 
@@ -61,7 +62,8 @@ describe("getConfig", () => {
       components: ["foo"],
       require: ["bar"],
       loaders: ["baz"],
-      plugins: [{ name: "a" }]
+      plugins: [{ name: "a" }],
+      import: ["qux"]
     };
 
     expect(getConfig(input, "dev")).toEqual(input);
@@ -72,7 +74,8 @@ describe("getConfig", () => {
       components: ["foo"],
       require: ["bar"],
       loaders: ["baz"],
-      plugins: [{ name: "a" }]
+      plugins: [{ name: "a" }],
+      import: ["qux"]
     };
     const input = {
       ...globalConf,
@@ -81,7 +84,8 @@ describe("getConfig", () => {
           components: ["aaa"],
           require: ["bbb"],
           loaders: ["ccc"],
-          plugins: [{ name: "b" }]
+          plugins: [{ name: "b" }],
+          import: ["ddd"]
         }
       }
     };
@@ -95,12 +99,14 @@ describe("getConfig", () => {
       require: ["bar"],
       loaders: ["baz"],
       plugins: [{ name: "a" }],
+      import: ["qux"],
       environments: {
         dev: {
           components: ["aaa"],
           require: ["bbb"],
           loaders: ["ccc"],
-          plugins: [{ name: "b" }]
+          plugins: [{ name: "b" }],
+          import: ["ddd"]
         }
       }
     };
@@ -109,7 +115,8 @@ describe("getConfig", () => {
       components: ["foo", "aaa"],
       require: ["bar", "bbb"],
       loaders: ["baz", "ccc"],
-      plugins: [{ name: "a" }, { name: "b" }]
+      plugins: [{ name: "a" }, { name: "b" }],
+      import: ["qux", "ddd"]
     });
   });
 
@@ -119,18 +126,21 @@ describe("getConfig", () => {
       require: ["bar"],
       loaders: ["baz"],
       plugins: [{ name: "a" }],
+      import: ["qux"],
       environments: {
         a: {
           components: ["aa"],
           require: ["ab"],
           loaders: ["ac"],
-          plugins: [{ name: "ad" }]
+          plugins: [{ name: "ad" }],
+          import: ["ae"]
         },
         c: {
           components: ["ca"],
           require: ["cb"],
           loaders: ["cc"],
-          plugins: [{ name: "cd" }]
+          plugins: [{ name: "cd" }],
+          import: ["ce"]
         }
       }
     };
@@ -139,7 +149,8 @@ describe("getConfig", () => {
       components: ["foo", "aa", "ca"],
       require: ["bar", "ab", "cb"],
       loaders: ["baz", "ac", "cc"],
-      plugins: [{ name: "a" }, { name: "ad" }, { name: "cd" }]
+      plugins: [{ name: "a" }, { name: "ad" }, { name: "cd" }],
+      import: ["qux", "ae", "ce"]
     });
   });
 
@@ -153,7 +164,8 @@ describe("getConfig", () => {
       components: ["foo"],
       loaders: [],
       require: [],
-      plugins: [{ name: "a", config: { foo: "bar" } }]
+      plugins: [{ name: "a", config: { foo: "bar" } }],
+      import: []
     });
   });
 
@@ -173,7 +185,8 @@ describe("getConfig", () => {
       plugins: [
         { name: "a", config: { a: 1 } },
         { name: "a", config: { a: 2 } }
-      ]
+      ],
+      import: []
     });
   });
 });
diff --git a/packages/config/src/config.ts b/packages/config/src/config.ts
@@ -68,6 +68,7 @@ export function getConfig(
       ...envConfigs.map((e) => e.components)
     ),
     loaders: flatten(config.loaders, ...envConfigs.map((e) => e.loaders)),
-    plugins: flatten(config.plugins, ...envConfigs.map((e) => e.plugins))
+    plugins: flatten(config.plugins, ...envConfigs.map((e) => e.plugins)),
+    import: flatten(config.import, ...envConfigs.map((e) => e.import))
   };
 }
diff --git a/packages/config/src/types.ts b/packages/config/src/types.ts
@@ -36,13 +36,15 @@ export interface EnvironmentConfig {
   components?: string[];
   loaders?: string[];
   plugins?: PluginConfig[];
+  import?: string[];
 }
 
 export const environmentConfigSchema = object({
   require: optional(array(string())),
   components: optional(array(string())),
   loaders: optional(array(string())),
-  plugins: optional(array(pluginConfigSchema))
+  plugins: optional(array(pluginConfigSchema)),
+  import: optional(array(string()))
 });
 
 /**