feat: support deno.json config file

jurassiscripts · Dec 27, 2021 · a4e1101 · a4e1101
1 parent 971b7db
commit a4e1101
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 0 deletions.
diff --git a/cli_test.ts b/cli_test.ts
@@ -1,6 +1,7 @@
 import { assertEquals, assertMatch, assertStringIncludes } from "./dev_deps.ts";
 const yamlWd = "./test/yaml";
 const tsWd = "./test/ts";
+const jsonWd = "./test/json";
 const cliArgs = [
   "deno",
   "run",
@@ -46,6 +47,11 @@ Deno.test("ts config file", async () => {
   assertStringIncludes(output, expectedOutput);
 });
 
+Deno.test("deno.json(c) config file", async () => {
+  const output = await runScript("test", jsonWd);
+  assertStringIncludes(output, expectedOutput);
+});
+
 Deno.test("deno run", async () => {
   const output = await runScript("denorun");
   assertStringIncludes(output, expectedOutput);
@@ -91,6 +97,11 @@ Deno.test("--help", async () => {
   assertStringIncludes(output, "--version");
 });
 
+Deno.test("--config", async () => {
+  const output = await runScript("config", yamlWd);
+  assertMatch(output, /^\s*$/);
+});
+
 Deno.test("forward arguments", async () => {
   const output = await runScript("forward", yamlWd, ["--shuffle=1234"]);
   assertStringIncludes(

diff --git a/src/build_command_string.ts b/src/build_command_string.ts
@@ -6,6 +6,7 @@ enum DenoOptions {
   allow = "allow",
   cachedOnly = "cachedOnly",
   cert = "cert",
+  config = "config",
   imap = "imap",
   inspect = "inspect",
   inspectBrk = "inspectBrk",
@@ -25,6 +26,7 @@ enum DenoOptions {
 const denoCmdOptions: { [key: string]: DenoOptions[] } = {
   bundle: [
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.lock,
     DenoOptions.log,
@@ -39,6 +41,7 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
     DenoOptions.allow,
     DenoOptions.cachedOnly,
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.inspect,
     DenoOptions.inspectBrk,
@@ -56,6 +59,7 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
     DenoOptions.allow,
     DenoOptions.cachedOnly,
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.inspect,
     DenoOptions.inspectBrk,
@@ -74,6 +78,7 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
     DenoOptions.allow,
     DenoOptions.cachedOnly,
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.inspect,
     DenoOptions.inspectBrk,
@@ -90,6 +95,7 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
   ],
   cache: [
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.lock,
     DenoOptions.log,
@@ -110,6 +116,7 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
   eval: [
     DenoOptions.cachedOnly,
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.inspect,
     DenoOptions.inspectBrk,
@@ -126,6 +133,7 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
   repl: [
     DenoOptions.cachedOnly,
     DenoOptions.cert,
+    DenoOptions.config,
     DenoOptions.imap,
     DenoOptions.inspect,
     DenoOptions.inspectBrk,
@@ -140,11 +148,13 @@ const denoCmdOptions: { [key: string]: DenoOptions[] } = {
     DenoOptions.v8Flags,
   ],
   fmt: [
+    DenoOptions.config,
     DenoOptions.log,
     DenoOptions.quiet,
     DenoOptions.unstable,
   ],
   lint: [
+    DenoOptions.config,
     DenoOptions.log,
     DenoOptions.quiet,
     DenoOptions.unstable,

diff --git a/src/load_config.ts b/src/load_config.ts
@@ -3,6 +3,7 @@ import { ScriptsConfiguration } from "./scripts_config.ts";
 
 const CONFIG_FILE_NAMES = ["scripts", "velociraptor"];
 const CONFIG_FILE_EXTENSIONS = ["yaml", "yml", "json", "ts"];
+const CONFIG_DENO_FILE_NAMES = ["deno.json", "deno.jsonc"];
 
 export interface ConfigData {
   cwd: string;
@@ -23,6 +24,15 @@ export async function loadConfig(): Promise<ConfigData | null> {
         }
       }
     }
+    for (const file of CONFIG_DENO_FILE_NAMES) {
+      const p = path.join(dir, file);
+      if (existsSync(p)) {
+        return {
+          cwd: dir,
+          config: await parseDenoConfig(p),
+        };
+      }
+    }
     dir = parent(dir);
   }
   return null;
@@ -44,3 +54,18 @@ async function parseConfig(
     Deno.readTextFileSync(configPath),
   ) as ScriptsConfiguration;
 }
+
+async function parseDenoConfig(
+  configPath: string,
+): Promise<ScriptsConfiguration> {
+  let content = Deno.readTextFileSync(configPath);
+  // Strips comments for .jsonc (credits to @tarkh)
+  if (/\.jsonc$/.test(configPath)) {
+    content = content.replace(
+      /\\"|"(?:\\"|[^"])*"|(\/\/.*|\/\*[\s\S]*?\*\/)/g,
+      (m, g) => g ? "" : m,
+    );
+  }
+  const { velociraptor: config = {} } = JSON.parse(content);
+  return config as ScriptsConfiguration;
+}
diff --git a/src/scripts_config.ts b/src/scripts_config.ts
@@ -115,6 +115,12 @@ export interface DenoCliOptions {
    */
   cert?: string;
 
+  /**
+   * The path to a deno configuration file,
+   * passed to deno cli's `--config` option.
+   */
+  config?: string;
+
   /**
    * The path to an importmap json file,
    * passed to deno cli's `--importmap` option.

diff --git a/test/json/deno.jsonc b/test/json/deno.jsonc
@@ -0,0 +1,16 @@
+{
+    // Used to test that --config option is working properly
+    "lint": {
+        "rules": {
+          "exclude": ["no-explicit-any"]
+        }
+    },
+    /*
+     * Section below contains Velociraptor configuration
+     */
+    "velociraptor": {
+        "scripts": {
+            "test": "echo '/* Works! */'"
+        }
+    }
+}
diff --git a/test/yaml/scripts.yml b/test/yaml/scripts.yml
@@ -28,3 +28,6 @@ scripts:
     imap: importmap.json
   forward:
     cmd: echo deno test --lock=lock.json --cached-only
+  config:
+    cmd: deno lint test_config.ts
+    config: ../json/deno.jsonc
diff --git a/test/yaml/test_config.ts b/test/yaml/test_config.ts
@@ -0,0 +1,4 @@
+//Linting this file should normally throw a no-explicit-any
+//but this rule is disabled by deno.jsonc and should work
+//if --config is correctly specified
+type ExplicitAny = any;