chore: formatting & readme update

Author: chenasraf

.editorconfig

@@ -1,5 +1,9 @@
 [*]
 tab_width = 2
+indent_size = 2
 indent_style = space
 insert_final_newline = true
-trim_trailing_whitespace = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.prettierignore

@@ -0,0 +1,2 @@
+templates/
+scaffolds/

.prettierrc

@@ -1,5 +1,15 @@
 {
-  "semi": false,
   "printWidth": 100,
-  "singleQuote": false
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 100,
+        "proseWrap": "always"
+      }
+    }
+  ]
 }

README.md

@@ -1,27 +1,27 @@
 export const ansiStyles = {
-  reset: "\x1b[0m",
-  bold: "\x1b[1m",
-  underline: "\x1b[4m",
-  black: "\x1b[30m",
+  reset: '\x1b[0m',
+  bold: '\x1b[1m',
+  underline: '\x1b[4m',
+  black: '\x1b[30m',
 }
 
 export const ansiColors = {
-  red: "\x1b[31m",
-  green: "\x1b[32m",
-  yellow: "\x1b[33m", // warning
-  blue: "\x1b[34m",
-  magenta: "\x1b[35m", // error
-  cyan: "\x1b[36m",
-  white: "\x1b[37m",
-  gray: "\x1b[90m",
-  grey: "\x1b[90m",
-  brightRed: "\x1b[91m",
-  brightGreen: "\x1b[92m",
-  brightYellow: "\x1b[93m",
-  brightBlue: "\x1b[94m",
-  brightMagenta: "\x1b[95m",
-  brightCyan: "\x1b[96m",
-  brightWhite: "\x1b[97m",
+  red: '\x1b[31m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m', // warning
+  blue: '\x1b[34m',
+  magenta: '\x1b[35m', // error
+  cyan: '\x1b[36m',
+  white: '\x1b[37m',
+  gray: '\x1b[90m',
+  grey: '\x1b[90m',
+  brightRed: '\x1b[91m',
+  brightGreen: '\x1b[92m',
+  brightYellow: '\x1b[93m',
+  brightBlue: '\x1b[94m',
+  brightMagenta: '\x1b[95m',
+  brightCyan: '\x1b[96m',
+  brightWhite: '\x1b[97m',
 }
 
 export type StringStyle = {
@@ -33,13 +33,13 @@ export type StringStyle = {
 
 export function format(string: string, style: StringStyle = {}): string {
   const { color, bold, underline, reset } = style
-  const colorCode = color ? ansiColors[color] : ""
-  const boldCode = bold ? ansiStyles.bold : ""
-  const underlineCode = underline ? ansiStyles.underline : ""
-  const resetCode = reset ? ansiStyles.reset : ""
+  const colorCode = color ? ansiColors[color] : ''
+  const boldCode = bold ? ansiStyles.bold : ''
+  const underlineCode = underline ? ansiStyles.underline : ''
+  const resetCode = reset ? ansiStyles.reset : ''
   return `${colorCode}${boldCode}${underlineCode}${string}${resetCode}`
 }
 
 export function stripColors(string: string): string {
-  return string.replace(/\x1b\[\d+m/g, "")
+  return string.replace(/\x1b\[\d+m/g, '')
 }

src/color.ts

@@ -1,13 +1,13 @@
-import { z } from "zod"
-import { isZodError, ParseError, ValidationError } from "./error"
-import { HelpGenerator } from "./help"
+import { z } from 'zod'
+import { isZodError, ParseError, ValidationError } from './error'
+import { HelpGenerator } from './help'
 import MassargOption, {
   MassargFlag,
   OptionConfig,
   TypedOptionConfig,
   MassargHelpFlag,
-} from "./option"
-import { setOrPush } from "./utils"
+} from './option'
+import { setOrPush } from './utils'
 
 export const CommandConfig = <RunArgs extends z.ZodType>(args: RunArgs) =>
   z.object({
@@ -93,9 +93,9 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
     }
   }
 
-  flag(config: Omit<OptionConfig<boolean>, "parse">): MassargCommand<Args>
+  flag(config: Omit<OptionConfig<boolean>, 'parse'>): MassargCommand<Args>
   flag(config: MassargFlag): MassargCommand<Args>
-  flag(config: Omit<OptionConfig<boolean>, "parse"> | MassargFlag): MassargCommand<Args> {
+  flag(config: Omit<OptionConfig<boolean>, 'parse'> | MassargFlag): MassargCommand<Args> {
     try {
       const flag = config instanceof MassargFlag ? config : new MassargFlag(config)
       this.options.push(flag as MassargOption)
@@ -138,39 +138,16 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
   }
 
   parse(argv: string[], args?: Partial<Args>, parent?: MassargCommand<Args>): Promise<void> | void {
-    this.args ??= {}
-    this.args = { ...this.args, ...args }
-    let _argv = [...argv]
-    while (_argv.length) {
-      const arg = _argv.shift()!
-      const found = this.options.some((o) => o._isOption(arg))
-      if (found) {
-        _argv = this.parseOption(arg, _argv)
-        continue
-      }
-
-      const command = this.commands.find((c) => c.name === arg || c.aliases.includes(arg))
-      if (command) {
-        return command.parse(_argv, this.args, parent ?? this)
-      }
-      const defaultOption = this.options.find((o) => o.isDefault)
-      if (defaultOption) {
-        _argv = this.parseOption(`--${defaultOption.name}`, [arg, ..._argv])
-        continue
-      }
-    }
-    if (this._run) {
-      this._run({ ...args, ...this.args } as Args, parent ?? this)
-    }
+    this.getArgs(argv, args, parent, true)
   }
 
   private parseOption(arg: string, argv: string[]) {
     const option = this.options.find((o) => o._match(arg))
     if (!option) {
       throw new ValidationError({
         path: [MassargOption.getName(arg)],
-        code: "unknown_option",
-        message: "Unknown option",
+        code: 'unknown_option',
+        message: 'Unknown option',
       })
     }
     const res = option._parseDetails([arg, ...argv])
@@ -182,9 +159,27 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
     return res.argv
   }
 
-  getArgs(argv: string[]): Args {
-    let args: Args = {} as Args
+  getArgs(
+    argv: string[],
+    __args?: Partial<Args>,
+    parent?: MassargCommand<any>,
+    parseCommands?: false,
+  ): Promise<void> | void
+  getArgs(
+    argv: string[],
+    __args?: Partial<Args>,
+    parent?: MassargCommand<any>,
+    parseCommands?: true,
+  ): Args
+  getArgs(
+    argv: string[],
+    args?: Partial<Args>,
+    parent?: MassargCommand<any>,
+    parseCommands = false,
+  ): Args | Promise<void> | void {
+    let _args: Args = { ...this.args, ...args } as Args
     let _argv = [...argv]
+    const _a = this.args as Record<string, string[]>
     while (_argv.length) {
       const arg = _argv.shift()!
       const found = this.options.some((o) => o._isOption(arg))
@@ -193,25 +188,41 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
         if (!option) {
           throw new ValidationError({
             path: [MassargOption.getName(arg)],
-            code: "unknown_option",
-            message: "Unknown option",
+            code: 'unknown_option',
+            message: 'Unknown option',
           })
         }
         const res = option._parseDetails(argv)
-        args[res.key as keyof Args] = setOrPush<Args[keyof Args]>(
+        _args[res.key as keyof Args] = setOrPush<Args[keyof Args]>(
           res.value,
-          args[res.key as keyof Args],
+          _args[res.key as keyof Args],
           option.isArray,
         )
         continue
       }
 
       const command = this.commands.find((c) => c.name === arg || c.aliases.includes(arg))
       if (command) {
-        break
+        if (!parseCommands) {
+          break
+        }
+        return command.parse(_argv, this.args, parent ?? this)
       }
+      const defaultOption = this.options.find((o) => o.isDefault)
+      if (defaultOption) {
+        _argv = this.parseOption(`--${defaultOption.name}`, [arg, ..._argv])
+        continue
+      }
+      _a.extra ??= []
+      _a.extra.push(arg)
+    }
+    if (!parseCommands) {
+      return _args
+    }
+    this.args = { ...this.args, ..._args }
+    if (this._run) {
+      this._run(this.args, parent ?? this)
     }
-    return args
   }
 
   helpString(): string {
@@ -224,11 +235,11 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
 }
 
 export class MassargHelpCommand<T extends ArgsObject = ArgsObject> extends MassargCommand<T> {
-  constructor(config: Partial<Omit<CommandConfig<T>, "run">> = {}) {
+  constructor(config: Partial<Omit<CommandConfig<T>, 'run'>> = {}) {
     super({
-      name: "help",
-      aliases: ["h"],
-      description: "Print help for this command, or a subcommand if specified",
+      name: 'help',
+      aliases: ['h'],
+      description: 'Print help for this command, or a subcommand if specified',
       // argsHint: "[command]",
       run: (args, parent) => {
         if (args.command) {
@@ -238,9 +249,9 @@ export class MassargHelpCommand<T extends ArgsObject = ArgsObject> extends Massa
             return
           } else {
             throw new ParseError({
-              path: ["command"],
-              code: "unknown_command",
-              message: "Unknown command",
+              path: ['command'],
+              code: 'unknown_command',
+              message: 'Unknown command',
               received: args.command,
             })
           }
@@ -250,9 +261,9 @@ export class MassargHelpCommand<T extends ArgsObject = ArgsObject> extends Massa
       ...config,
     })
     this.option({
-      name: "command",
-      aliases: ["c"],
-      description: "Command to print help for",
+      name: 'command',
+      aliases: ['c'],
+      description: 'Command to print help for',
       isDefault: true,
     })
   }

src/command.ts

@@ -1,17 +1,17 @@
-import { z } from "zod"
+import { z } from 'zod'
 
 export class ValidationError extends Error {
   path: string[]
   code: string
   message: string
 
   constructor({ path, code, message }: { path: string[]; code: string; message: string }) {
-    const msg = `${path.join(".")}: ${message}`
+    const msg = `${path.join('.')}: ${message}`
     super(msg)
     this.path = path
     this.code = code
     this.message = msg
-    this.name = "ValidationError"
+    this.name = 'ValidationError'
   }
 }
 export class ParseError extends Error {
@@ -31,15 +31,15 @@ export class ParseError extends Error {
     message: string
     received?: unknown
   }) {
-    let msg = `${path.join(".")}: ${message}`
+    let msg = `${path.join('.')}: ${message}`
     if (received) {
       msg += ` (received: ${received})`
     }
     super(msg)
     this.path = path
     this.code = code
     this.message = msg
-    this.name = "ParseError"
+    this.name = 'ParseError'
     this.received = received
   }
 }