@gutenye/script.js 2.4.0 → 2.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gutenye/script.js",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "description": "Write shell scripts in JavaScript",
   "keywords": [
     "shell",

package/src/ake/README.md

@@ -40,35 +40,85 @@ ake greetings   # find the ake file and runs it
 ake <Tab> # uses ake file's completion
 ```
 
+## Use a template / another location
+
+Create `~/bin.src/ake/template`
+
+```sh
+akectl init local         # create an ake file from template in current directory
+akectl init local foo     # create an akefoo file
+akectl init remote        # create in ~/bin.src/ake/<dir>, doesn't touch original project files
+akectl init remote foo    # create akefoo in remote location
+akectl edit               # opens an editor to edit the ake file
+akectl edit foo           # opens an editor to edit the akefoo file
+```
+
+## Organize Multiple Files
+
+For larger projects, split commands into separate files and import them.
+
+```
+project/
+├── ake              # entry point (executable)
+├── src/
+│   ├── index.ts     # imports all command files
+│   ├── cmd1.ts
+│   └── cmd2.ts
+```
+
+`src/cmd1.ts`
+
+```ts
+import { app } from "@gutenye/script.js";
+
+app.cmd("greetings").add(() => {
+  $`echo greetings`;
+});
+```
+
+`src/index.ts`
+
+```ts
+import "./cmd1";
+import "./cmd2";
+```
+
+`ake`
+
+```ts
+#!/usr/bin/env bun
+
+import { app } from "@gutenye/script.js";
+import "./src";
+
+await app.run();
+```
+
 ## Multiple Ake Files
 
-You can have multiple ake files in the same directory, each for different tasks. Any file named `ake<suffix>` or `ake<suffix>.ts` is supported.
+Any file named `ake<suffix>` or `ake<suffix>.ts` is supported.
+
+1. Create a variant ake file
 
 ```sh
-# Create variant ake files
 akectl init local foo   # creates ./akefoo
-akectl init local bar   # creates ./akebar
+```
 
-# Create symlinks so you can invoke them by name
-ln -sf $(which ake) ~/bin/akefoo
-ln -sf $(which ake) ~/bin/akebar
+2. Create a wrapper script so you can invoke it by name
 
-# Run them
-akefoo greetings   # finds ./akefoo and runs it
-akebar deploy      # finds ./akebar and runs it
+```sh
+akectl install-bin ~/bin/ake foo
 ```
 
-Each variant gets its own shell completion spec automatically.
+3. Enable shell completion in `ake.fish`
 
-## Use a template / another location
+```fish
+_setup_ake_complete ake foo
+```
 
-Create `~/bin.src/ake/template`
+4. Run it
 
 ```sh
-akectl init local         # create an ake file from template in current directory
-akectl init local foo     # create an akefoo file
-akectl init remote        # create in ~/bin.src/ake/<dir>, doesn't touch original project files
-akectl init remote foo    # create akefoo in remote location
-akectl edit               # opens an editor to edit the ake file
-akectl edit foo           # opens an editor to edit the akefoo file
+akefoo greetings
+akefoo <Tab>   # with autocompletion
 ```

package/src/ake/ake.ts

@@ -2,7 +2,7 @@
 
 import { exitWithError, findAkeFiles, getSuffix } from './shared'
 
-const suffix = getSuffix()
+const suffix = process.env.SUFFIX ?? getSuffix()
 
 async function main() {
   const akeFile = await findAkeFile()

package/src/ake/akectl.ts

@@ -3,12 +3,12 @@
 import { castArray } from 'lodash-es'
 import fs from '../utils/fs'
 import {
-  STORAGE_DIR,
-  TEMPLATE_NAME,
   exitWithError,
   findAkeFiles,
   getAkeFilenames,
   getRemoteDir,
+  STORAGE_DIR,
+  TEMPLATE_NAME,
 } from './shared'
 
 const NAME = 'akectl'
@@ -43,6 +43,22 @@ app
     await openEditor(target)
   })
 
+app
+  .cmd('install-bin', 'Create a wrapper script for ake with a suffix')
+  .add('<prefix>', 'Path prefix (e.g. ~/bin/ake, ~/bin/a)')
+  .add('<suffix>', 'Suffix to append (e.g. "foo" → ~/bin/akefoo)')
+  .add(async (prefix: string, suffix: string) => {
+    const target = `${prefix}${suffix}`
+    const content = `
+#!/usr/bin/env bash
+
+SUFFIX=${suffix} exec ${prefix} "$@"
+`.trim()
+    await fs.writeFile(target, content)
+    await fs.chmod(target, 0o755)
+    console.log(`created ${target}`)
+  })
+
 app
   .cmd('edit', 'Edit ake file')
   .add('[suffix]', 'Ake file suffix (e.g. "foo" for akefoo)')

package/src/ake/completions/ake.fish

@@ -1,8 +1,17 @@
-complete --erase a
-complete --command a --no-files --arguments '(_ake_complete)'
+function _setup_ake_complete
+	set cmd $argv[1]
+	set suffix $argv[2]
+	complete --erase $cmd$suffix
+	complete --command $cmd$suffix --no-files --arguments "(_ake_complete $suffix)"
+end
 
 function _ake_complete
-	set unique_name (string replace --all '/' '_' (realpath $PWD))
-	set name "ake.$unique_name"
+	set suffix $argv[1]
+	set unique_name (string replace --all '/' '_' $PWD)
+	set name "ake$suffix.$unique_name"
 	_carapace_completer $name
 end
+
+_setup_ake_complete ake
+# _setup_ake_complete ake <suffix>
+

package/src/completion.ts

@@ -146,6 +146,7 @@ export async function installCompletion(
 
     fsSync.mkdirSync(specsDir, { recursive: true })
     fsSync.writeFileSync(filePath, result.text)
+    console.log(`Updated completion spec: ${filePath}`)
   } catch {
     // completion is supplementary — silently ignore errors
   }