@bemoje/cli 0.0.4 → 0.0.5

package/src/db/PresetsSection.test.ts

@@ -0,0 +1,130 @@
+import { CommandBuilder } from '../cmd/CommandBuilder'
+import { JsonFile } from './JsonFile'
+import { PresetsSection } from './PresetsSection'
+
+describe(PresetsSection.name, () => {
+  const emptyPreset = {
+    description: 'empty',
+    presets: [],
+    args: [],
+    options: {},
+  }
+
+  const defaults = {
+    description: 'All presets inherit from this preset',
+    presets: [],
+    args: [null],
+    options: {
+      help: false,
+      opt: false,
+    },
+  }
+
+  let file: JsonFile
+  let section: PresetsSection
+  let saveSpy: jest.SpyInstance
+
+  beforeEach(() => {
+    new CommandBuilder('t', (c) => {
+      c.argument('[arg]')
+      c.option('--opt')
+      c.preset('preset1', {
+        description: 'preset1',
+      })
+      file = c.db
+      section = file.presets
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      saveSpy = jest.spyOn(file.db, 'save').mockImplementation((() => {}) as any)
+    })
+  })
+
+  describe('constructor', () => {
+    it('should create an instance of PresetsSection', () => {
+      expect(section).toBeInstanceOf(PresetsSection)
+    })
+
+    it('should set the file property', () => {
+      expect(section.file).toBe(file)
+    })
+
+    it('should set defaults', () => {
+      expect(section.defaultValues['defaults']).toEqual(defaults)
+    })
+  })
+
+  describe('assertValid', () => {
+    it('should validate', () => {
+      expect(() => section.assertValid('key', emptyPreset)).not.toThrow()
+      expect(() => section.assertValid('key key', emptyPreset)).toThrow()
+    })
+  })
+
+  describe('defineProperty', () => {
+    it('should define a property for the section', () => {
+      section.defineProperty('key', emptyPreset)
+      expect(section.defaultValues['key']).toEqual(emptyPreset)
+    })
+
+    it('should clone value', () => {
+      section.defineProperty('key', emptyPreset)
+      expect(section.defaultValues['key']).not.toBe(emptyPreset)
+      expect(section.defaultValues['key']).toEqual(emptyPreset)
+    })
+  })
+
+  describe('initialize', () => {
+    it('should do nothing if the section is already initialized', () => {
+      section.initialize()
+      const spy = jest.spyOn(section.db, 'getSafe')
+      section.initialize()
+      expect(spy).not.toHaveBeenCalled()
+    })
+
+    it('should set the values if the section is not initialized', () => {
+      section.defineProperty('key', emptyPreset)
+      section.initialize()
+      expect(section.get('key')).toEqual(emptyPreset)
+    })
+
+    it('should set the values and save the section if save is true', () => {
+      section.defineProperty('key', emptyPreset)
+      section.initialize(true)
+      expect(saveSpy).toHaveBeenCalled()
+    })
+
+    it('should move preset names found in options to presets array', () => {
+      section.defineProperty('key2', {
+        description: 'd',
+        presets: [],
+        args: [],
+        options: { preset1: true },
+      })
+      section.initialize()
+      expect(section.get('key2')).toEqual({
+        description: 'd',
+        presets: ['preset1'],
+        args: [],
+        options: {},
+      })
+    })
+  })
+
+  describe('setAll', () => {
+    it('should add defaults preset if missing', () => {
+      const presets = { key: emptyPreset, preset1: section.get('preset1') }
+      section.setAll(presets, false)
+      expect(presets).toEqual({ key: emptyPreset, preset1: section.get('preset1'), defaults })
+    })
+  })
+
+  describe('delete', () => {
+    it('throws if trying to delete builtin presets', () => {
+      expect(() => section.delete('preset1', false)).toThrow()
+    })
+
+    it('does not throw when deleting non-builtin presets', () => {
+      section.set('other', emptyPreset)
+      expect(() => section.delete('other', false)).not.toThrow()
+    })
+  })
+})

package/src/db/PresetsSection.ts

