The pursuit of ’app’yness

Author: mxcl

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
 
 jobs:
-  test:
+  test-action:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -15,8 +15,22 @@ jobs:
     container: ${{ matrix.container }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          path: clone
       - run: echo '{}' > deno.json
-      - uses: ./
+      - run: "! deno"
+      - uses: ./clone
       - run: echo $PATH
       - run: env
       - run: deno --version
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denolib/setup-deno@v2
+        with:
+          deno-version: v2.x
+      - run: deno fmt --check .
+      - run: deno lint .
+      - run: deno check ./app.ts

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "deno.enable": true
+}

README.md

@@ -0,0 +1,94 @@
+# `dev`
+
+`dev` uses `pkgx` and shellcode to automatically, install and activate the
+packages you need for different projects as you navigate in your shell.
+
+## Installation
+
+```sh
+echo 'eval "$(pkgx dev --shellcode)"' >> ~/.zshrc
+```
+
+> [!NOTE]
+> `pkgx` is a required dependency.
+>
+> ```sh
+> brew install pkgxdev/made/pkgx || sh <(curl https://pkgx.sh)
+> ```
+
+> [!TIP]
+> If you like, preview the shellcode: `pkgx dev --shellcode`.
+
+## Usage
+
+```sh
+$ cd my-project
+my-project $ ls
+package.json
+my-project $ dev
++nodejs.org
+my-project $ node --version
+v22.12.0
+$ which node
+~/.pkgx/nodejs.org/v22.12.0/bin/node
+$ cd ..
+-nodejs.org
+$ node
+command not found: node
+```
+
+## How Packages are Determined
+
+- We look at the files you have and figure out the packages you need.
+- Where possible we also determine the versions you need if such things can be
+  determined by looking at configuration files.
+
+## Specifying Versions
+
+We allow you to add YAML front matter to all files to specify versions more
+precisely:
+
+```toml
+# pkgx:
+#   openssl.org: 1.1.1n
+
+[package]
+name = "my cargo project"
+# snip…
+```
+
+We allow more terse expressions including eg:
+
+```toml
+# pkgx: [email protected] deno^2 npm
+```
+
+The major exception being json since it doesn’t support comments, in this case
+we read a special `pkgx` node:
+
+```json
+{
+  "pkgx": {
+    "openssl.org": "1.1.1n",
+    "deno": "^2",
+    "npm": null
+  }
+}
+```
+
+You can also make a `pkgx.yaml` file.
+
+## Adding Custom Environment Variables
+
+You can add your own environment variables if you like:
+
+```toml
+# pkgx:
+#   openssl.org: 1.1.1n
+# env:
+#   MY_VAR: my-value
+```
+
+## Contributing
+
+Mostly you will likely want to edit [./src/sniff.ts] to add new dev types.

action.yml

@@ -13,15 +13,17 @@ runs:
 
     - run: |
         TMP="$(mktemp)"
-        pkgx --internal.activate "$PWD" > "$TMP"
+        "$GITHUB_ACTION_PATH"/app.ts "$PWD" > "$TMP"
         echo "file=$TMP" >> $GITHUB_OUTPUT
       id: env
       working-directory: ${{ inputs.path }}
       shell: bash
 
     - run: |
         if ! node --version >/dev/null 2>&1; then
+          set -a
           eval "$(pkgx +node)"
+          set +a
         fi
         node "$GITHUB_ACTION_PATH"/parse.js ${{ steps.env.outputs.file }}
       shell: bash

app.ts

@@ -0,0 +1,80 @@
+#!/usr/bin/env -S pkgx deno^2 run -A
+
+//TODO if you step into dev-dir/subdir does it work?
+//TODO dev off uses PWD which may not be correct if in subdir (obv)
+
+import { Path, utils } from "libpkgx";
+import shellcode from "./src/shellcode().ts";
+import sniff from "./src/sniff.ts";
+import shell_escape from "./src/shell-escape.ts";
+
+switch (Deno.args[0]) {
+  case "--help": {
+    const status = await new Deno.Command("pkgx", {
+      args: ["gh", "repo", "view", "pkgxdev/dev"],
+    }).spawn().status;
+    Deno.exit(status.code);
+    break; // deno lint insists
+  }
+  case "--shellcode":
+    console.log(shellcode());
+    Deno.exit(0);
+    break; // deno lint insists
+}
+
+const snuff = await sniff(Path.cwd());
+
+const pkgspecs = snuff.pkgs.map((pkg) => `+${utils.pkg.str(pkg)}`);
+
+const cmd = new Deno.Command("pkgx", {
+  args: [...pkgspecs],
+  stdout: "piped",
+  env: { CLICOLOR_FORCE: "1" }, // unfortunate
+}).spawn();
+
+await cmd.status;
+
+const stdout = (await cmd.output()).stdout;
+let env = new TextDecoder().decode(stdout);
+
+// add any additional env that we sniffed
+for (const [key, value] of Object.entries(snuff.env)) {
+  env += `${key}=${shell_escape(value)}\n`;
+}
+
+env = env.trim();
+
+let undo = "";
+for (const envln of env.trim().split("\n")) {
+  const [key] = envln.split("=", 2);
+  const value = Deno.env.get(key);
+  if (value) {
+    undo += `    export ${key}=${shell_escape(value)}\n`;
+  } else {
+    undo += `    unset ${key}\n`;
+  }
+}
+
+const dir = Deno.cwd();
+
+const bye_bye_msg = pkgspecs.map((pkgspec) => `-${pkgspec.slice(1)}`).join(" ");
+
+console.log(`
+set -a
+${env}
+set +a
+
+_pkgx_dev_try_bye() {
+  suffix="\${PWD#"${dir}"}"
+  if test "$PWD" != "${dir}$suffix"; then
+    ${undo.trim()}
+    unset -f _pkgx_dev_try_bye
+    echo "\\033[31m${bye_bye_msg}\\033[0m" >&2
+    return 0
+  else
+    return 1
+  fi
+}
+`.trim());
+
+console.error("%c%s", "color: green", pkgspecs.join(" "));

deno.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "strict": true
+  },
+  "pkgx": "deno^2.1",
+  "lint": {
+    "include": ["src/", "./app.ts"],
+    "exclude": ["**/*.test.ts", "./parse.js"]
+  },
+  "test": {
+    "include": ["src/"]
+  },
+  "imports": {
+    "libpkgx": "https://raw.githubusercontent.com/pkgxdev/libpkgx/refs/tags/v0.20.1/mod.ts",
+    "libpkgx/": "https://raw.githubusercontent.com/pkgxdev/libpkgx/refs/tags/v0.20.1/src/",
+    "is-what": "https://deno.land/x/[email protected]/src/index.ts",
+    "outdent": "https://deno.land/x/[email protected]/mod.ts"
+  }
+}