Merge remote-tracking branch 'origin/master' into pr/1657

Author: crazylxr

.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: dO6l2UfWXIPwCzK3lmEUKQyQsfzXZUZml

.github/workflows/node-ci.yml

@@ -8,17 +8,22 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 16.x]
+        node-version: [14.x, 16.x]
 
     steps:
       - uses: actions/checkout@v1
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.2
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - name: yarn intall, build, and test
+
+      - name: pnpm run intall, build, and test
         run: |
-          yarn run init
-          yarn run test
+          pnpm run init
+          pnpm run test
         env:
           CI: true

.gitleaks.toml

@@ -121,4 +121,4 @@ title = "gitleaks config"
 	tags = ["key", "twilio"]
 [whitelist]
 	description = "Whitelisted files"
-	file = '''(^\.?gitleaks.toml$|(.*?)(jpg|gif|doc|pdf|bin)$|^package-lock.json$|yarn.lock|node_modules)'''
+	file = '''(^\.?gitleaks.toml$|(.*?)(jpg|gif|doc|pdf|bin)$|^package-lock.json$|yarn.lock|pnpm-lock.yaml|node_modules)'''

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run pretty

.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+auto-install-peers=true

.travis.yml

@@ -2,12 +2,12 @@ language: node_js
 node_js:
   - 'lts/*'
 install:
-  - yarn install
-  - yarn run bootstrap
-  - yarn install -g surge
+  - pnpm install
+  - pnpm install -g surge
 script:
-  - yarn run build:doc
+  - pnpm run build:doc
   - surge ./dist ahooks-$(git rev-parse --short HEAD).surge.sh
+  - yarn coveralls # generate static files
 cache:
   directories:
     - 'node_modules'

CONTRIBUTING.MD

@@ -22,14 +22,14 @@ Before submitting a pull request, please make sure the following is done:
 
 2. If you've fixed a bug or added code that should be tested, add tests!
 
-3. Ensure the test suite passes `yarn run test`.
+3. Ensure the test suite passes `pnpm run test`.
 
 ## Development Workflow
 
-After cloning `ahooks`, run `yarn run init` to fetch its dependencies. Then, you can run several commands:
+After cloning `ahooks`, run `pnpm run init` to fetch its dependencies. Then, you can run several commands:
 
-1. `yarn start` runs `ahooks` website locally.
+1. `pnpm start` runs `ahooks` website locally.
 
-2. `yarn run test` runs the complete test suite.
+2. `pnpm run test` runs the complete test suite.
 
-3. `yarn run build` to build.
+3. `pnpm run build` to build.

CONTRIBUTING.zh-CN.MD

@@ -22,14 +22,14 @@
 
 2. 如果你修复了一个 bug 或者新增了一个功能，请确保写了相应的测试，这很重要。
 
-3. 确认所有的测试是通过的 `yarn run test`。
+3. 确认所有的测试是通过的 `pnpm run test`。
 
 ## 开发流程
 
-在你 clone 代码并且使用 `yarn run init` 安装完依赖后，你还可以运行下面几个常用的命令：
+在你 clone 代码并且使用 `pnpm run init` 安装完依赖后，你还可以运行下面几个常用的命令：
 
-1. `yarn start` 在本地运行 `ahooks` 网站。
+1. `pnpm start` 在本地运行 `ahooks` 网站。
 
-2. `yarn run test` 运行测试。
+2. `pnpm run test` 运行测试。
 
-3. `yarn run build` 构建编译。
+3. `pnpm run build` 构建编译。

README.md

@@ -10,7 +10,12 @@ A high-quality & reliable React Hooks library.
 
 [![NPM version][image-1]][1]
 [![NPM downloads][image-2]][2]
