Rewrite Valibot with the pipe function

.github/actions/pnpm/action.yml

@@ -4,12 +4,12 @@ runs:
   using: 'composite'
   steps:
     - name: Install Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
 
     - name: Install pnpm
-      uses: pnpm/action-setup@v2
+      uses: pnpm/action-setup@v3
       id: pnpm-install
       with:
         version: 8
@@ -22,7 +22,7 @@ runs:
         echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
 
     - name: Setup pnpm cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.STORE_PATH }}
         key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup pnpm
         uses: ./.github/actions/pnpm
 
@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup pnpm
         uses: ./.github/actions/pnpm
       - name: Prettier check
@@ -34,7 +34,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup pnpm
         uses: ./.github/actions/pnpm
       - name: ESLint check
@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup pnpm
         uses: ./.github/actions/pnpm
       - name: Vitest tests
@@ -60,7 +60,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup pnpm
         uses: ./.github/actions/pnpm
       - name: Prettier check
@@ -73,7 +73,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup pnpm
         uses: ./.github/actions/pnpm
       - name: ESLint check

README.md

@@ -27,22 +27,22 @@ First you create a schema that describes a structured data set. A schema can be
 
 <!-- prettier-ignore -->
 ```ts
-import { email, minLength, object, type Output, parse, string } from 'valibot'; // 1.54 kB
+import * as v from 'valibot'; // 1.21 kB
 
 // Create login schema with email and password
-const LoginSchema = object({
-  email: string([email()]),
-  password: string([minLength(8)]),
+const LoginSchema = v.object({
+  email: v.pipe(v.string(), v.email()),
+  password: v.pipe(v.string(), v.minLength(8)),
 });
 
 // Infer output TypeScript type of login schema
-type LoginData = Output<typeof LoginSchema>; // { email: string; password: string }
+type LoginData = v.InferOutput<typeof LoginSchema>; // { email: string; password: string }
 
 // Throws error for `email` and `password`
-parse(LoginSchema, { email: '', password: '' });
+v.parse(LoginSchema, { email: '', password: '' });
 
 // Returns data as { email: string; password: string }
-parse(LoginSchema, { email: '[email protected]', password: '12345678' });
+v.parse(LoginSchema, { email: '[email protected]', password: '12345678' });
 ```
 
 Apart from `parse` I also offer a non-exception-based API with `safeParse` and a type guard function with `is`. You can read more about it [here](https://valibot.dev/guides/parse-data/).

library/.eslintrc.cjs

@@ -6,48 +6,19 @@ module.exports = {
     'plugin:@typescript-eslint/recommended',
     'plugin:jsdoc/recommended-typescript-error',
     'plugin:regexp/recommended',
-    'plugin:security/recommended',
+    'plugin:security/recommended-legacy',
   ],
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint', 'import', 'redos-detector'],
   rules: {
     // Enable rules -----------------------------------------------------------
 
-    // Import
-    'import/extensions': ['error', 'always'], // Require file extensions
-
-    // Regexp
-    'regexp/no-super-linear-move': 'error', // Prevent DoS regexps
-    'regexp/no-control-character': 'error', // Avoid unneeded regexps characters
-    'regexp/no-octal': 'error', // Avoid unneeded regexps characters
-    'regexp/no-standalone-backslash': 'error', // Avoid unneeded regexps characters
-    'regexp/prefer-escape-replacement-dollar-char': 'error', // Avoid unneeded regexps characters
-    'regexp/prefer-quantifier': 'error', // Avoid unneeded regexps characters
-    'regexp/hexadecimal-escape': ['error', 'always'], // Avoid unneeded regexps characters
-    'regexp/sort-alternatives': 'error', // Avoid unneeded regexps characters
-    'regexp/require-unicode-regexp': 'error', // /u flag is faster and enables regexp strict mode
-    'regexp/prefer-regexp-exec': 'error', // Enforce that RegExp#exec is used instead of String#match if no global flag is provided, as exec is faster
-
     // TypeScript
     '@typescript-eslint/consistent-type-definitions': 'error', // Enforce declaring types using `interface` keyword for better TS performance.
-
-    // Redos detector
-    'redos-detector/no-unsafe-regex': ['error', { ignoreError: true }], // Prevent DoS regexps
-
-    // Disable rules ----------------------------------------------------------
-
-    // Default
-    'no-duplicate-imports': 'off',
-
-    // TypeScript
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/consistent-type-imports': 'warn',
-    '@typescript-eslint/no-non-null-assertion': 'off',
 
-    // Imports
-    'no-duplicate-imports': 'off',
-    'import/extensions': ['error', 'always'],
+    // Import
+    'import/extensions': ['error', 'always'], // Require file extensions
 
     // JSDoc
     'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
@@ -77,6 +48,30 @@ module.exports = {
       },
     ],
 
+    // Regexp
+    'regexp/no-super-linear-move': 'error', // Prevent DoS regexps
+    'regexp/no-control-character': 'error', // Avoid unneeded regexps characters
+    'regexp/no-octal': 'error', // Avoid unneeded regexps characters
+    'regexp/no-standalone-backslash': 'error', // Avoid unneeded regexps characters
+    'regexp/prefer-escape-replacement-dollar-char': 'error', // Avoid unneeded regexps characters
+    'regexp/prefer-quantifier': 'error', // Avoid unneeded regexps characters
+    'regexp/hexadecimal-escape': ['error', 'always'], // Avoid unneeded regexps characters
+    'regexp/sort-alternatives': 'error', // Avoid unneeded regexps characters
+    'regexp/require-unicode-regexp': 'error', // /u flag is faster and enables regexp strict mode
+    'regexp/prefer-regexp-exec': 'error', // Enforce that RegExp#exec is used instead of String#match if no global flag is provided, as exec is faster
+
+    // Redos detector
+    'redos-detector/no-unsafe-regex': ['error', { ignoreError: true }], // Prevent DoS regexps
+
+    // Disable rules ----------------------------------------------------------
+
+    // TypeScript
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+
+    // Imports
+    'no-duplicate-imports': 'off',
+
     // Security
     'security/detect-object-injection': 'off', // Too many false positives
     'security/detect-unsafe-regex': 'off', // Too many false positives, see https://github.com/eslint-community/eslint-plugin-security/issues/28 - we use the redos-detector plugin instead

library/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## v0.31.0 (Month DD, YYYY)
+
+- More details will follow soon
+
 ## v0.30.0 (March 06, 2024)
 
 - Add `Default` and `DefaultAsync` type and refactor codebase

library/README.md

@@ -27,22 +27,22 @@ First you create a schema that describes a structured data set. A schema can be
 
 <!-- prettier-ignore -->
 ```ts
-import { email, minLength, object, type Output, parse, string } from 'valibot'; // 1.54 kB
+import * as v from 'valibot'; // 1.21 kB
 
 // Create login schema with email and password
-const LoginSchema = object({
-  email: string([email()]),
-  password: string([minLength(8)]),
+const LoginSchema = v.object({
+  email: v.pipe(v.string(), v.email()),
+  password: v.pipe(v.string(), v.minLength(8)),
 });
 
 // Infer output TypeScript type of login schema
-type LoginData = Output<typeof LoginSchema>; // { email: string; password: string }
+type LoginData = v.InferOutput<typeof LoginSchema>; // { email: string; password: string }
 
 // Throws error for `email` and `password`
-parse(LoginSchema, { email: '', password: '' });
+v.parse(LoginSchema, { email: '', password: '' });
 
 // Returns data as { email: string; password: string }
-parse(LoginSchema, { email: '[email protected]', password: '12345678' });
+v.parse(LoginSchema, { email: '[email protected]', password: '12345678' });
 ```
 
 Apart from `parse` I also offer a non-exception-based API with `safeParse` and a type guard function with `is`. You can read more about it [here](https://valibot.dev/guides/parse-data/).

library/jsr.json

@@ -1,5 +1,5 @@
 {
   "name": "@valibot/valibot",
-  "version": "0.30.0",
+  "version": "0.31.0-rc.0",
   "exports": "./src/index.ts"
 }

library/package.json

@@ -1,7 +1,7 @@
 {
   "name": "valibot",
-  "description": "The modular and TypeScript-first schema library",
-  "version": "0.30.0",
+  "description": "The modular and type safe schema library for validating structural data",
+  "version": "0.31.0-rc.0",
   "license": "MIT",
   "author": "Fabian Hiller",
   "homepage": "https://valibot.dev",
@@ -43,7 +43,7 @@
   },
   "scripts": {
     "play": "tsm ./playground.ts",
-    "test": "vitest",
+    "test": "vitest --typecheck",
     "coverage": "vitest run --coverage --isolate",
     "lint": "eslint \"src/**/*.ts*\" && tsc --noEmit",
     "eslint.fix": "eslint \"src/**/*.ts*\" --fix",
@@ -53,21 +53,21 @@
     "publish": "npm publish && npx jsr publish"
   },
   "devDependencies": {
-    "@types/eslint": "^8.40.2",
-    "@typescript-eslint/eslint-plugin": "^5.60.0",
-    "@typescript-eslint/parser": "^5.60.0",
-    "@vitest/coverage-v8": "^0.33.0",
-    "eslint": "^8.43.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jsdoc": "^46.8.2",
-    "eslint-plugin-redos-detector": "^2.1.1",
-    "eslint-plugin-regexp": "^1.15.0",
-    "eslint-plugin-security": "^1.7.1",
-    "jsdom": "^22.1.0",
+    "@types/eslint": "^8.56.7",
+    "@typescript-eslint/eslint-plugin": "^7.5.0",
+    "@typescript-eslint/parser": "^7.5.0",
+    "@vitest/coverage-v8": "^1.4.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.2.2",
+    "eslint-plugin-redos-detector": "^2.4.0",
+    "eslint-plugin-regexp": "^2.4.0",
+    "eslint-plugin-security": "^2.1.1",
+    "jsdom": "^24.0.0",
     "tsm": "^2.3.0",
-    "tsup": "^8.0.1",
-    "typescript": "^5.3.3",
-    "vite": "^4.4.6",
-    "vitest": "^0.33.0"
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.3",
+    "vite": "^5.2.7",
+    "vitest": "1.4.0"
   }
 }

library/src/actions/bic/bic.test-d.ts

@@ -0,0 +1,41 @@
+import { describe, expectTypeOf, test } from 'vitest';
+import type { InferInput, InferIssue, InferOutput } from '../../types/index.ts';
+import { bic, type BicAction, type BicIssue } from './bic.ts';
+
+describe('bic', () => {
+  describe('should return action object', () => {
+    test('with undefined message', () => {
+      type Action = BicAction<string, undefined>;
+      expectTypeOf(bic<string>()).toEqualTypeOf<Action>();
+      expectTypeOf(bic<string, undefined>(undefined)).toEqualTypeOf<Action>();
+    });
+
+    test('with string message', () => {
+      expectTypeOf(bic<string, 'message'>('message')).toEqualTypeOf<
+        BicAction<string, 'message'>
+      >();
+    });
+
+    test('with function message', () => {
+      expectTypeOf(bic<string, () => string>(() => 'message')).toEqualTypeOf<
+        BicAction<string, () => string>
+      >();
+    });
+  });
+
+  describe('should infer correct types', () => {
+    type Action = BicAction<string, undefined>;
+
+    test('of input', () => {
+      expectTypeOf<InferInput<Action>>().toEqualTypeOf<string>();
+    });
+
+    test('of output', () => {
+      expectTypeOf<InferOutput<Action>>().toEqualTypeOf<string>();
+    });
+
+    test('of issue', () => {
+      expectTypeOf<InferIssue<Action>>().toEqualTypeOf<BicIssue<string>>();
+    });
+  });
+});