@@ -0,0 +1,92 @@
+import { AbstractJsonFileSection } from './AbstractJsonFileSection'
+import type { IPreset } from '../types/IPreset'
+import { JsonFile } from './JsonFile'
+import { objAssign } from '../util/object/objAssign'
+import type { OptionValues } from '@commander-js/extra-typings'
+
+/**
+ * A class that represents the user-presets section of the JSON file used as simple database.
+ */
+export class PresetsSection extends AbstractJsonFileSection<IPreset> {
+  /**
+   * Creates an instance of AppDataSection.
+   * @param file - The parent JsonFile instance.
+   * @param name - The name of the section.
+   */
+  constructor(file: JsonFile, name: string) {
+    super(file, name, false)
+    this.defineProperty('defaults', {
+      description: 'All presets inherit from this preset',
+      presets: [],
+      args: this.cmd.arguments.map((arg) => arg.defaultValue ?? null),
+      options: this.cmd.getOwnAndGlobalOptions().reduce((acc, opt) => {
+        acc[opt.attributeName()] = opt.defaultValue ?? (opt.isBoolean() ? false : null)
+        return acc
+      }, {} as OptionValues),
+    })
+  }
+
+  /**
+   * Asserts that a key-value pair is valid.
+   * @param key - The key to assert.
+   * @param value - The preset options to validate.
+   */
+  override assertValid(key: string, value: IPreset) {
+    this.cmd.assertValidPreset(key, value)
+  }
+
+  /**
+   * Defines a property for the section.
+   * @param key - The key of the property.
+   * @param options - The options for the property.
+   */
+  override defineProperty(key: string, options: IPreset) {
+    if (this.defaultValues[key]) throw new Error(`Cannot redefine preset '${key}'.`)
+    this.defaultValues[key] = JSON.parse(JSON.stringify(options)) as IPreset
+    this.assertValid(key, options)
+    this.isInitialized = false
+  }
+
+  /**
+   * Initializes the section.
+   * @param save - Indicates whether to save the section after initialization.
+   * @returns A string if an error occurred during initialization, otherwise void.
+   */
+  override initialize(save = false) {
+    if (this.isInitialized) return
+    const data = this.db.getSafe<Record<string, IPreset>>(this.prefix())
+    const presets = objAssign({}, this.defaultValues, data || {})
+    const presetNames = Object.keys(presets)
+    for (const preset of Object.values(presets)) {
+      for (const pname of presetNames) {
+        if (preset.options[pname]) {
+          preset.presets.push(pname)
+          delete preset.options[pname]
+          save = true
+        }
+      }
+    }
+    this.db.set(this.prefix(), presets, save)
+    this.isInitialized = true
+  }
+
+  /**
+   * Sets all the values in the section.
+   * @param values - The values to set.
+   * @param save - Indicates whether to save the section after setting the values.
+   */
+  override async setAll(presets: Record<string, IPreset>, save = true) {
+    if (!presets['defaults']) presets['defaults'] = JSON.parse(JSON.stringify(this.defaultValues['defaults']))
+    super.setAll(presets, save)
+  }
+
+  /**
+   * Deletes the value associated with the specified key.
+   * @param key - The key to delete.
+   * @param save - Indicates whether to save the section after deleting the value.
+   */
+  override delete(name: string, save = true) {
+    if (Object.hasOwn(this.defaultValues, name)) throw new Error('Cannot delete the builtin presets.')
+    super.delete(name, save)
+  }
+}

package/src/index.ts

