@gutenye/script.js 2.1.0 → 2.3.0

package/package.json

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

package/src/Command.ts

@@ -1,6 +1,6 @@
 import { Argument } from './Argument'
-import { installCompletion } from './completion'
 import { Option } from './Option'
+import { installCompletion } from './completion'
 import { parseArgv } from './parseArgv'
 
 export class Command {
@@ -105,8 +105,6 @@ export class Command {
     await this.#invokeAction(command, positionals, options, context)
   }
 
-  a = this.add.bind(this)
-
   add(...args: any[]) {
     if (typeof args[0] === 'function') {
       this.action = args[0]
@@ -116,7 +114,7 @@ export class Command {
       if (typeof description !== 'string') {
         if (completionOrDefault) {
           throw new Error(
-            'Invalid third argument, should be a(name, description, completion) format',
+            'Invalid third argument, should be add(name, description, completion) format',
           )
         }
         completionOrDefault = description

package/src/Option.ts

@@ -10,6 +10,7 @@ export class Option {
   attributeName: string
   completion: string[] | (() => string[])
   defaultValue: any
+  inlineDefaultValue?: string
 
   constructor(
     rawFlags: string,
@@ -38,6 +39,11 @@ export class Option {
     this.variadic = rawFlags.includes('...')
     this.negate = this.long?.startsWith('--no-') ?? false
 
+    const inlineDefaultMatch = rawFlags.match(/\[[\w.]+=(.*?)\]/)
+    if (inlineDefaultMatch) {
+      this.inlineDefaultValue = inlineDefaultMatch[1]
+    }
+
     if (this.long) {
       let key = this.long.replace(/^--/, '')
       if (this.negate) key = key.replace(/^no-/, '')
@@ -53,10 +59,10 @@ export class Option {
       typeof defaultValueOrCompletion === 'function'
     ) {
       this.completion = defaultValueOrCompletion
-      this.defaultValue = undefined
+      this.defaultValue = this.inlineDefaultValue
     } else {
       this.completion = []
-      this.defaultValue = defaultValueOrCompletion
+      this.defaultValue = defaultValueOrCompletion ?? this.inlineDefaultValue
     }
   }
 

package/src/ake/akectl.ts

@@ -3,11 +3,12 @@
 import { castArray } from 'lodash-es'
 import fs from '../utils/fs'
 import {
+  AKE_FILENAMES,
+  STORAGE_DIR,
+  TEMPLATE_NAME,
   exitWithError,
   findAkeFiles,
   getRemoteDir,
-  STORAGE_DIR,
-  TEMPLATE_NAME,
 } from './shared'
 
 const NAME = 'akectl'
@@ -17,17 +18,17 @@ app.meta(NAME)
 
 app
   .cmd('init', 'Create ake file')
-  .a('<place>', 'Place', ['local', 'remote'])
-  .a(async (place: string) => {
+  .add('<place>', 'Place', ['local', 'remote'])
+  .add(async (place: string) => {
     const akeFiles = await findAkeFiles()
     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)) {
@@ -39,7 +40,7 @@ app
     await openEditor(target)
   })
 
-app.cmd('edit', 'Edit ake file').a(async () => {
+app.cmd('edit', 'Edit ake file').add(async () => {
   const akeFiles = await findAkeFiles()
   const akeFile = akeFiles[0]
   if (!akeFile) {

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,8 +2,8 @@ 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 type { Command } from './Command'
+import { AKE_FILENAMES, getCompletionName } from './ake/shared'
 
 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()
       }
     }

package/src/script.ts

@@ -3,7 +3,6 @@
 import path from 'node:path'
 import { app } from './Command'
 import { $ } from './spawn'
-
 ;(globalThis as any).$ = $
 ;(globalThis as any).app = app
 

package/src/test.ts

@@ -5,7 +5,7 @@ import { $ } from './spawn'
 
 app
   .cmd('cmd1 | c1', 'Command 1')
-  .a('<platform>', 'Platform', [
+  .add('<platform>', 'Platform', [
     'ios',
     'android',
     'windows',
@@ -13,9 +13,9 @@ app
     'linux',
     'unknown',
   ])
-  .a('<name>', 'Name')
-  .a('-l | --long')
-  .a(async (platform: string, options: any, ctx: any) => {
+  .add('<name>', 'Name')
+  .add('-l | --long')
+  .add(async (platform: string, options: any, ctx: any) => {
     console.log(platform, options, ctx)
     const name = 'Mike Smith'
     const args = ['arg 1', 'arg 2']