@gutenye/script.js 2.0.0 → 2.2.0

package/package.json

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

package/src/Command.ts

@@ -210,6 +210,7 @@ export class Command {
     context: Context,
   ) {
     const error =
+      Command.#validateRequired(command, positionals) ??
       Command.#validateOptions(command, options) ??
       Command.#validateChoices(command, positionals)
     if (error) {
@@ -229,6 +230,19 @@ export class Command {
     return this.arguments.map(String).join(' ')
   }
 
+  static #validateRequired(
+    command: Command,
+    positionals: any[],
+  ): string | null {
+    for (let i = 0; i < command.arguments.length; i++) {
+      const arg = command.arguments[i]
+      if (arg.required && positionals[i] == null) {
+        return `Missing required argument: ${arg.rawName}`
+      }
+    }
+    return null
+  }
+
   static #validateOptions(
     command: Command,
     options: Record<string, any>,

package/src/ake/README.md

@@ -4,17 +4,26 @@
 
 ## Start
 
+Install it
+
+```sh
+npm install -g @gutenye/script.js
+```
+
 1. Create an ake file
 
-edit `./ake` file, and make it executable `chmod +x ake`
+Create a `./ake` file, and make it executable `chmod +x ake`
 
 ```ts
-#!/usr/bin/env script.js
+#!/usr/bin/env bun
 
-app.cmd('greetings')
-  .add(() => {
-    console.log('greetings')
-  })
+import { app, $ } from "@gutenye/script.js";
+
+app.cmd("greetings").add(() => {
+  $`echo greetings`;
+});
+
+await app.run();
 ```
 
 2. Run it
@@ -23,7 +32,7 @@ app.cmd('greetings')
 ake greetings   # find the ake file and runs it
 ```
 
-3. Supports Shell Completion 
+3. Supports Shell Completion
 
 - Follow [guide](./completions) to setup
 
@@ -31,14 +40,12 @@ ake greetings   # find the ake file and runs it
 ake <Tab> # uses ake file's completion
 ```
 
-## Use a template
+## Use a template / another location
 
 Create `~/bin.src/ake/template`
 
-## Put ake file in another location
-
-Doesn't touch original project files
-
 ```sh
-akectl init remote # create in ~/bin.src/ake/<dir>
+akectl init local  # create a ake file from template in currenct directory
+akectl init remote  # create in ~/bin.src/ake/<dir>, doesn't touch original project files
+akectl edit # Opens a editor to edit the ake file
 ```

package/src/ake/akectl.ts

@@ -3,6 +3,7 @@
 import { castArray } from 'lodash-es'
 import fs from '../utils/fs'
 import {
+  AKE_FILENAMES,
   exitWithError,
   findAkeFiles,
   getRemoteDir,
@@ -23,11 +24,11 @@ app
     if (akeFiles.length > 0) {
       exitWithError('Already have an ake file, cannot create a new one')
     }
-    let target = 'ake'
+    let target = AKE_FILENAMES[0]
     if (place === 'remote') {
       const remoteDir = getRemoteDir()
       await fs.mkdirp(remoteDir)
-      target = `${remoteDir}/ake`
+      target = `${remoteDir}/${AKE_FILENAMES[0]}`
     }
     const templateFile = `${STORAGE_DIR}/${TEMPLATE_NAME}`
     if (await fs.pathExists(templateFile)) {

package/src/ake/shared.ts

@@ -5,6 +5,7 @@ import fs from '../utils/fs'
 const HOME = os.homedir()
 const CWD = process.cwd()
 
+export const AKE_FILENAMES = ['ake', 'ake.ts']
 export const STORAGE_DIR = `${HOME}/bin.src/ake`
 export const TEMPLATE_NAME = 'template'
 
@@ -14,10 +15,12 @@ export async function findAkeFiles(): Promise<string[]> {
   const dirsToCheck = [localDir, remoteDir]
 
   const akeFiles = await Promise.all(
-    dirsToCheck.map(async (dir) => {
-      const akeFile = `${dir}/ake`
-      return (await fs.pathExists(akeFile)) ? akeFile : null
-    }),
+    dirsToCheck.flatMap((dir) =>
+      AKE_FILENAMES.map(async (name) => {
+        const akeFile = `${dir}/${name}`
+        return (await fs.pathExists(akeFile)) ? akeFile : null
+      }),
+    ),
   )
 
   return akeFiles.filter(Boolean) as string[]

package/src/completion.ts

@@ -2,7 +2,7 @@ import nodeFs from 'node:fs'
 import os from 'node:os'
 import path from 'node:path'
 import * as yaml from 'yaml'
-import { getCompletionName } from './ake/shared'
+import { AKE_FILENAMES, getCompletionName } from './ake/shared'
 import type { Command } from './Command'
 
 export type CompletionValue = string[] | (() => string[])
@@ -126,7 +126,7 @@ export async function installCompletion(
   try {
     if (!command.name && options.scriptPath) {
       const basename = path.basename(options.scriptPath)
-      if (basename === 'ake') {
+      if (AKE_FILENAMES.includes(basename)) {
         command.name = getCompletionName()
       }
     }