@@ -0,0 +1,103 @@
+export * from './arg/ArgumentBuilder'
+export * from './arg/ArgumentParserSelector'
+export * from './arg/ArgumentReader'
+export * from './arg/ArgumentValidatorSelector'
+export * from './cmd/asdas'
+export * from './cmd/CLI'
+export * from './cmd/CommandBuilder'
+export * from './cmd/CommandBuilderMetaData'
+export * from './cmd/CommandFeatureSelector'
+export * from './cmd/DefaultHelpConfig'
+export * from './core/OutputManager'
+export * from './core/ParserSelector'
+export * from './core/splitCombinedArgvShorts'
+export * from './core/ValidatorSelector'
+export * from './db/AbstractJsonFileSection'
+export * from './db/AppDataSection'
+export * from './db/ConfigSection'
+export * from './db/JsonFile'
+export * from './db/PresetsSection'
+export * from './opt/OptionArgumentParserSelector'
+export * from './opt/OptionArgumentValidatorSelector'
+export * from './opt/OptionBuilder'
+export * from './opt/OptionHelpers'
+export * from './opt/OptionReader'
+export * from './proto/overrideCommanderPrototype'
+export * from './types/IConfig'
+export * from './types/IPreset'
+export * from './util/array/arrLast'
+export * from './util/array/arrSome'
+export * from './util/array/types/ArrayPredicate'
+export * from './util/db/JsonDB'
+export * from './util/errors/ErrorParser'
+export * from './util/fs/promptUserEditInTextEditor/IGetUserInputFromEditorOptions'
+export * from './util/fs/promptUserEditInTextEditor/promptUserEditInTextEditorSync'
+export * from './util/fs/promptUserEditInTextEditor/promptUserEditJsonInTextEditorSync'
+export * from './util/fs/readFile/readFileSafeSync'
+export * from './util/fs/readFile/readFileSync'
+export * from './util/fs/readJsonFile/readJsonFileSafeSync'
+export * from './util/fs/removeFile/removeFile'
+export * from './util/fs/tempFile/tempFileSync'
+export * from './util/fs/types/IReadJsonFileOptions'
+export * from './util/fs/writeFile/writeFileSafeSync'
+export * from './util/fs/writeFile/writeFileSync'
+export * from './util/fs/writeJsonFile/writeJsonFileSafe'
+export * from './util/function/funSetName'
+export * from './util/function/MethodDisabler'
+export * from './util/node/execInherit'
+export * from './util/node/formatTableForTerminal'
+export * from './util/object/arrAssign'
+export * from './util/object/createArrayMerger'
+export * from './util/object/createObjectMerger'
+export * from './util/object/objAssign'
+export * from './util/object/objUpdatePropertyDescriptors'
+export * from './util/object/realizeLazyProperty'
+export * from './util/object/setNonEnumerable'
+export * from './util/os/defaultOpenInEditorCommand'
+export * from './util/os/isOSX'
+export * from './util/os/isVsCodeInstalled'
+export * from './util/os/isWindows'
+export * from './util/path/getTempDataPath'
+export * from './util/regex/regexEscapeString'
+export * from './util/string/strEnsureStartsWith'
+export * from './util/string/strFirstCharToUpperCase'
+export * from './util/string/strIsLowerCase'
+export * from './util/string/strIsUpperCase'
+export * from './util/string/strSplitCamelCase'
+export * from './util/string-parsers/createBooleanParser'
+export * from './util/string-parsers/createTypedListParser'
+export * from './util/string-parsers/parseBoolean'
+export * from './util/string-parsers/parseInteger'
+export * from './util/string-parsers/parseNumber'
+export * from './util/string-parsers/parseString'
+export * from './util/types/Any'
+export * from './util/types/DeepArray'
+export * from './util/types/DeepObject'
+export * from './util/types/JsonArray'
+export * from './util/types/JsonDefinedPrimitive'
+export * from './util/types/JsonObject'
+export * from './util/types/JsonRawPrimitive'
+export * from './util/types/JsonValue'
+export * from './util/types/ObjectKey'
+export * from './util/types/TConstructor'
+export * from './util/types/TFunction'
+export * from './util/types/TFunctionNoNew'
+export * from './util/types/TPlainObject'
+export * from './util/types/TPrimitive'
+export * from './util/types/TStringParser'
+export * from './util/types/TValidator'
+export * from './util/validation/createTypedArrayValidator'
+export * from './util/validation/ensureThat'
+export * from './util/validation/isArray'
+export * from './util/validation/isBoolean'
+export * from './util/validation/isFunction'
+export * from './util/validation/isNamedFunction'
+export * from './util/validation/isNamedFunctionArray'
+export * from './util/validation/isObject'
+export * from './util/validation/isPlainObject'
+export * from './util/validation/isPrimitive'
+export * from './util/validation/isString'
+export * from './util/validation/isStringArray'
+export * from './util/validation/isStringWithNoSpacesOrDashes'
+export * from './util/validation/numbers/isInteger'
+export * from './util/validation/numbers/isValidNumber'

