Merge pull request #28 from lydell/updates

Author: lydell

.eslintrc.js

@@ -5,7 +5,7 @@ const warn = process.argv.includes("--report-unused-disable-directives")
 
 module.exports = {
   root: true,
-  plugins: ["@typescript-eslint", "simple-import-sort", "jest"],
+  plugins: ["@typescript-eslint", "simple-import-sort", "vitest"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
     sourceType: "module",
@@ -44,7 +44,7 @@ module.exports = {
     "@typescript-eslint/no-base-to-string": error,
     "@typescript-eslint/no-confusing-void-expression": error,
     "@typescript-eslint/no-dupe-class-members": error,
-    "@typescript-eslint/no-duplicate-imports": warn,
+    "@typescript-eslint/no-duplicate-type-constituents": error,
     "@typescript-eslint/no-empty-function": warn,
     "@typescript-eslint/no-empty-interface": warn,
     "@typescript-eslint/no-explicit-any": warn,
@@ -104,7 +104,7 @@ module.exports = {
     "@typescript-eslint/restrict-plus-operands": error,
     "@typescript-eslint/restrict-template-expressions": error,
     "@typescript-eslint/return-await": error,
-    "@typescript-eslint/sort-type-union-intersection-members": warn,
+    "@typescript-eslint/sort-type-constituents": warn,
     "@typescript-eslint/strict-boolean-expressions": [
       error,
       {
@@ -202,15 +202,15 @@ module.exports = {
     },
     {
       files: "tests/**/*.ts",
-      extends: ["plugin:jest/recommended", "plugin:jest/style"],
+      extends: "plugin:vitest/recommended",
       parserOptions: {
         tsconfigRootDir: __dirname,
         project: ["./tests/tsconfig.json"],
       },
     },
     {
       files: "examples/**/*.ts",
-      extends: ["plugin:jest/recommended", "plugin:jest/style"],
+      extends: "plugin:vitest/recommended",
       parserOptions: {
         tsconfigRootDir: __dirname,
         project: ["./examples/tsconfig.json"],

.github/workflows/check.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node-version: [18.x]
+        node-version: [20.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -22,19 +22,15 @@ jobs:
         with:
           node-version: "${{ matrix.node-version }}"
 
-      - name: Cache node_modules
-        id: cache-node_modules
+      - id: cache-node_modules
         uses: actions/cache@v3
         with:
           path: node_modules
           key: node_modules-${{ matrix.os }}-${{ matrix.node-version }}-${{ hashFiles('package.json', 'package-lock.json') }}
 
-      - name: npm ci
-        if: steps.cache-node_modules.outputs.cache-hit != 'true'
-        run: npm ci
+      - if: steps.cache-node_modules.outputs.cache-hit != 'true'
+        run: npm ci --no-audit
 
-      - name: ESLint
-        run: npx eslint --report-unused-disable-directives .
+      - run: npx eslint --report-unused-disable-directives .
 
-      - name: Prettier
-        run: npx prettier --check .
+      - run: npx prettier --check .

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -22,19 +22,15 @@ jobs:
         with:
           node-version: "${{ matrix.node-version }}"
 
-      - name: Cache node_modules
-        id: cache-node_modules
+      - id: cache-node_modules
         uses: actions/cache@v3
         with:
           path: node_modules
           key: node_modules-${{ matrix.os }}-${{ matrix.node-version }}-${{ hashFiles('package.json', 'package-lock.json') }}
 
-      - name: npm ci
-        if: steps.cache-node_modules.outputs.cache-hit != 'true'
-        run: npm ci
+      - if: steps.cache-node_modules.outputs.cache-hit != 'true'
+        run: npm ci --no-audit
 
-      - name: Jest
-        run: npx jest --coverage
+      - run: npx vitest
 
-      - name: Build
-        run: npm run build
+      - run: npm run build

README.md

@@ -44,7 +44,7 @@ const userDecoder = fields(
     active: field("is_active", boolean),
     age: field("age", optional(number)),
     interests: field("interests", array(string)),
-  })
+  }),
 );
 
 const payload: unknown = getSomeJSON();
@@ -299,7 +299,7 @@ Decodes a JSON string into a TypeScript `string`.
 
 ```ts
 function stringUnion<T extends [string, ...Array<string>]>(
-  variants: T
+  variants: T,
 ): Decoder<T[number]>;
 ```
 
@@ -347,15 +347,15 @@ For example, `record(number)` decodes an object where the keys can be anything a
 function fields<T>(
   callback: (
     field: <U>(key: string, decoder: Decoder<U>) => U,
-    object: Record<string, unknown>
+    object: Record<string, unknown>,
   ) => T,
   {
     exact = "allow extra",
     allow = "object",
   }: {
     exact?: "allow extra" | "throw";
     allow?: "array" | "object";
-  } = {}
+  } = {},
 ): Decoder<T>;
 ```
 
@@ -386,7 +386,7 @@ const userDecoder = fields(
     description: field("description", optional(string)),
     // Hardcoded field:
     version: 1,
-  })
+  }),
 );
 
 // Plucking a single field out of an object:
@@ -460,7 +460,7 @@ type Values<T> = T[keyof T];
 
 function fieldsUnion<T extends Record<string, Decoder<unknown>>>(
   key: string,
-  mapping: T
+  mapping: T,
 ): Decoder<
   Values<{ [P in keyof T]: T[P] extends Decoder<infer U, infer _> ? U : never }>
 >;
@@ -498,7 +498,7 @@ See also the [renaming union field example](examples/renaming-union-field.test.t
 
 ```ts
 function tuple<T extends Array<unknown>>(
-  mapping: readonly [...{ [P in keyof T]: Decoder<T[P]> }]
+  mapping: readonly [...{ [P in keyof T]: Decoder<T[P]> }],
 ): Decoder<[...T]>;
 ```
 
@@ -524,7 +524,7 @@ function multi<
   T4 = never,
   T5 = never,
   T6 = never,
-  T7 = never
+  T7 = never,
 >(mapping: {
   undefined?: Decoder<T1, undefined>;
   null?: Decoder<T2, null>;
@@ -590,7 +590,7 @@ Example:
 ```ts
 const numberSetDecoder: Decoder<Set<number>> = chain(
   array(number),
-  (arr) => new Set(arr)
+  (arr) => new Set(arr),
 );
 ```
 
@@ -658,7 +658,7 @@ class DecoderError extends TypeError {
   constructor(
     params:
       | { message: string; value: unknown; key?: Key }
-      | (DecoderErrorVariant & { key?: Key })
+      | (DecoderErrorVariant & { key?: Key }),
   );
 
   static MISSING_VALUE: symbol;
@@ -714,7 +714,7 @@ const decoder: Decoder<Array<[RegExp, number]>> = Decode.chain(
       } catch (error) {
         throw Decode.DecoderError.at(error, key);
       }
-    })
+    }),
 );
 ```
 
@@ -752,7 +752,7 @@ function repr(
     maxLength = 100,
     recurseMaxLength = 20,
     sensitive = false,
-  }: ReprOptions = {}
+  }: ReprOptions = {},
 ): string;
 ```
 
@@ -819,7 +819,7 @@ const personDecoder = fields(
   (field): Person => ({
     name: field("name", string),
     age: field("age", optional(number)),
-  })
+  }),
 );
 
 // Annotate the generic.
@@ -897,7 +897,7 @@ This decoder would ignore its input and always “succeed” with a given value.
 ```ts
 export function either<T, U>(
   decoder1: Decoder<T>,
-  decoder2: Decoder<U>
+  decoder2: Decoder<U>,
 ): Decoder<T | U>;
 ```
 

examples/chain.test.ts

@@ -1,3 +1,5 @@
+import { expect, test } from "vitest";
+
 import {
   array,
   chain,
@@ -60,7 +62,7 @@ test("decoding to a Set", () => {
     id: field("id", string),
     numbers: field(
       "numbers",
-      optional(chain(array(number), (arr) => new Set(arr)))
+      optional(chain(array(number), (arr) => new Set(arr))),
     ),
   }));
   expect(objDecoder2(obj)).toEqual(objDecoder1(obj));

examples/extra-fields.test.ts

@@ -1,3 +1,5 @@
+import { expect, test } from "vitest";
+
 import { chain, Decoder, fields, fieldsAuto, number, string } from "..";
 
 test("adding extra fields to records", () => {
@@ -17,7 +19,7 @@ test("adding extra fields to records", () => {
       name: field("name", string),
       price: field("price", number),
       version: 1,
-    })
+    }),
   );
 
   expect(productDecoder1(data)).toMatchInlineSnapshot(`
@@ -58,7 +60,7 @@ test("adding extra fields to records", () => {
       name: string,
       price: number,
     }),
-    (props) => ({ ...props, version: 1 })
+    (props) => ({ ...props, version: 1 }),
   );
 
   expect(productDecoder4(data)).toEqual(productDecoder3(data));

examples/readme.test.ts

@@ -1,3 +1,5 @@
+import { expect, test } from "vitest";
+
 import {
   array,
   boolean,
@@ -15,7 +17,7 @@ import {
 function run<T>(
   decoder: Decoder<T>,
   value: unknown,
-  options?: ReprOptions
+  options?: ReprOptions,
 ): T | string {
   try {
     return decoder(value);
@@ -47,7 +49,7 @@ test("the main readme example", () => {
       active: field("is_active", boolean),
       age: field("age", optional(number)),
       interests: field("interests", array(string)),
-    })
+    }),
   );
 
   const payload: unknown = getSomeJSON();
@@ -186,7 +188,7 @@ test("fields", () => {
       description: field("description", optional(string)),
       // Hardcoded field:
       version: 1,
-    })
+    }),
   );
 
   expect(
@@ -195,7 +197,7 @@ test("fields", () => {
       is_active: true,
       first_name: "John",
       last_name: "Doe",
-    })
+    }),
   ).toStrictEqual({
     active: true,
     age: 30,
@@ -221,7 +223,7 @@ test("type annotations", () => {
     (field): Person => ({
       name: field("name", string),
       age: field("age", optional(number)),
-    })
+    }),
   );
 
   // Annotate the generic.

examples/recursive.test.ts

@@ -1,3 +1,5 @@
+import { expect, test, vi } from "vitest";
+
 import { array, Decoder, fields, multi, record, string } from "../";
 
 test("recursive data structure", () => {
@@ -12,7 +14,7 @@ test("recursive data structure", () => {
     (field): Person => ({
       name: field("name", string),
       friends: field("friends", array(personDecoder1)),
-    })
+    }),
   );
 
   // But when using `fieldsAuto` you’d run into problems.
@@ -78,7 +80,7 @@ test("recurse non-record", () => {
       object: (value) => dictDecoder(value),
       // Writing just `object: dictDecoder` would result in an error:
       // ReferenceError: Cannot access 'dictDecoder' before initialization
-    })
+    }),
   );
 
   const data: unknown = {
@@ -120,7 +122,7 @@ test("circular objects", () => {
     (field): Person => ({
       name: field("name", string),
       likes: field("likes", personDecoder),
-    })
+    }),
   );
 
   const alice: Record<string, unknown> = {
@@ -138,8 +140,8 @@ test("circular objects", () => {
 
   // Calling the decoder would cause infinite recursion!
   // So be careful when working with recursive data!
-  const wouldCauseInfiniteRecursion1: () => Person = jest.fn(() =>
-    personDecoder(alice)
+  const wouldCauseInfiniteRecursion1: () => Person = vi.fn(() =>
+    personDecoder(alice),
   );
 
   expect(wouldCauseInfiniteRecursion1).not.toHaveBeenCalled();