Merge pull request #1 from notanengineercom/improve-dx-contribution-and-usage

Improve DX for contributions and usage

Author: notanengineercom

.github/workflows/ci.yml

@@ -1,54 +1,59 @@
 name: CI
 
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
+on: [push]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
+        node-version: [18.x, 20.x, 22.x, 24.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+      with:
+        show-progress: false
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - name: Cache node dependencies
-      id: cache-node_modules
-      uses: actions/cache@v2
-      with:
-        path: node_modules
-        key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+        cache: 'npm'
     - name: Install dependencies
-      if: steps.cache-node_modules.outputs.cache-hit != 'true'
       run: npm ci
     - run: npm run build
 
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        show-progress: false
+    - name: Use Node.js 24
+      uses: actions/setup-node@v4
+      with:
+        node-version: 24
+        cache: 'npm'
+    - name: Install dependencies
+      run: npm ci
+    - run: npm run lint
+
   test:
+    needs: lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
+        node-version: [18.x, 20.x, 22.x, 24.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+      with:
+        show-progress: false
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - name: Cache node dependencies
-      id: cache-node_modules
-      uses: actions/cache@v2
-      with:
-        path: node_modules
-        key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+        cache: 'npm'
     - name: Install dependencies
-      if: steps.cache-node_modules.outputs.cache-hit != 'true'
       run: npm ci
     - run: npm test

.husky/pre-commit

@@ -0,0 +1,2 @@
+npm run lint
+npm test

.oxlintrc.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": [
+    "unicorn",
+    "typescript",
+    "oxc",
+    "import",
+    "node",
+    "promise"
+  ],
+  "rules": {
+    "oxc/no-accumulating-spread": "error",
+    "unicorn/prefer-array-find": "error",
+    "unicorn/prefer-array-flat-map": "error",
+    "unicorn/prefer-set-has": "warn",
+    "eslint/default-case": "warn",
+    "eslint/no-bitwise": "warn",
+    "eslint/no-console": "warn",
+    "eslint/no-empty": "error",
+    "eslint/no-empty-function": "error",
+    "eslint/no-eq-null": "error",
+    "eslint/no-unused-expressions": "error",
+    "eslint/no-var": "error",
+    "eslint/eqeqeq": "error",
+    "import/no-cycle": "error",
+    "import/exports-last": "error",
+    "import/first": "error",
+    "import/group-exports": "error",
+    "import/no-duplicates": "error",
+    "promise/catch-or-return": "error",
+    "typescript/explicit-module-boundary-types": "error",
+    "typescript/consistent-type-imports": "warn"
+  }
+}