package/src/opt/OptionArgumentParserSelector.test.ts

@@ -0,0 +1,54 @@
+import { CLI } from '../cmd/CLI'
+import { OptionArgumentParserSelector } from './OptionArgumentParserSelector'
+
+describe(OptionArgumentParserSelector.name, () => {
+  it('should parse string, number, integer', () => {
+    const init = CLI('t', (c) => {
+      c.option('--str <val>', (o) => o.parser.string())
+      c.option('--num <val>', (o) => o.parser.number())
+      c.option('--int <val>', (o) => o.parser.integer())
+      c.action((opts) => {
+        expect(opts.str).toBe('str')
+        expect(opts.num).toBe(3.2)
+        expect(opts.int).toBe(3)
+      })
+    })
+    init().parse('--str str --num 3.2 --int 3'.split(' '), { from: 'user' })
+  })
+
+  it('should parse variadic option', () => {
+    const init = CLI('t', (c) => {
+      c.option('--ints <val...>', (o) => o.parser.integer())
+      c.option('--str <val>', (o) => o.parser.string())
+      c.action((opts) => {
+        expect(opts.ints).toEqual([3, 4, 5])
+      })
+    })
+    init().parse('--ints 3 4 5'.split(' '), { from: 'user' })
+    init().parse('--ints 3 4 5 --str abc'.split(' '), { from: 'user' })
+  })
+
+  it('should parse delimited string, number, integer', () => {
+    const init = CLI('t', (c) => {
+      c.option('--strs <val>', (o) => o.parser.delimitedStrings())
+      c.option('--nums <val>', (o) => o.parser.delimitedNumbers())
+      c.option('--ints <val>', (o) => o.parser.delimitedIntegers())
+      c.action((opts) => {
+        expect(opts.strs).toEqual(['a', 'b'])
+        expect(opts.nums).toEqual([3.1, 4.1])
+        expect(opts.ints).toEqual([3, 4, 5])
+      })
+    })
+    init().parse('--strs a,b --nums 3.1,4.1 --ints 3,4,5'.split(' '), { from: 'user' })
+  })
+
+  it('should parse with custom parser', () => {
+    const init = CLI('t', (c) => {
+      c.option('--chars <val>', (o) => o.parser.custom((s) => s.split('')))
+      c.action((opts) => {
+        expect(opts.chars).toEqual(['a', 'b', 'c'])
+      })
+    })
+    init().parse('--chars abc'.split(' '), { from: 'user' })
+  })
+})

package/src/opt/OptionArgumentParserSelector.ts

@@ -0,0 +1,14 @@
+import { OptionBuilder } from './OptionBuilder'
+import { ParserSelector } from '../core/ParserSelector'
+import type { TStringParser } from '../util/types/TStringParser'
+
+export class OptionArgumentParserSelector extends ParserSelector<OptionBuilder> {
+  constructor(builder: OptionBuilder) {
+    super(builder)
+  }
+  custom<T>(parser: TStringParser<T>) {
+    const name = this.builder.$.attributeName()
+    this.builder.cmd.meta.optParsers[name] = parser
+    return this.builder
+  }
+}

package/src/opt/OptionArgumentValidatorSelector.test.ts

