chore: replace yarn with pnpm

Author: jin-sir

.github/workflows/CI.yml

@@ -1,133 +1,134 @@
-# This is a basic workflow to help you get started with Actions
-
 name: CI
 
-# Triggers the workflow on push or pull request events but only for the master branch
 on:
     push:
         branches: [master]
     pull_request:
         branches: [master]
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
     setup:
         runs-on: ubuntu-latest
         steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
+            - uses: actions/checkout@v4
 
-            - name: Cache yarn.lock
-              uses: actions/cache@v4
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
               with:
-                  path: package-temp-dir
-                  key: lock-${{ github.sha }}
+                  node-version: 16.x
 
-            - name: Create yarn.lock
-              run: yarn generate-lock-entry
+            - name: Install pnpm
+              uses: pnpm/action-setup@v2
+              with:
+                  version: 6.32.12
+                  run_install: false
 
-            - name: Hack for single file
+            - name: Get pnpm store directory
+              id: pnpm-cache
+              shell: bash
               run: |
-                  if [ ! -d "package-temp-dir" ]; then
-                    mkdir package-temp-dir
-                  fi
-                  cp yarn.lock package-temp-dir
-            - name: Cache node_modules
-              id: node_modules_cache_id
+                  echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+            - name: Cache pnpm store
               uses: actions/cache@v4
               with:
-                  path: node_modules
-                  key: node_modules-${{ hashFiles('**/package-temp-dir/yarn.lock') }}
+                  path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+                  key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-store-
 
             - name: Install dependencies
-              if: steps.node_modules_cache_id.outputs.cache-hit != 'true'
-              run: yarn
+              shell: bash
+              run: pnpm install
 
     prettier:
-        needs: [setup]
+        needs: setup
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v4
 
-            - name: Restore cache from yarn.lock
-              uses: actions/cache@v4
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
               with:
-                  path: package-temp-dir
-                  key: lock-${{ github.sha }}
+                  node-version: 16.x
 
-            - name: Restore cache from node_modules
-              uses: actions/cache@v4
+            - name: Install pnpm
+              uses: pnpm/action-setup@v2
               with:
-                  path: node_modules
-                  key: node_modules-${{ hashFiles('**/package-temp-dir/yarn.lock') }}
+                  version: 6.32.12
+                  run_install: false
+
+            - run: pnpm install
 
-            - name: Prettier check
-              run: yarn prettier
+            - name: Run Prettier
+              run: pnpm prettier
 
     eslint:
-        needs: [setup]
+        needs: setup
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v4
 
-            - name: Restore cache from yarn.lock
-              uses: actions/cache@v4
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
               with:
-                  path: package-temp-dir
-                  key: lock-${{ github.sha }}
+                  node-version: 16.x
 
-            - name: Restore cache from node_modules
-              uses: actions/cache@v4
+            - name: Install pnpm
+              uses: pnpm/action-setup@v2
               with:
-                  path: node_modules
-                  key: node_modules-${{ hashFiles('**/package-temp-dir/yarn.lock') }}
+                  version: 6.32.12
+                  run_install: false
 
-            - name: Eslint check
-              run: yarn eslint
+            - run: pnpm install
+
+            - name: Run ESLint
+              run: pnpm eslint
 
     test:
-        needs: [setup]
+        needs: setup
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v4
 
-            - name: Restore cache from yarn.lock
-              uses: actions/cache@v4
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
               with:
-                  path: package-temp-dir
-                  key: lock-${{ github.sha }}
+                  node-version: 16.x
 
-            - name: Restore cache from node_modules
-              uses: actions/cache@v4
+            - name: Install pnpm
+              uses: pnpm/action-setup@v2
               with:
-                  path: node_modules
-                  key: node_modules-${{ hashFiles('**/package-temp-dir/yarn.lock') }}
+                  version: 6.32.12
+                  run_install: false
+            - run: pnpm install
 
-            - name: Setup timezone
+            - name: Set up timezone
               uses: zcong1993/setup-timezone@master
               with:
-                timezone: Asia/Shanghai
+                  timezone: Asia/Shanghai
 
-            - name: Unit Test
-              run: yarn test
+            - name: Run Tests
+              run: pnpm test
 
     build:
-        runs-on: ubuntu-latest
         needs: [setup, prettier, eslint, test]
+        runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v4
 