+[![npm](https://img.shields.io/npm/dw/ahooks-v2?label=downloads%28v2%29)](https://www.npmjs.com/package/ahooks-v2)
+[![npm](https://img.shields.io/github/issues/alibaba/hooks)](https://github.com/alibaba/hooks/issues)
+[![Coverage Status](https://coveralls.io/repos/github/alibaba/hooks/badge.svg?branch=doc/beautify)](https://coveralls.io/github/alibaba/hooks?branch=doc/beautify)
 ![gzip size](https://img.badgesize.io/https:/unpkg.com/ahooks/dist/ahooks.js?label=gzip%20size&compression=gzip)
+[![Percentage of issues still open](http://isitmaintained.com/badge/open/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks 'Percentage of issues still open')
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks 'Average time to resolve an issue')
 ![GitHub](https://img.shields.io/github/license/alibaba/hooks)
 
 English | [简体中文](https://github.com/alibaba/hooks/blob/master/README.zh-CN.md)
@@ -37,6 +42,8 @@ English | [简体中文](https://github.com/alibaba/hooks/blob/master/README.zh-
 $ npm install --save ahooks
 # or
 $ yarn add ahooks
+# or
+$ pnpm add ahooks
 ```
 
 ## 🔨 Usage
@@ -54,8 +61,8 @@ import { useRequest } from 'ahooks';
 ```bash
 $ git clone git@github.com:alibaba/hooks.git
 $ cd hooks
-$ yarn run init
-$ yarn start
+$ pnpm run init
+$ pnpm start
 ```
 
 Open your browser and visit http://127.0.0.1:8000
@@ -72,8 +79,7 @@ Thanks to all the contributors:
 
 <img src="https://user-images.githubusercontent.com/12526493/163084546-ed7a18a8-f05b-484e-a32c-049a05c350fd.JPG" width="200" style='display:inline'/><img src="https://user-images.githubusercontent.com/12526493/163084577-bab53c55-610e-4efe-96c7-eb0dd076c100.JPG" width="200" style='display:inline'/><img src="https://user-images.githubusercontent.com/12526493/163084584-bfb789fe-b5f4-4cd6-b4a5-2444bd67c1a5.JPG" width="200" style='display:inline'/>
 
-
 [1]: https://www.npmjs.com/package/ahooks
 [2]: https://npmjs.org/package/ahooks
 [image-1]: https://img.shields.io/npm/v/ahooks.svg?style=flat
-[image-2]: https://img.shields.io/npm/dm/ahooks.svg?style=flat
+[image-2]: https://img.shields.io/npm/dw/ahooks.svg?style=flat

README.zh-CN.md

@@ -10,7 +10,12 @@
 
 [![NPM version][image-1]][1]
 [![NPM downloads][image-2]][2]
+[![npm](https://img.shields.io/npm/dw/ahooks-v2?label=downloads%28v2%29)](https://www.npmjs.com/package/ahooks-v2)
+[![Coverage Status](https://coveralls.io/repos/github/alibaba/hooks/badge.svg?branch=doc/beautify)](https://coveralls.io/github/alibaba/hooks?branch=doc/beautify)
+[![npm](https://img.shields.io/github/issues/alibaba/hooks)](https://github.com/alibaba/hooks/issues)
 ![gzip size](https://img.badgesize.io/https:/unpkg.com/ahooks/dist/ahooks.js?label=gzip%20size&compression=gzip)
+[![Percentage of issues still open](http://isitmaintained.com/badge/open/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks 'Percentage of issues still open')
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks 'Average time to resolve an issue')
 ![GitHub](https://img.shields.io/github/license/alibaba/hooks)
 
 [English](https://github.com/alibaba/hooks/blob/master/README.md) | 简体中文
@@ -37,6 +42,8 @@
 $ npm install --save ahooks
 # or
 $ yarn add ahooks
+# or
+$ pnpm add ahooks
 ```
 
 ## 🔨 使用
@@ -54,8 +61,8 @@ import { useRequest } from 'ahooks';
 ```bash
 $ git clone git@github.com:alibaba/hooks.git
 $ cd hooks
-$ yarn run init
-$ yarn start
+$ pnpm run init
+$ pnpm start
 ```
 
 打开浏览器访问 http://127.0.0.1:8000
@@ -75,4 +82,4 @@ $ yarn start
 [1]: https://www.npmjs.com/package/ahooks
 [2]: https://npmjs.org/package/ahooks
 [image-1]: https://img.shields.io/npm/v/ahooks.svg?style=flat
-[image-2]: https://img.shields.io/npm/dm/ahooks.svg?style=flat
+[image-2]: https://img.shields.io/npm/dw/ahooks.svg?style=flat