@@ -0,0 +1,90 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+import { CLI } from '../cmd/CLI'
+import { CommandBuilder } from '../cmd/CommandBuilder'
+import { OptionArgumentValidatorSelector } from './OptionArgumentValidatorSelector'
+import { OptionBuilder } from './OptionBuilder'
+import { OutputManager } from '../core/OutputManager'
+
+describe(OptionArgumentValidatorSelector.name, () => {
+  jest.spyOn(process, 'exit').mockImplementation((code?: number) => {
+    throw new Error('process.exit(' + code ?? '' + ') was called')
+  })
+
+  it('should return a OptionArgumentValidatorSelector instance', () => {
+    const arg = new OptionBuilder(new CommandBuilder('t'), '[arg]')
+    expect(arg.validator).toBeInstanceOf(OptionArgumentValidatorSelector)
+  })
+
+  it('should validate string, number, integer', () => {
+    const run = CLI('t', (c) => {
+      c.option('--s <str>', (o) => o.parser.string().validator.isString())
+      c.option('--n <num>', (o) => o.parser.number().validator.isNumber())
+      c.option('--i <int>', (o) => o.parser.integer().validator.isInteger())
+      c.action(() => {})
+    })
+    expect(() => run().parse('--s str --n 3.2 --i 3'.split(' '), { from: 'user' })).not.toThrow()
+  })
+
+  it('should throw if invalid', () => {
+    const run = CLI('t', (c) => {
+      c.throwInsteadOfProcessExit()
+      c.option('--i <int>', (a) => a.parser.number().validator.isInteger())
+      c.action(() => {})
+      c.throwInsteadOfProcessExit()
+    })
+    expect(() => run().parse('--i 3.2'.split(' '), { from: 'user' })).toThrow()
+  })
+
+  it('should validate delimited string, number, integer', () => {
+    const run = CLI('t', (c) => {
+      c.option('--s <strs>', (o) => o.parser.delimitedStrings().validator.isStringArray())
+      c.option('--n <nums>', (o) => o.parser.delimitedNumbers().validator.isNumberArray())
+      c.option('--i <ints>', (o) => o.parser.delimitedIntegers().validator.isIntegerArray())
+      c.action(() => {})
+    })
+    run().parse('--s a,b --n 3.1,4.1 --i 3,4,5'.split(' '), { from: 'user' })
+  })
+
+  it('should validate variadic argument', () => {
+    const init = CLI('t', (c) => {
+      c.option('--i <ints...>', (o) => o.parser.integer().validator.isIntegerArray())
+      c.option('--s <str>', (o) => o.validator.isString())
+      c.action(() => {})
+    })
+    expect(() => init().parse('--i 3 4 5 --s abc'.split(' '), { from: 'user' })).not.toThrow()
+  })
+
+  it('should throw if invalid', () => {
+    const run = CLI('t', (c) => {
+      c.option('--i <ints>', (a) => a.parser.delimitedIntegers().validator.isIntegerArray())
+      c.action(() => {})
+      c.throwInsteadOfProcessExit()
+      OutputManager.getInstance().stderr.disable()
+    })
+    expect(() => run().parse(['--i 3,q,7'], { from: 'user' })).toThrow()
+  })
+
+  it('should validate with custom validator', () => {
+    const run = CLI('t', (c) => {
+      c.option('--a <arg>', (a) => a.validator.custom((arg) => arg === 'abc'))
+      c.action(() => {})
+      c.throwInsteadOfProcessExit()
+    })
+    expect(() => run().parse('--a ab'.split(' '), { from: 'user' })).toThrow()
+  })
+
+  it('should validate with multiple validators', () => {
+    const run = CLI('t', (c) => {
+      c.option('--a <arg>', (a) => {
+        a.validator.custom((arg: string) => arg !== 'abc')
+        a.validator.custom((arg: string) => arg.length >= 3)
+      })
+      c.action(() => {})
+      c.throwInsteadOfProcessExit()
+    })
+    expect(() => run().parse('--a ab'.split(' '), { from: 'user' })).toThrow()
+    expect(() => run().parse('--a abc'.split(' '), { from: 'user' })).toThrow()
+    expect(() => run().parse('--a abcd'.split(' '), { from: 'user' })).not.toThrow()
+  })
+})

package/src/opt/OptionArgumentValidatorSelector.ts

@@ -0,0 +1,16 @@
+import { OptionBuilder } from './OptionBuilder'
+import type { TValidator } from '../util/types/TValidator'
+import { ValidatorSelector } from '../core/ValidatorSelector'
+
+export class OptionArgumentValidatorSelector extends ValidatorSelector<OptionBuilder> {
+  constructor(builder: OptionBuilder) {
+    super(builder)
+  }
+  custom<T>(validator: TValidator<T>) {
+    const name = this.builder.$.attributeName()
+    const obj = this.builder.cmd.meta.optValidators
+    if (!obj[name]) obj[name] = []
+    obj[name].push(validator)
+    return this.builder
+  }
+}