-            - name: Restore cache from yarn.lock
-              uses: actions/cache@v4
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
               with:
-                  path: package-temp-dir
-                  key: lock-${{ github.sha }}
+                  node-version: 16.x
 
-            - name: Restore cache from node_modules
-              uses: actions/cache@v4
+            - name: Install pnpm
+              uses: pnpm/action-setup@v2
               with:
-                  path: node_modules
-                  key: node_modules-${{ hashFiles('**/package-temp-dir/yarn.lock') }}
+                  version: 6.32.12
+                  run_install: false
+
+            - run: pnpm install
 
-            - name: Build test
-              run: yarn build
+            - name: Run Build
+              run: pnpm build

docs/contribution.md

@@ -22,7 +22,7 @@
 
 1、请 `fork` 本项目，`clone` 自己的仓库，按照上述分支定义从 `master` 分支新建 `feat` 分支进行开发，分支命名用下划线加上版本号、功能名，如：`feat_1.x_xxx`
 
-2、`feat` 分支开发完毕后，本地执行 `yarn lint` 命令，再执行 `yarn test` 命令，均通过后向相应人员提 PR，期望合入 `release` 分支，待相应人员 review 代码后合入
+2、`feat` 分支开发完毕后，本地执行 `pnpm lint` 命令，再执行 `pnpm test` 命令，均通过后向相应人员提 PR，期望合入 `release` 分支，待相应人员 review 代码后合入
 
 
 ## Bugs

docs/quickstart.md

@@ -4,6 +4,7 @@
 ```bash
 npm install @dtinsight/dt-utils
 yarn add @dtinsight/dt-utils
+pnpm install @dtinsight/dt-utils
 ```
 ## 使用
 
@@ -12,7 +13,7 @@ yarn add @dtinsight/dt-utils
 ````
 
 ## Package Managers
-JavaScript @dtinsight/dt-utils supports npm and yarn under the name @dtinsight/dt-utils. Module Loaders
+JavaScript @dtinsight/dt-utils supports npm, yarn and pnpm under the name @dtinsight/dt-utils. Module Loaders
 
 ## Module Loaders
 JavaScript @dtinsight/dt-utils can also be loaded as an ES6 module.

package.json

@@ -24,6 +24,7 @@
     "homepage": "https://dtstack.github.io/dt-utils/",
     "scripts": {
         "build": "tsc",
+        "lint": "npm run eslint && npm run prettier",
         "prettier": "npx prettier --check 'src/**/*.{js,jsx,json,ts}'",
         "prettier:fix": "npx prettier --write 'src/**/*.{js,jsx,json,ts}'",
         "eslint": "npx eslint --ext .js,.ts ./src",
@@ -55,6 +56,7 @@
         "jest-environment-jsdom": "^29.7.0",
         "ko-lint-config": "^2.2.18",
         "lint-staged": "^9.5.0",
+        "prettier": "^3.6.2",
         "standard-version": "^9.5.0",
         "ts-jest": "^29.2.5",
         "ts-node": "^10.9.2",

pnpm-lock.yaml

@@ -26,8 +26,8 @@ git pull origin $branch
 echo "Current pull origin $branch."
 
 
-echo "yarn prepublishOnly"
-yarn prepublishOnly
+echo "pnpm prepublishOnly"
+pnpm prepublishOnly
 
 
 # Auto generate version number and tag

scripts/release.sh

@@ -27,10 +27,8 @@ describe('generateUrlWithQuery', () => {
         const params = {
             filter: { status: 'active', type: 'user' },
             id: 1,
-        };
-        expect(generateUrlWithQuery('/api/users', params)).toBe(
-            '/api/users?filter=%7B%22status%22%3A%22active%22%2C%22type%22%3A%22user%22%7D&id=1'
-        );
+        } as Record<string, any>;
+        expect(generateUrlWithQuery('/api/users', params)).toBe('/api/users?id=1');
     });
 
     test('returns original path when no query parameters', () => {
@@ -53,6 +51,8 @@ describe('generateUrlWithQuery', () => {
         const circularObj = { self: null };
         circularObj.self = circularObj as any;
         // Test circular reference object, should return original path
-        expect(generateUrlWithQuery('/api/users', { obj: circularObj })).toBe('/api/users');
+        expect(
+            generateUrlWithQuery('/api/users', { obj: circularObj } as Record<string, any>)
+        ).toBe('/api/users');
     });
 });