Add support for bun (#4)

Author: blakeembrey

.github/workflows/ci-bun.yml

@@ -0,0 +1,18 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Bun.js
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: oven-sh/setup-bun@v1
+      - run: bun install
+      - run: bun run check
+      - run: bun test --coverage
+      - run: bun run build
+      - uses: codecov/codecov-action@v1
+        with:
+          name: Bun.js

.github/workflows/ci.yml .github/workflows/ci-node.yml.github/workflows/ci.yml renamed to .github/workflows/ci-node.yml

@@ -4,6 +4,8 @@ on:
   - pull_request
 jobs:
   test:
+    env:
+      BIN_EXEC: tsx
     name: Node.js ${{ matrix.node-version }}
     runs-on: ubuntu-latest
     strategy:
@@ -12,7 +14,7 @@ jobs:
           - "14"
           - "*"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
@@ -22,9 +24,10 @@ jobs:
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
-      - run: npm install -g npm@7
       - run: npm ci
-      - run: npm test
+      - run: npm run check
+      - run: npm run specs --coverage
+      - run: npm run build
       - uses: codecov/codecov-action@v1
         with:
           name: Node.js ${{ matrix.node-version }}

.gitignore

@@ -4,3 +4,4 @@ coverage/
 npm-debug.log
 dist/
 dist.es2015/
+bun.lockb

README.md

@@ -20,23 +20,23 @@ In your `package.json` you can use the scripts:
 ```json
 {
   "scripts": {
-    "lint": "ts-scripts lint",
     "format": "ts-scripts format",
     "specs": "ts-scripts specs",
-    "test": "ts-scripts test",
+    "test": "ts-scripts test", // Runs `check`, `specs --coverage`, `build`.
     "build": "ts-scripts build",
     "prepublishOnly": "npm run build",
     "prepare": "ts-scripts install"
   }
 }
 ```
 
-You will also need to install `typescript` for building and `vitest` for testing.
+You will also need to install `typescript` for building and `vitest` for specs.
+
+**Note:** If using `bun`, you don't need `vitest`. You can use `bun test` instead.
 
 ### Batteries Included
 
 - `install` - Installs `husky` and `lint-staged` for git commit hooks
-- `lint` - Uses `eslint --fix` on all supported files in `src` (i.e. `js`, `jsx`, `ts`, `tsx`)
 - `format` - Uses `prettier --write` on all supported files in `src` and the root directory
 - `specs` - Uses `vitest` to run test files match `*.{test,spec}.*` files
   - `--watch <index>` Runs vitest in watch mode on the config at `<index>`
@@ -45,15 +45,15 @@ You will also need to install `typescript` for building and `vitest` for testing
   - `--since <commit>` Runs tests on files changed since `<commit>`
   - `--test-pattern` Runs tests matching the specified pattern
 - `build` - Uses `rimraf` and `tsc`
-- `check` - Uses `eslint`, `prettier --check`, and `tsc` on each test "project"
+- `check` - Uses `prettier --check` and `tsc` on each test "project"
 - `test` - Runs `check`, `specs`, and `build`
 
 ### Configuration
 
 Configuration can get specified in your `package.json` file under `ts-scripts`:
 
-- `src` - An array of source directories used for `format` and `lint` (default: `["src"]`)
-- `ignore` - An array of patterns to ignore for `format` and `lint` (default: `[]`)
+- `src` - An array of source file directories (default: `["src"]`)
+- `ignore` - An array of patterns to ignore (default: `[]`)
 - `dist` - An array of output directories to clean before `build` (default: `["dist"]`)
 - `project` An array of TSConfig files to build using TypeScript (default: `["tsconfig.json"]`)
 - `checkProject` An array of TSConfig files to type check using TypeScript (default: `["tsconfig.json"]`)

configs/eslint.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+bun "$(dirname "$0")/../../../dist/bin.js" pre-commit

configs/husky/bun/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+node "$(dirname "$0")/../../../dist/bin.js" pre-commit

configs/husky/node/pre-commit

@@ -0,0 +1,7 @@
+const script = `${process.argv0} '${require.resolve("../dist/bin.js")}'`;
+
+const config = {
+  [process.env.TS_SCRIPTS_FORMAT_GLOB]: `${script} format`,
+};
+
+export default config;