decategorize

Author: mxcl

.github/scripts/build.ts

@@ -17,33 +17,19 @@ if (!indir || !outdir || !index_json_path) {
 
 const scripts = JSON.parse(Deno.readTextFileSync(index_json_path)).scripts as Script[]
 
-const categories: Record<string, Script[]> = {}
 const users: Record<string, Script[]> = {}
 
 for (const script of scripts) {
-  if (script.category) {
-    categories[script.category] ??= []
-    categories[script.category].push(script)
-  }
   const user = script.fullname.split('/')[0]
   users[user] ??= []
   users[user].push(script)
 }
 
 // sort each entry in categories and users by the script birthtime
-for (const scripts of Object.values(categories)) {
-  scripts.sort((a, b) => new Date(b.birthtime).getTime() - new Date(a.birthtime).getTime());
-}
 for (const scripts of Object.values(users)) {
   scripts.sort((a, b) => new Date(b.birthtime).getTime() - new Date(a.birthtime).getTime());
 }
 
-for (const category in categories) {
-  const d = outdir.join(category)
-  const scripts = categories[category].filter(({description}) => description)
-  d.mkdir('p').join('index.json').write({ json: { scripts }, force: true, space: 2 })
-}
-
 for (const user in users) {
   const d = outdir.join('u', user)
   const scripts = users[user].filter(({description}) => description)
@@ -53,15 +39,13 @@ for (const user in users) {
 for (const script of scripts) {
   console.error(script)
   const [user, name] = script.fullname.split('/')
-  const { category } = script
   const gh_slug = new URL(script.url).pathname.split('/').slice(1, 3).join('/')
   const infile = indir.join(gh_slug, 'scripts', basename(script.url))
 
   infile.cp({ to: outdir.join('u', user).mkdir('p').join(name) })
 
-  const leaf = name.split('-').slice(1).join('-')
-  if (category && !outdir.join(category, leaf).exists()) { // not already snagged
-    infile.cp({ to: outdir.join(category, leaf) })
+  if (!outdir.join(name).exists() && user != "pkgxdev") { // not already snagged
+    infile.cp({ to: outdir.join(name) })
   }
 }
 

.github/scripts/index.ts

@@ -18,24 +18,38 @@ if (import.meta.main) {
   const scripts: Script[] = []
   for await (const slug of iterateGitRepos('.')) {
     console.error(`iterating: ${slug}`);
-    scripts.push(...await get_metadata(slug));
-  }
-
-  scripts.sort((a, b) => b.birthtime.getTime() - a.birthtime.getTime());
-
-  const categories = (() => {
-    const categories: Record<string, number> = {}
-    for (const script of scripts) {
-      if (script.category && script.description) {
-        categories[script.category] ??= 0;
-        categories[script.category]++;
+    for (const script of await get_metadata(slug)) {
+      switch (basename(script.fullname)) {
+        case "cache":
+        case "demo-test-pattern":
+        case "ensure":
+        case "inventory":
+        case "pantry-inventory":
+        case "ls":
+        case "magic":
+        case "prune":
+        case "run":
+        case "stub":
+        case "upgrade":
+        case "cache+prune":
+        case "cache+ls":
+        case "cache+upgrade":
+        case "demo":
+          if (!script.fullname.startsWith("mxcl/")) {
+            // ignore stuff that was forked from when the root repo had scripts
+            // these scripts are now on @mxcl/…
+            continue;
+          }
+          // fallthrough
+        default:
+          scripts.push(script)
       }
     }
-    return Object.keys(categories)
-  })();
+  }
 
+  scripts.sort((a, b) => b.birthtime.getTime() - a.birthtime.getTime());
 
-  console.log(JSON.stringify({ scripts, categories }, null, 2));
+  console.log(JSON.stringify({ scripts }, null, 2));
 }
 
 ////////////////////////////////////////////////////////////////////// lib
@@ -45,13 +59,16 @@ async function extractMarkdownSection(filePath: string, sectionTitle: string): P
   let capturing = false;
   let sectionContent = '';
 
-  for (const line of lines) {
-    if (line.startsWith('## ')) {
+  for (let line of lines) {
+    line = line.trim();
+    if (/^##\s+/.test(line)) {
       if (capturing) {
-        break;  // stop if we reach another ## section
-      } else if (normalize_title(line.slice(3)) == normalize_title(sectionTitle)) {
+        break;  // stop if we reach another header section
+      } else if (normalize_title(line.replace(/^#+/, '')) == normalize_title(sectionTitle)) {
+        capturing = true;
+      } else if (line.replace(/^#+/, '').trim() == mash_title(sectionTitle)) {
         capturing = true;
-      } else if (line.slice(3).trim() == mash_title(sectionTitle)) {
+      } else if (line.replace(/^#+/, '').trim() == `\`mash ${sectionTitle}\``) {
         capturing = true;
       }
     } else if (capturing) {
@@ -77,7 +94,6 @@ export interface Script {
   description?: string
   avatar: string
   url: string
-  category?: string
   README?: string
   cmd: string
 }
@@ -123,6 +139,8 @@ async function get_metadata(slug: string) {
         // the file used to exist but has been deleted
         console.warn("skipping deleted: ", filename, line)
         continue
+      } else {
+        console.warn("%cadding: ", 'color:green', filename, line)
       }
 
       const repo_metadata = JSON.parse(await Deno.readTextFile(join(slug, 'metadata.json')))
@@ -133,15 +151,14 @@ async function get_metadata(slug: string) {
       const avatar = repo_metadata.avatar
       const fullname = join(dirname(slug), _stem)
       const url = repo_metadata.url +'/scripts/' + basename(filename)
-      const category = (([x, y]) => x?.length > 0 && y ? x : undefined)(basename(filename).split("-"))
       const description = README
         ? extract_description(README)
         : fullname == 'pkgxdev/demo-test-pattern'
           ? 'Prints a test pattern to your console'
           : undefined
-      const cmd = category ? `mash ${category} ${_stem.split('-').slice(1).join('-')}` : `mash ${fullname}`
+      const cmd = `mash ${_stem}`
 
-      rv.push({ fullname, birthtime, description, avatar, url, category, README, cmd })
+      rv.push({ fullname, birthtime, description, avatar, url, README, cmd })
     }
   }
 

.github/workflows/cd.www.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: pkgxdev/setup@v3
+      - uses: pkgxdev/setup@v4
 
       - name: trawl
         run: .github/scripts/trawl.ts --out ./build

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: pkgxdev/setup@v3
+      - uses: pkgxdev/setup@v4
       - run: ./mash demo test-pattern
       - run: ./mash demo test-pattern           # check cache route works too
       - run: ./mash pkgxdev/demo-test-pattern   # check fully qualified

README.md

@@ -17,39 +17,24 @@ mash up millions of open source packages into monstrously powerful scripts.
 ## Quick Start
 
 ```sh
-brew install pkgxdev/made/mash || curl https://mash.pkgx.sh | sh
+brew install pkgxdev/made/mash || curl https://pkgx.sh | sh
 ```
 
 > [!NOTE]
 > `mash` is a plain POSIX script. All it needs is `bash`, `curl`, and `pkgx`.
-> So if you like you can just download it by itself.
+> So if you like install the deps and just download it by itself.
 
 ## Getting Started
 
-```sh
-$ mash  # or https://mash.pkgx.sh
-# ^^ lists all script categories
-```
-
-You can browse script listings with the TUI or at [mash.pkgx.sh]:
-
-```sh
-$ mash ai  # or https://mash.pkgx.sh/ai/
-# ^^ lists all ai scripts
-```
-
-> [!NOTE]
-> The above lists all user submitted scripts in the `ai` category.
-
-Once you’ve found a script you want to run:
+Visit [mash.pkgx.sh] to see what scripts are available. Once you’ve found a
+script you want to run:
 
 ```sh
-$ mash ai chat --help  # or https://mash.pkgx.sh/ai/chat/
+mash transcribe --help  # or https://mash.pkgx.sh/mxcl/transcribe
 ```
 
  
 
-
 ## Contributing Scripts
 
 ### Writing Scripts
@@ -68,24 +53,13 @@ Generally it is sensible to specify constrained versions:
 
 ### Naming Scripts
 
-`mash` operates with a “categorization by default is good” philosophy. Your
-scripts must be categorized or namespaced with your user.
-
-Thus if you add a script named `foo` it can only be used via
-`mash username/foo`. But if you add a script called `foo-bar` if will be
-listed if a user types `mash foo`:
-
-```sh
-$ mash foo
-
-    mash foo bar           # your description about `foo bar` is shown here
-    mash foo other-script  # …
-```
+Names are first-come, first served. Please practice taste. We reserve the
+right to manage names.
 
 > [!TIP]
 > Extensions (eg. `.sh`, `.ts`) are *recommended* for GitHub readability.
 > They will be stripped from the mash execution name, eg. `foo-bar.ts` is
-> invoked via `mash foo bar` and not `mash foo bar.ts`
+> invoked via `mash foo-bar` and not `mash foo-bar.ts`
 
 ### Installing Language Dependencies
 
@@ -143,8 +117,8 @@ available.
 Assuming a script named `foo-bar`, while debugging just:
 
 ```sh
-$ chmod +x scripts/foo-bar
-$ ./scripts/foo-bar
+chmod +x scripts/foo-bar
+./scripts/foo-bar
 ```
 
 After pushing we will index your script within 60 minutes.
@@ -158,16 +132,6 @@ Once indexed your script can be run with:
 > If you can visit https://mash.pkgx.sh/USERNAME/SCRIPT-NAME then you’re
 > script has been indexed.
 
-> [!NOTE]
-> * Categorized scripts occur on a first come first served basis. If you
->   create a script called `foo-bar` and someone already did that then you are
->   too late and users can only call your script with `mash youruser/foo-bar`.
-> * Updates are fetched automatically, there is no versioning at this time.
-> * Single letter categorizations are ignored, eg `./scripts/f-u` will not be
->   indexed or made available to mash. If you have a particularly good single
->   letter category that you want an exception made, open a discussion and
->   let’s chat!
-
 > [!NOTE]
 > ### Naming Guidelines: A Call for Consideration
 > Think for a little about the names you are picking. We reserve the right
@@ -206,8 +170,8 @@ pkg names, just type what you would type to run the command.
 
 ### Documenting Your Script
 
-Rewrite the README in your fork so there is a `## mash category scriptname`
-section. If your script is not globally categorized then you would do
+Rewrite the README in your fork so there is a `## mash scriptname`
+section. If your script is not the first to get a name then you would do
 `## mash username/scriptname` instead.
 
 * The paragraph after the `##` will be the [mash.pkgx.sh] description
@@ -231,23 +195,23 @@ https://github.com/mxcl/mash
 directly via `pkgx`:
 
 ```sh
-$ curl -O https://raw.githubusercontent.com/mxcl/mash/main/scripts/gh-stargazer
-$ pkgx ./gh-stargazer
+curl -O https://raw.githubusercontent.com/mxcl/mash/main/scripts/transcribe
+pkgx ./transcribe
 ```
 
 Even `pkgx` isn’t required, they can source the dependencies themselves and
 run the script manually:
 
 ```sh
-$ bash ./stargazer
+$ bash ./transcribe
 # ^^ they will need to read the script to determine deps and interpreter
 ```
 
 Hackers can use your script without installing `pkgx` or `mash` first via our
 cURL one-liner. This executes the script but doesn’t install anything:
 
 ```sh
-sh <(curl https://mash.pkgx.sh) <category> <scriptname>
+sh <(curl https://mash.pkgx.sh) transcribe
 ```
 
 

mash

@@ -7,6 +7,15 @@ if [ "$1" == --version ]; then
   exit 0
 fi
 
+if [ -z "$1" -o "$1" == "--help" ]; then
+  echo "mash <scriptname> [args...]" 1>&2
+  if [ "$1" == "--help" ]; then
+    exit 0
+  else
+    exit 1
+  fi
+fi
+
 if [ -n "$RUNNER_DEBUG" -a -n "$GITHUB_ACTIONS" ] || [ -n "$VERBOSE" ]; then
   set -x
 fi
@@ -66,24 +75,23 @@ run() {
     echo "error: $URL" 1>&2
     exit 2
   fi
-
 }
 
-if [ -z "$1" ]; then
-  curl -Ssf https://pkgxdev.github.io/mash/ | pkgx --quiet jq '.categories[]' --raw-output | sort | uniq
-  exit 0
-elif [[ "$1" == *"/"* ]]; then
-  # fully quaified name not a category
-  cmd=$1
-  shift
-  run u/$cmd "$@"
-elif [[ -z "$2" ]]; then
-  curl -Ssf https://pkgxdev.github.io/mash/$1/ |
-    pkgx --quiet jq -r '.scripts[] | [.cmd, .description] | @tsv' |
-    awk 'BEGIN {FS="\t"; print "| Script | Description |"; print "|-|-|"} {printf("| %s | %s |\n", $1, $2)}' |
-    pkgx --quiet gum format
-else
-  cmd=$1/$2
-  shift; shift
-  run $cmd "$@"
-fi
+cmd=$1
+shift
+
+case "$cmd-$1" in
+tea-erc20|media-yt2mp3|pantry-checker|tmux-sessionizer|demo-test-pattern)
+  cmd="$cmd-$1"
+  shift;;
+*)
+  if [[ "$cmd" == pkgx/* || "$cmd" == pkgxdev/* ]]; then
+    cmd="mxcl/$(basename $cmd)"
+  fi
+
+  if [[ "$cmd" == */* ]]; then
+    cmd="u/$cmd"
+  fi
+esac
+
+run $cmd "$@"