Skip to content

Commit 13fee96

Browse files
authored
Doc/beautify (#1651)
* doc: 增加 coveralls * doc: add badge
1 parent 051a2ad commit 13fee96

6 files changed

+38
-3
lines changed

.coveralls.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
service_name: travis-pro
2+
repo_token: dO6l2UfWXIPwCzK3lmEUKQyQsfzXZUZml

.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ install:
88
script:
99
- yarn run build:doc
1010
- surge ./dist ahooks-$(git rev-parse --short HEAD).surge.sh
11+
- yarn coveralls # generate static files
1112
cache:
1213
directories:
1314
- 'node_modules'

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ A high-quality & reliable React Hooks library.
1010

1111
[![NPM version][image-1]][1]
1212
[![NPM downloads][image-2]][2]
13+
[![npm](https://img.shields.io/npm/dw/ahooks-v2?label=downloads%28v2%29)](https://www.npmjs.com/package/ahooks-v2)
14+
[![npm](https://img.shields.io/github/issues/alibaba/hooks)](https://github.com/alibaba/hooks/issues)
15+
[![Coverage Status](https://coveralls.io/repos/github/alibaba/hooks/badge.svg?branch=doc/beautify)](https://coveralls.io/github/alibaba/hooks?branch=doc/beautify)
1316
![gzip size](https://img.badgesize.io/https:/unpkg.com/ahooks/dist/ahooks.js?label=gzip%20size&compression=gzip)
17+
[![Percentage of issues still open](http://isitmaintained.com/badge/open/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks 'Percentage of issues still open')
18+
[![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')
1419
![GitHub](https://img.shields.io/github/license/alibaba/hooks)
1520

1621
English | [简体中文](https://github.com/alibaba/hooks/blob/master/README.zh-CN.md)
@@ -72,8 +77,7 @@ Thanks to all the contributors:
7277

7378
<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'/>
7479

75-
7680
[1]: https://www.npmjs.com/package/ahooks
7781
[2]: https://npmjs.org/package/ahooks
7882
[image-1]: https://img.shields.io/npm/v/ahooks.svg?style=flat
79-
[image-2]: https://img.shields.io/npm/dm/ahooks.svg?style=flat
83+
[image-2]: https://img.shields.io/npm/dw/ahooks.svg?style=flat

README.zh-CN.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@
1010

1111
[![NPM version][image-1]][1]
1212
[![NPM downloads][image-2]][2]
13+
[![npm](https://img.shields.io/npm/dw/ahooks-v2?label=downloads%28v2%29)](https://www.npmjs.com/package/ahooks-v2)
14+
[![Coverage Status](https://coveralls.io/repos/github/alibaba/hooks/badge.svg?branch=doc/beautify)](https://coveralls.io/github/alibaba/hooks?branch=doc/beautify)
15+
[![npm](https://img.shields.io/github/issues/alibaba/hooks)](https://github.com/alibaba/hooks/issues)
1316
![gzip size](https://img.badgesize.io/https:/unpkg.com/ahooks/dist/ahooks.js?label=gzip%20size&compression=gzip)
17+
[![Percentage of issues still open](http://isitmaintained.com/badge/open/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks 'Percentage of issues still open')
18+
[![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')
1419
![GitHub](https://img.shields.io/github/license/alibaba/hooks)
1520

1621
[English](https://github.com/alibaba/hooks/blob/master/README.md) | 简体中文
@@ -75,4 +80,4 @@ $ yarn start
7580
[1]: https://www.npmjs.com/package/ahooks
7681
[2]: https://npmjs.org/package/ahooks
7782
[image-1]: https://img.shields.io/npm/v/ahooks.svg?style=flat
78-
[image-2]: https://img.shields.io/npm/dm/ahooks.svg?style=flat
83+
[image-2]: https://img.shields.io/npm/dw/ahooks.svg?style=flat

package.json

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"clean": "lerna clean --yes",
1414
"build": "lerna run build",
1515
"test": "jest",
16+
"coveralls": "jest --coverage --coverageReporters=text-lcov | coveralls",
1617
"lint": "eslint --ignore-pattern **/__tests__/* --ignore-pattern **/demo/* \"packages/*/src/**/*.{ts,tsx}\"",
1718
"build:doc": "dumi build",
1819
"pub:doc-surge": "surge ./dist --domain ahooks.js.org",
@@ -42,6 +43,7 @@
4243
"babel-loader": "^8.1.0",
4344
"babel-plugin-import": "^1.12.0",
4445
"babel-plugin-transform-async-to-promises": "^0.8.15",
46+
"coveralls": "^3.1.1",
4547
"del": "^5.1.0",
4648
"dumi": "^1.1.7",
4749
"enzyme": "^3.10.0",

yarn.lock

+21
Original file line numberDiff line numberDiff line change
@@ -4852,6 +4852,17 @@ cosmiconfig@^7.0.0:
48524852
path-type "^4.0.0"
48534853
yaml "^1.10.0"
48544854

4855+
coveralls@^3.1.1:
4856+
version "3.1.1"
4857+
resolved "https://registry.yarnpkg.com/coveralls/-/coveralls-3.1.1.tgz#f5d4431d8b5ae69c5079c8f8ca00d64ac77cf081"
4858+
integrity sha512-+dxnG2NHncSD1NrqbSM3dn/lE57O6Qf/koe9+I7c+wzkqRmEvcp0kgJdxKInzYzkICKkFMZsX3Vct3++tsF9ww==
4859+
dependencies:
4860+
js-yaml "^3.13.1"
4861+
lcov-parse "^1.0.0"
4862+
log-driver "^1.2.7"
4863+
minimist "^1.2.5"
4864+
request "^2.88.2"
4865+
48554866
create-ecdh@^4.0.0:
48564867
version "4.0.4"
48574868
resolved "https://registry.yarnpkg.com/create-ecdh/-/create-ecdh-4.0.4.tgz#d6e7f4bffa66736085a0762fd3a632684dabcc4e"
@@ -8753,6 +8764,11 @@ lcid@^3.0.0:
87538764
dependencies:
87548765
invert-kv "^3.0.0"
87558766

8767+
lcov-parse@^1.0.0:
8768+
version "1.0.0"
8769+
resolved "https://registry.yarnpkg.com/lcov-parse/-/lcov-parse-1.0.0.tgz#eb0d46b54111ebc561acb4c408ef9363bdc8f7e0"
8770+
integrity sha512-aprLII/vPzuQvYZnDRU78Fns9I2Ag3gi4Ipga/hxnVMCZC8DnR2nI7XBqrPoywGfxqIx/DgarGvDJZAD3YBTgQ==
8771+
87568772
lead@^1.0.0:
87578773
version "1.0.0"
87588774
resolved "https://registry.yarnpkg.com/lead/-/lead-1.0.0.tgz#6f14f99a37be3a9dd784f5495690e5903466ee42"
@@ -8995,6 +9011,11 @@ [email protected], lodash@^4.17.12, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20,
89959011
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
89969012
integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
89979013

9014+
log-driver@^1.2.7:
9015+
version "1.2.7"
9016+
resolved "https://registry.yarnpkg.com/log-driver/-/log-driver-1.2.7.tgz#63b95021f0702fedfa2c9bb0a24e7797d71871d8"
9017+
integrity sha512-U7KCmLdqsGHBLeWqYlFA0V0Sl6P08EE1ZrmA9cxjUE0WVqT9qnyVDPz1kzpFEP0jdJuFnasWIfSd7fsaNXkpbg==
9018+
89989019
log-symbols@^4.0.0, log-symbols@^4.1.0:
89999020
version "4.1.0"
90009021
resolved "https://registry.yarnpkg.com/log-symbols/-/log-symbols-4.1.0.tgz#3fbdbb95b4683ac9fc785111e792e558d4abd503"

0 commit comments

Comments
 (0)