🐎 ci: Add CI workflow for type checking, linting, and testing

Author: Snowflyt

.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Typecheck
+        run: npm run typecheck
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Test types
+        run: npm run test-types
+
+      - name: Test
+        run: npm run test:cov
+
+      - name: Report Coveralls
+        run: curl -sL https://coveralls.io/coveralls-linux.tar.gz | tar -xz && ./coveralls
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -15,13 +15,13 @@ Handle side effects in a <strong>unified</strong> way, with <strong>type-safety<
   <a href="https://bundlephobia.com/package/tinyeffect">
     <img src="https://img.shields.io/bundlephobia/minzip/tinyeffect.svg" alt="minzipped size" height="18">
   </a>
-  <a href="https://github.com/Snowflyt/tinyeffect/actions/workflows/test.yml">
-    <img src="https://github.com/Snowflyt/tinyeffect/actions/workflows/test.yml/badge.svg" alt="test status" height="18">
+  <a href="https://github.com/Snowflyt/tinyeffect/actions/workflows/ci.yml">
+    <img src="https://img.shields.io/github/actions/workflow/status/Snowflyt/tinyeffect/ci.yml?label=test" alt="test status" height="18">
   </a>
   <a href="https://coveralls.io/github/Snowflyt/tinyeffect?branch=main">
     <img src="https://coveralls.io/repos/github/Snowflyt/tinyeffect/badge.svg?branch=main" alt="coverage status" height="18">
   </a>
-  <a href="https://github.com/gvergnaud/tinyeffect">
+  <a href="https://github.com/Snowflyt/tinyeffect">
     <img src="https://img.shields.io/npm/l/tinyeffect.svg" alt="MIT license" height="18">
   </a>
 </p>

README.md

@@ -38,11 +38,12 @@
     "lint:fix": "eslint --fix **/*.{js,ts} *.{cjs,mjs,cts,mts} --no-error-on-unmatched-pattern --report-unused-disable-directives-severity error --max-warnings 0",
     "prepare": "node -e \"import fs from 'fs'; import path from 'path'; const hooksDir = path.join(process.cwd(), '.githooks'); const gitHooksDir = path.join(process.cwd(), '.git/hooks'); if (!fs.existsSync(gitHooksDir)) { console.error('Git hooks directory not found, please run this in a git repository.'); process.exit(1); } fs.readdirSync(hooksDir).forEach(file => { const srcFile = path.join(hooksDir, file); const destFile = path.join(gitHooksDir, file); fs.copyFileSync(srcFile, destFile); if (process.platform !== 'win32' && !file.endsWith('.cmd')) { fs.chmodSync(destFile, 0o755); } })\"",
     "test": "vitest run",
+    "test-types": "typroof",
     "test:cov": "vitest run --coverage --coverage.include \"src/**/!(*.proof).{js,ts}\"",
     "test:ui": "vitest --ui --coverage.enabled=true --coverage.include \"src/**/!(*.proof).{js,ts}\"",
     "test:watch": "vitest",
     "test:watch-cov": "vitest --coverage --coverage.include \"src/**/!(*.proof).{js,ts}\"",
-    "test-types": "typroof"
+    "typecheck": "tsc --noEmit --composite false -p tsconfig.build.json && tsc --noEmit --composite false -p tsconfig.test.json"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.0",

package.json

@@ -0,0 +1,13 @@
+// Fix TypeScript’s complaint about missing types
+
+// For Vitest
+// See: https://github.com/vitejs/vite/issues/9813
+declare interface Worker {}
+declare interface WebSocket {}
+
+declare namespace WebAssembly {
+  interface Module {}
+}
+
+// For Effect
+declare interface QueuingStrategy<T> {}