added env._cd

Author: amir-s

README.md

@@ -176,7 +176,7 @@ You can also read the config file with `dev config read`.
 
 - `shell.function` (default: `dev`): You can rename the [shell module](https://github.com/amir-s/dev/#install) function with `dev config set shell.function whatever`. After restarting your shell, you can use `whatever` instead of `dev`.
 
-### `_cd scripts`
+### `dev.json`'s `scripts._cd`
 
 `dev` can execute a script once you `cd` into your project. You can define a script in your `dev.json` file like this:
 
@@ -190,6 +190,18 @@ You can also read the config file with `dev config read`.
 
 Once you `cd` into the project, `dev` will ask for permission to run the script. If you want to persist the permission for this project, a `.dev.json` file will be created in the project root. This file should not be committed to the repository and is only for local use.
 
+### `dev.json`'s `env._cd`
+
+`dev` can automatically load environmant variables from a file when you `cd` into your project. You can define a file in your `dev.json` file like this:
+
+```json
+{
+  "env": {
+    "_cd": ".env"
+  }
+}
+```
+
 ### `dev update`
 
 Run `dev update` to check for updates. You can select to automatially apply the updates, or run the install script manually.

main.ts

@@ -55,6 +55,7 @@ const shellExec = (cmd: string): unknown => {
 };
 
 const cd = (path: string): unknown => shellExec(`cd:${path}`);
+const loadEnvFile = (path: string): unknown => shellExec(`env:${path}`);
 
 const source = (): unknown => {
   const currentShellType = (
@@ -145,6 +146,7 @@ const execute = async () => {
     writeConfig,
     cd,
     source,
+    loadEnvFile,
   } as ModuleRunOptions);
 };
 

modules/_cd/handleEnvFile.ts

@@ -0,0 +1,82 @@
+import "colors";
+import report from "yurnalist";
+import inquirer from "inquirer";
+
+import type { KV } from "./kv.ts";
+import type { DevJson } from "./index.ts";
+import { fs } from "zx";
+import type { ModuleRunOptions } from "../../utils/types.ts";
+
+const CHOICES = ["no", "yes", "never", "always"] as const;
+
+export const handleEnvFile = async (
+  devJson: DevJson,
+  kv: KV,
+  loadEnvFile: ModuleRunOptions["loadEnvFile"]
+) => {
+  const { env } = devJson;
+
+  if (!env || !env["_cd"]) {
+    return;
+  }
+
+  const envFile = env["_cd"];
+
+  const isAllowed = () => {
+    const all = kv.read<string>("_cd", "auto load env file");
+
+    if (all === "never") {
+      return false;
+    }
+
+    if (all === "always") {
+      return true;
+    }
+
+    return null;
+  };
+
+  const allowed = isAllowed();
+  if (allowed === false) {
+    return false;
+  }
+
+  if (!fs.existsSync(envFile)) {
+    report.error(
+      `ENV file specified in ${"dev.json".green} not found: ${envFile.red}`
+    );
+    return false;
+  }
+
+  if (allowed === true) {
+    loadEnvFile(envFile);
+    return true;
+  }
+
+  report.info(`ENV variables are about to be loaded from ${envFile.green}`);
+
+  const { run } = (await inquirer.prompt([
+    {
+      type: "list",
+      name: "run",
+      message: "Do you accept?",
+      choices: CHOICES,
+    },
+  ])) as { run: (typeof CHOICES)[number] };
+
+  if (run === "no") {
+    return false;
+  }
+
+  if (run === "never") {
+    kv.write("_cd", "auto load env file", "never");
+    return false;
+  }
+
+  if (run === "always") {
+    kv.write("_cd", "auto load env file", "always");
+  }
+
+  loadEnvFile(envFile);
+  return true;
+};

modules/_cd/handleScript.ts

@@ -0,0 +1,99 @@
+import "colors";
+import { $ } from "zx";
+import report from "yurnalist";
+import inquirer from "inquirer";
+
+import type { KV } from "./kv.ts";
+import type { DevJson } from "./index.ts";
+
+const CHOICES = [
+  "no",
+  "yes",
+  "never this command",
+  "always this command",
+  "never for _cd commands for this project",
+  "always for _cd commands for this project",
+] as const;
+
+export const handleScript = async (devJson: DevJson, kv: KV) => {
+  const { scripts } = devJson;
+
+  if (!scripts || !scripts["_cd"]) {
+    return;
+  }
+
+  const script = scripts["_cd"];
+
+  const allowedCommands =
+    kv.read<Record<string, boolean>>("_cd", "allowed") || {};
+  const bannedCommands =
+    kv.read<Record<string, boolean>>("_cd", "banned") || {};
+
+  const isAllowed = (command: string) => {
+    const all = kv.read<string>("_cd", "run all _cd commands for this project");
+
+    if (all === "never") {
+      return false;
+    }
+
+    if (all === "always") {
+      return true;
+    }
+
+    if (bannedCommands[command]) {
+      return false;
+    }
+
+    if (allowedCommands[command]) {
+      return true;
+    }
+
+    return null;
+  };
+
+  const allowed = isAllowed(script);
+  if (allowed === false) {
+    return false;
+  }
+
+  if (allowed === true) {
+    await $`$SHELL -c ${script}`;
+    return true;
+  }
+
+  report.info(`This _cd command is about to run: ${script.green}`);
+
+  const { run } = (await inquirer.prompt([
+    {
+      type: "list",
+      name: "run",
+      message: "Do you want to run the script?",
+      choices: CHOICES,
+    },
+  ])) as { run: (typeof CHOICES)[number] };
+
+  if (run === "no") {
+    return false;
+  }
+
+  if (run === "never this command") {
+    kv.write("_cd", "banned", { ...bannedCommands, [script]: true });
+    return false;
+  }
+
+  if (run === "never for _cd commands for this project") {
+    kv.write("_cd", "run all _cd commands for this project", "never");
+    return false;
+  }
+
+  if (run === "always this command") {
+    kv.write("_cd", "allowed", { ...allowedCommands, [script]: true });
+  }
+
+  if (run === "always for _cd commands for this project") {
+    kv.write("_cd", "run all _cd commands for this project", "always");
+  }
+
+  await $`$SHELL -c ${script}`;
+  return true;
+};

modules/_cd/help.ts

@@ -3,7 +3,7 @@ import type { HelpDocFN } from "../help/help.ts";
 
 export const cmd = "_cd";
 export const description =
-  "This is not a command. It's an internal module that runs the :cd script defined in the dev.json file when you cd into your project.";
+  "This is not a command. It's an internal module that runs the _cd script defined in the dev.json file when you cd into your project.";
 
 export const help: HelpDocFN = () => ({
   description: [description],

modules/_cd/index.ts

@@ -1,110 +1,26 @@
 import "colors";
 import { $ } from "zx";
-import report from "yurnalist";
-import inquirer from "inquirer";
+import process from "process";
 import { kv } from "./kv.ts";
-
-interface Scripts {
-  _cd?: string;
-}
+import { handleScript } from "./handleScript.ts";
+import { handleEnvFile } from "./handleEnvFile.ts";
+import type { ModuleRunOptions } from "../../utils/types.ts";
 
 $.verbose = true;
 
-const CHOICES = [
-  "no",
-  "yes",
-  "never this command",
-  "always this command",
-  "never for _cd commands for this project",
-  "always for _cd commands for this project",
-] as const;
-
-export const run = async () => {
-  const { scripts }: { scripts?: Scripts } = JSON.parse(
-    Deno.readTextFileSync("dev.json")
-  );
-
-  if (!scripts || !scripts["_cd"]) {
-    return;
-  }
-
-  const script = scripts["_cd"];
-
-  const allowedCommands =
-    kv.read<Record<string, boolean>>("_cd", "allowed") || {};
-  const bannedCommands =
-    kv.read<Record<string, boolean>>("_cd", "banned") || {};
-
-  const isAllowed = (command: string) => {
-    const all = kv.read<string>("_cd", "run all _cd commands for this project");
-
-    if (all === "never") {
-      return false;
-    }
-
-    if (all === "always") {
-      return true;
-    }
-
-    if (bannedCommands[command]) {
-      return false;
-    }
-
-    if (allowedCommands[command]) {
-      return true;
-    }
-
-    return null;
+export interface DevJson {
+  scripts?: {
+    _cd?: string;
   };
+  env?: {
+    _cd?: string;
+  };
+}
 
-  const allowed = isAllowed(script);
-
-  if (allowed === false) {
-    Deno.exit(0);
-    return;
-  }
-
-  if (allowed === true) {
-    await $`$SHELL -c ${script}`;
-    Deno.exit(0);
-  }
-
-  report.info(`This _cd command is about to run: ${script.green}`);
-
-  const { run } = (await inquirer.prompt([
-    {
-      type: "list",
-      name: "run",
-      message: "Do you want to run the script?",
-      choices: CHOICES,
-    },
-  ])) as { run: (typeof CHOICES)[number] };
-
-  if (run === "no") {
-    Deno.exit(0);
-    return;
-  }
-
-  if (run === "never this command") {
-    kv.write("_cd", "banned", { ...bannedCommands, [script]: true });
-    Deno.exit(0);
-    return;
-  }
-
-  if (run === "never for _cd commands for this project") {
-    kv.write("_cd", "run all _cd commands for this project", "never");
-    Deno.exit(0);
-    return;
-  }
-
-  if (run === "always this command") {
-    kv.write("_cd", "allowed", { ...allowedCommands, [script]: true });
-  }
-
-  if (run === "always for _cd commands for this project") {
-    kv.write("_cd", "run all _cd commands for this project", "always");
-  }
+export const run = async ({ loadEnvFile }: ModuleRunOptions) => {
+  const devJson = JSON.parse(Deno.readTextFileSync("dev.json")) as DevJson;
+  await handleScript(devJson, kv);
+  await handleEnvFile(devJson, kv, loadEnvFile);
 
-  await $`$SHELL -c ${script}`;
-  Deno.exit(0);
+  process.exit(0);
 };

modules/_cd/kv.ts

@@ -65,3 +65,5 @@ export const kv = {
   read: readKV,
   write: writeKV,
 };
+
+export type KV = typeof kv;

modules/shell/fish.ts

@@ -12,6 +12,8 @@ function <$SHELL_FN_NAME$>
                 cd (string replace -r "cd:" "" -- $cmd)
                 case "source:*"
                 source (string replace -r "source:" "" -- $cmd)
+                case "env:*"
+                set cmd (string replace -r "env:" "" -- $cmd)
                 case "*"
                 # echo do nothing
             end

modules/shell/sh.ts

@@ -12,6 +12,7 @@ export const script = `
     case "\${cmd}" in
       cd:*) cd "\${cmd//cd:/}" ;;
       source:*) source "\${cmd//source:/}" ;;
+      env:*) export $(xargs < "\${cmd//env:/}") ;;
       *) ;;
     esac
   done < "\${tempfile}"

utils/types.ts

@@ -6,4 +6,5 @@ export interface ModuleRunOptions {
   writeConfig: WriteConfigFN;
   cd: (path: string) => unknown;
   source: () => unknown;
+  loadEnvFile: (path: string) => unknown;
 }