Merge pull request #25 from chrisvander/modernize-lib

modernize lib
chrisvander · Aug 22, 2024 · 6515aa2 · 6515aa2
2 parents b0aed6f + 505f0d6
commit 6515aa2
Show file tree

Hide file tree

Showing 41 changed files with 97 additions and 14,825 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,40 @@
+name: Test & Build
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  test-and-build:
+    name: Test & Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bun i && bun test && bun run build
+  release-please:
+    name: Release Please
+    runs-on: ubuntu-latest
+    steps:
+      - id: release
+        uses: google-github-actions/release-please-action@v3
+        with:
+          release-type: node
+          package-name: zustand-computed
+  release:
+    name: Create NPM Release
+    runs-on: ubuntu-latest
+    needs: [release-please, test-and-build]
+    if: ${{ needs.release-please.outputs.release_created }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bunx npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/.prettierrc b/.prettierrc
diff --git a/README.md b/README.md
@@ -10,6 +10,10 @@ zustand-computed is a lightweight, TypeScript-friendly middleware for the state
 ## Install
 
 ```bash
+# one of the following
+npm i zustand-computed
+pnpm i zustand-computed
+bun add zustand-computed
 yarn add zustand-computed
 ```
 
@@ -98,7 +102,7 @@ A fully-featured example can be found under the "example" directory.
 
 Here's an example with the Immer middleware.
 
-> [!WARNING]  
+> [!WARNING]
 > Types may not be as you expect when using Immer, as it derives the SetState type from the output of GetState, where `zustand-computed` makes SetState only allow the regular Store and the GetState return both the store and the computed store. To access the ComputedStore inside Immer, you will need to assert the `Store` type as `Store & ComputedStore`.
 
 ```ts

diff --git a/babel.config.js b/babel.config.js
diff --git a/bun.lockb b/bun.lockb
diff --git a/commitlint.config.js b/commitlint.config.js
diff --git a/commitlint.config.mjs b/commitlint.config.mjs
@@ -0,0 +1 @@
+export default { extends: ["@commitlint/config-conventional"] };
diff --git a/example/.gitignore b/example/.gitignore
diff --git a/example/README.md b/example/README.md
diff --git a/example/package.json b/example/package.json
diff --git a/example/public/favicon.ico b/example/public/favicon.ico
diff --git a/example/public/index.html b/example/public/index.html
diff --git a/example/public/logo192.png b/example/public/logo192.png
diff --git a/example/public/logo512.png b/example/public/logo512.png
diff --git a/example/public/manifest.json b/example/public/manifest.json
diff --git a/example/public/robots.txt b/example/public/robots.txt
diff --git a/example/src/App.css b/example/src/App.css
diff --git a/example/src/App.test.tsx b/example/src/App.test.tsx
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export default { extends: ["@commitlint/config-conventional"] };