release: update docs & CI/CD

Author: aolyang

.github/workflows/npm-publish.yml

@@ -0,0 +1,66 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: |
+          npm install pnpm --global
+          pnpm i
+
+      - name: Run tests
+        run: |
+          pnpm run test
+
+      - name: Build library
+        run: |
+          pnpm run build
+
+      - name: Archive lib artifacts
+        if: startsWith(github.event.head_commit.message, 'release')
+        uses: actions/upload-artifact@v4
+        with:
+          name: lib-dist
+          path: |
+            !node_modules
+            !.github
+            !*.config.*
+            !pnpm-lock.yaml
+
+  publish:
+    needs: build
+    if: startsWith(github.event.head_commit.message, 'release')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download lib artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: lib-dist
+      - name: Set release tag
+        run: |
+          commit_message='${{ github.event.head_commit.message }}'
+          if [[ $commit_message =~ --([a-zA-Z0-9_-]+)$ ]]; then
+            tag=${BASH_REMATCH[1]}
+            echo "npm_release_tag=$tag" >> $GITHUB_ENV
+          fi
+
+      - name: Publish to npm
+        uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_PUBLISH_TOKEN }}
+          access: 'public'
+          tag: ${{ env.npm_release_tag || 'latest' }}
+

README.md

@@ -1,4 +1,4 @@
-# range-selection
+# ranges-selection
 
 handling range selections in large scale data records such as virtual lists/grid tables.
 
@@ -14,18 +14,18 @@ WHERE id BETWEEN 0 AND 10
 ## Installation
 
 ```bash
-npm install range-selection
+npm install ranges-selection
 # or
-yarn add range-selection
+yarn add ranges-selection
 # or
-pnpm add range-selection
+pnpm add ranges-selection
 ```
 
 ## Usage
 
 ### Basic Usage
 ```js
-import { Ranges } from "range-selection"
+import { Ranges } from "ranges-selection"
 
 const ranges = new Ranges([[0, 10], [11, 15]])  // [[0, 15]]
 
@@ -59,6 +59,7 @@ ranges.select(44)  // [[0, 10], [12, 15], [44, 44]]
 
 // Array of numbers
 ranges.select([44, 55, 56, 57])  // [[0, 10], [12, 15], [44, 44], [55, 57]]
+```
 
 ### Select Object
 
@@ -86,7 +87,7 @@ ranges.unselect([2, 6, 7])  // [[0, 1], [3, 5], [8, 10], [12, 13], [15, 15]]
 
 ### Utility Functions
 ```js
-import { normalize, merge, split, select, unselect, include } from 'range-selection/utils'
+import { normalize, merge, split, select, unselect, include } from 'ranges-selection/utils'
 
 const ranges = [[0, 10], [12, 15]]
 

package.json

@@ -1,7 +1,10 @@
 {
-    "name": "range-selection",
-    "version": "0.0.1",
+    "name": "ranges-selection",
+    "version": "0.0.2",
     "description": "A range selection helper for infinite virtual List/Grid table",
+    "repository": "github:aolyang/ranges-selection",
+    "author": "aolyang <[email protected]>",
+    "license": "MIT",
     "type": "module",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -17,9 +20,6 @@
             "types": "./dist/utils.d.ts"
         }
     },
-    "repository": "github:aolyang/range-selection",
-    "author": "aolyang <[email protected]>",
-    "license": "MIT",
     "scripts": {
         "build": "tsup --format esm,cjs && tsup --format esm --dts-only",
         "dev": "pnpm build --watch",