changelog.md

@@ -2,6 +2,9 @@
 
 - Add `validOptions` config option, to specify a discrete set of
   acceptable values.
+- `validate` methods now take an `unknown` argument, which is
+  more appropriate than `any` as it encourages more deliberate
+  type assertions.
 
 # 3.0
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jackspeak",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "description": "A very strict and proper argument parser.",
   "tshy": {
     "main": true,

src/index.ts

@@ -95,14 +95,14 @@ export type ConfigOptionMeta<
   O extends
     | undefined
     | (T extends 'boolean' ? never
-      : T extends 'string' ? string[]
-      : T extends 'number' ? number[]
-      : number[] | string[]) =
+      : T extends 'string' ? readonly string[]
+      : T extends 'number' ? readonly number[]
+      : readonly number[] | readonly string[]) =
     | undefined
     | (T extends 'boolean' ? never
-      : T extends 'string' ? string[]
-      : T extends 'number' ? number[]
-      : number[] | string[]),
+      : T extends 'string' ? readonly string[]
+      : T extends 'number' ? readonly number[]
+      : readonly number[] | readonly string[]),
 > = {
   default?:
     | undefined
@@ -129,7 +129,10 @@ export type ConfigOptionMeta<
  * A set of {@link ConfigOptionMeta} fields, referenced by their longOption
  * string values.
  */
-export type ConfigMetaSet<T extends ConfigType, M extends boolean = boolean> = {
+export type ConfigMetaSet<
+  T extends ConfigType,
+  M extends boolean = boolean,
+> = {
   [longOption: string]: ConfigOptionMeta<T, M>
 }
 
@@ -263,7 +266,9 @@ export type ConfigSet = {
  * The 'values' field returned by {@link Jack#parse}
  */
 export type OptionsResults<T extends ConfigSet> = {
-  [k in keyof T]?: T[k]['validOptions'] extends string[] | number[] ?
+  [k in keyof T]?: T[k]['validOptions'] extends (
+    readonly string[] | readonly number[]
+  ) ?
     T[k] extends ConfigOptionBase<'string' | 'number', false> ?
       T[k]['validOptions'][number]
     : T[k] extends ConfigOptionBase<'string' | 'number', true> ?

test/basic.ts

@@ -381,21 +381,21 @@ t.test('validate against options', t => {
   }).addFields({
     'vo-opt': {
       type: 'string',
-      validOptions: ['x', 'y'],
+      validOptions: ['x', 'y'] as const,
     },
     'vo-optlist': {
       type: 'string',
       multiple: true,
-      validOptions: ['x', 'y'],
+      validOptions: ['x', 'y'] as const,
     },
     'vo-num': {
       type: 'number',
-      validOptions: [1, 2],
+      validOptions: [1, 2] as const,
     },
     'vo-numlist': {
       type: 'number',
       multiple: true,
-      validOptions: [1, 2],
+      validOptions: [1, 2] as const,
     },
   })
   t.throws(() => j.validate({ 'vo-opt': 'a' }))
@@ -466,6 +466,10 @@ t.test('validate against options', t => {
     },
   })
 
+  const v = j.parse([]).values
+  //@ts-expect-error
+  v['vo-opt'] = 'a'
+
   t.matchSnapshot(j.usage())
   t.end()
 })