test: tests & bug fixes

Author: chenasraf

jest.config.ts

@@ -23,18 +23,18 @@ export default {
   // collectCoverageFrom: undefined,
 
   // The directory where Jest should output its coverage files
-  coverageDirectory: "coverage",
+  coverageDirectory: 'coverage',
 
   // An array of regexp pattern strings used to skip coverage collection
   // coveragePathIgnorePatterns: [
   //   "/node_modules/"
   // ],
 
   // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
+  coverageProvider: 'v8',
 
   // A list of reporter names that Jest uses when writing coverage reports
-  coverageReporters: ["json-summary", "json", "text", "lcov", "clover"],
+  coverageReporters: ['json-summary', 'json', 'text', 'lcov', 'clover'],
 
   // An object that configures minimum threshold enforcement for coverage results
   // coverageThreshold: undefined,
@@ -88,7 +88,7 @@ export default {
   // notifyMode: "failure-change",
 
   // A preset that is used as a base for Jest's configuration
-  preset: "ts-jest",
+  preset: 'ts-jest',
 
   // Run tests from one or more projects
   // projects: undefined,
@@ -147,9 +147,7 @@ export default {
   // ],
 
   // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
+  testPathIgnorePatterns: ['/node_modules/', '/_old/'],
 
   // The regexp pattern or array of patterns that Jest uses to detect test files
   // testRegex: [],

src/color.ts

@@ -1,3 +1,6 @@
+import z from 'zod'
+import { zodEnumFromObjKeys } from './utils'
+
 export const ansiStyles = {
   reset: '\x1b[0m',
   bold: '\x1b[1m',
@@ -24,12 +27,14 @@ export const ansiColors = {
   brightWhite: '\x1b[97m',
 }
 
-export type StringStyle = {
-  color?: keyof typeof ansiColors
-  bold?: boolean
-  underline?: boolean
-  reset?: boolean
-}
+export const StringStyle = z.object({
+  bold: z.boolean().optional(),
+  underline: z.boolean().optional(),
+  color: zodEnumFromObjKeys(ansiColors).optional(),
+  reset: z.boolean().optional(),
+})
+
+export type StringStyle = z.infer<typeof StringStyle>
 
 export function format(string: string, style: StringStyle = {}): string {
   const { color, bold, underline, reset } = style

src/command.ts

@@ -1,13 +1,13 @@
 import { z } from 'zod'
 import { isZodError, ParseError, ValidationError } from './error'
-import { HelpGenerator } from './help'
+import { defaultHelpConfig, HelpConfig, HelpGenerator } from './help'
 import MassargOption, {
   MassargFlag,
   OptionConfig,
   TypedOptionConfig,
   MassargHelpFlag,
 } from './option'
-import { setOrPush } from './utils'
+import { setOrPush, deepMerge } from './utils'
 import MassargExample, { ExampleConfig } from './example'
 
 export const CommandConfig = <RunArgs extends z.ZodType>(args: RunArgs) =>
@@ -26,18 +26,7 @@ export const CommandConfig = <RunArgs extends z.ZodType>(args: RunArgs) =>
       .function()
       .args(args, z.any())
       .returns(z.union([z.promise(z.void()), z.void()])) as z.ZodType<Runner<z.infer<RunArgs>>>,
-    /**
-     * Whether to bind the help command to this command
-     *
-     * Set this to `true` to automatically add a `help` command to this command's subcommands.
-     */
-    bindHelpCommand: z.boolean().optional(),
-    /**
-     * Whether to bind the help option to this command
-     *
-     * Set this to `true` to automatically add a `--help` option to this command's options.
-     */
-    bindHelpOption: z.boolean().optional(),
+    helpConfig: HelpConfig.optional(),
     // argsHint: z.string().optional(),
   })
 
@@ -59,19 +48,15 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
   options: MassargOption[] = []
   examples: MassargExample[] = []
   args: Partial<Args> = {}
+  helpConfig: Required<HelpConfig>
 
   constructor(options: CommandConfig<Args>) {
     CommandConfig(z.any()).parse(options)
     this.name = options.name
     this.description = options.description
     this.aliases = options.aliases ?? []
     this._run = options.run
-    if (options.bindHelpCommand) {
-      this.command(new MassargHelpCommand())
-    }
-    if (options.bindHelpOption) {
-      this.option(new MassargHelpFlag())
-    }
+    this.helpConfig = HelpConfig.required().parse(defaultHelpConfig)
   }
 
   command<A extends ArgsObject = Args>(config: CommandConfig<A>): MassargCommand<Args>
@@ -110,15 +95,13 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
   ): MassargCommand<Args> {
     try {
       const flag = config instanceof MassargFlag ? config : new MassargFlag(config)
-      if (flag.isDefault) {
-        const defaultOption = this.options.find((o) => o.isDefault)
-        if (defaultOption) {
-          throw new ValidationError({
-            code: 'duplicate_default_option',
-            message: `Option "${flag.name}" cannot be set as default because option "${defaultOption.name}" is already set as default`,
-            path: [this.name, flag.name],
-          })
-        }
+      const existing = this.options.find((c) => c.name === flag.name)
+      if (existing) {
+        throw new ValidationError({
+          code: 'duplicate_flag',
+          message: `Flag "${flag.name}" already exists`,
+          path: [this.name, flag.name],
+        })
       }
       this.options.push(flag as MassargOption)
       return this
@@ -140,6 +123,14 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
     try {
       const option =
         config instanceof MassargOption ? config : MassargOption.fromTypedConfig(config)
+      const existing = this.options.find((c) => c.name === option.name)
+      if (existing) {
+        throw new ValidationError({
+          code: 'duplicate_option',
+          message: `Option "${option.name}" already exists`,
+          path: [this.name, option.name],
+        })
+      }
       if (option.isDefault) {
         const defaultOption = this.options.find((o) => o.isDefault)
         if (defaultOption) {
@@ -169,6 +160,20 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
     return this
   }
 
+  help(config: HelpConfig): MassargCommand<Args> {
+    this.helpConfig = HelpConfig.required().parse(
+      deepMerge(defaultHelpConfig, config) as HelpConfig,
+    )
+
+    if (this.helpConfig.bindCommand) {
+      this.command(new MassargHelpCommand())
+    }
+    if (this.helpConfig.bindOption) {
+      this.option(new MassargHelpFlag())
+    }
+    return this
+  }
+
   main<A extends ArgsObject = Args>(run: Runner<A>): MassargCommand<Args> {
     this._run = run
     return this
@@ -217,46 +222,50 @@ export default class MassargCommand<Args extends ArgsObject = ArgsObject> {
     let _args: Args = { ...this.args, ...args } as Args
     let _argv = [...argv]
     const _a = this.args as Record<string, string[]>
+
+    // fill defaults
+    for (const option of this.options) {
+      if (option.defaultValue !== undefined && _a[option.name] === undefined) {
+        _args[option.name as keyof Args] = option.defaultValue as Args[keyof Args]
+      }
+    }
+
+    // parse options
     while (_argv.length) {
       const arg = _argv.shift()!
       const found = this.options.some((o) => o._isOption(arg))
       if (found) {
-        const option = this.options.find((o) => o._match(arg))
-        if (!option) {
-          throw new ValidationError({
-            path: [MassargOption.getName(arg)],
-            code: 'unknown_option',
-            message: 'Unknown option',
-          })
-        }
-        const res = option._parseDetails(argv)
-        _args[res.key as keyof Args] = setOrPush<Args[keyof Args]>(
-          res.value,
-          _args[res.key as keyof Args],
-          option.isArray,
-        )
+        _argv = this.parseOption(arg, _argv)
+        _args = { ..._args, ...this.args }
         continue
       }
 
       const command = this.commands.find((c) => c.name === arg || c.aliases.includes(arg))
       if (command) {
+        // this is dry run, just exit
         if (!parseCommands) {
           break
         }
+        // this is real run, parse command, pass unparsed args
         return command.parse(_argv, this.args, parent ?? this)
       }
+      // default option - passes arg value even without flag name
       const defaultOption = this.options.find((o) => o.isDefault)
       if (defaultOption) {
         _argv = this.parseOption(`--${defaultOption.name}`, [arg, ..._argv])
         continue
       }
+      // not parsed by any step, add to extra key
       _a.extra ??= []
       _a.extra.push(arg)
     }
+    this.args = { ...this.args, ..._args }
+    // dry run, just exit
     if (!parseCommands) {
-      return _args
+      return this.args as Args
     }
-    this.args = { ...this.args, ..._args }
+
+    // no sub command found, run main command
     if (this._run) {
       this._run(this.args, parent ?? this)
     }