From 4e3b209e42dfc8dc3f3341d0b341a0dcd5237a21 Mon Sep 17 00:00:00 2001 From: TinsFox <1414849373@qq.com> Date: Mon, 20 Dec 2021 15:37:52 +0800 Subject: [PATCH 1/2] chore: add all-contributors reboot --- .all-contributorsrc | 26 +++++++++++++++++++++ README.md | 43 +++++++++++++++++++++++++++++++++++ package.json | 9 ++++---- yarn.lock | 55 +++++++++++++++++++++++++++++++++++++++++---- 4 files changed, 125 insertions(+), 8 deletions(-) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000000..d1cae53925 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,26 @@ +{ + "projectName": "vue-devui", + "projectOwner": "DevCloudFE", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": true, + "commitConvention": "gitmoji", + "contributors": [ + { + "login": "kagol", + "name": "Kagol", + "avatar_url": "https://avatars.githubusercontent.com/u/9566362?v=4", + "profile": "https://juejin.cn/user/712139267650141", + "contributions": [ + "maintenance", + "code", + "doc" + ] + } + ], + "contributorsPerLine": 7 +} diff --git a/README.md b/README.md index 9b5d4831a3..f4125a3882 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@

+ +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) + DevUI Logo @@ -164,6 +167,46 @@ import '@devui-design/icons/icomoon/devui-icon.css' ``` +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + +

Kagol
🚧 💻 📖
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + # License [MIT](https://github.com/DevCloudFE/vue-devui/blob/dev/LICENSE) + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + +

Kagol
🚧 💻 📖
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file diff --git a/package.json b/package.json index f56d4c26b0..03116a9d92 100644 --- a/package.json +++ b/package.json @@ -11,18 +11,19 @@ "stylelint": "stylelint --fix \"{packages}/**/*.{scss,css}\"" }, "devDependencies": { - "lerna": "^4.0.0", - "husky": "^7.0.4", "@ls-lint/ls-lint": "^1.10.0", + "all-contributors-cli": "^6.20.0", "esbuild-register": "^2.6.0", "eslint": "^7.28.0", "eslint-plugin-import": "^2.24.2", "eslint-plugin-vue": "^7.11.1", + "husky": "^7.0.4", + "lerna": "^4.0.0", + "lint-staged": "^11.0.0", "stylelint": "^13.13.1", "stylelint-config-recommended-scss": "^4.3.0", "stylelint-config-standard": "^22.0.0", - "stylelint-scss": "^3.20.1", - "lint-staged": "^11.0.0" + "stylelint-scss": "^3.20.1" }, "workspaces": [ "packages/*" diff --git a/yarn.lock b/yarn.lock index dec2f8c758..6edab38029 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1011,6 +1011,13 @@ dependencies: regenerator-runtime "^0.13.4" +"@babel/runtime@^7.14.6", "@babel/runtime@^7.7.6": + version "7.16.5" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.16.5.tgz#7f3e34bf8bdbbadf03fbb7b1ea0d929569c9487a" + integrity sha512-TXWihFIS3Pyv5hzR7j6ihmeLkZfrXGxAr5UfSl8CHf+6q/wpiYDkUau0czckpYG8QmnCIuPpdLtuA9VmuGGyMA== + dependencies: + regenerator-runtime "^0.13.4" + "@babel/template@^7.0.0", "@babel/template@^7.12.7", "@babel/template@^7.16.0", "@babel/template@^7.3.3": version "7.16.0" resolved "https://registry.npmjs.org/@babel/template/-/template-7.16.0.tgz#d16a35ebf4cd74e202083356fab21dd89363ddd6" @@ -3186,6 +3193,22 @@ algoliasearch@^4.0.0: "@algolia/requester-node-http" "4.11.0" "@algolia/transporter" "4.11.0" +all-contributors-cli@^6.20.0: + version "6.20.0" + resolved "https://registry.yarnpkg.com/all-contributors-cli/-/all-contributors-cli-6.20.0.tgz#9bc98dda38cb29cfe8afc8a78c004e14af25d2f6" + integrity sha512-trEQlL1s1u8FSWSwY2w9uL4GCG7Fo9HIW5rm5LtlE0SQHSolfXQBzJib07Qes5j52/t72wjuE6sEKkuRrwiuuQ== + dependencies: + "@babel/runtime" "^7.7.6" + async "^3.0.1" + chalk "^4.0.0" + didyoumean "^1.2.1" + inquirer "^7.0.4" + json-fixer "^1.5.1" + lodash "^4.11.2" + node-fetch "^2.6.0" + pify "^5.0.0" + yargs "^15.0.1" + ansi-colors@^4.1.1: version "4.1.1" resolved "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz#cbb9ae256bf750af1eab344f229aa27fe94ba348" @@ -3352,6 +3375,11 @@ async-validator@^4.0.2: resolved "https://registry.npmjs.org/async-validator/-/async-validator-4.0.7.tgz#034a0fd2103a6b2ebf010da75183bec299247afe" integrity sha512-Pj2IR7u8hmUEDOwB++su6baaRi+QvsgajuFB9j95foM1N2gy5HM4z60hfusIO0fBPG5uLAEl6yCJr1jNSVugEQ== +async@^3.0.1: + version "3.2.2" + resolved "https://registry.yarnpkg.com/async/-/async-3.2.2.tgz#2eb7671034bb2194d45d30e31e24ec7e7f9670cd" + integrity sha512-H0E+qZaDEfx/FY4t7iLRv1W2fFI6+pyCeTw1uN20AQPiwqwM6ojPxHxdLv4z8hi2DtnW9BOckSspLucW7pIE5g== + asynckit@^0.4.0: version "0.4.0" resolved "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" @@ -4385,6 +4413,11 @@ diacritics@^1.3.0: resolved "https://registry.npmjs.org/diacritics/-/diacritics-1.3.0.tgz#3efa87323ebb863e6696cebb0082d48ff3d6f7a1" integrity sha1-PvqHMj67hj5mls67AILUj/PW96E= +didyoumean@^1.2.1: + version "1.2.2" + resolved "https://registry.yarnpkg.com/didyoumean/-/didyoumean-1.2.2.tgz#989346ffe9e839b4555ecf5666edea0d3e8ad037" + integrity sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw== + diff-sequences@^26.6.2: version "26.6.2" resolved "https://registry.npmjs.org/diff-sequences/-/diff-sequences-26.6.2.tgz#48ba99157de1923412eed41db6b6d4aa9ca7c0b1" @@ -5725,7 +5758,7 @@ init-package-json@^2.0.2: validate-npm-package-license "^3.0.4" validate-npm-package-name "^3.0.0" -inquirer@^7.3.3: +inquirer@^7.0.4, inquirer@^7.3.3: version "7.3.3" resolved "https://registry.npmjs.org/inquirer/-/inquirer-7.3.3.tgz#04d176b2af04afc157a83fd7c100e98ee0aad003" integrity sha512-JG3eIAj5V9CwcGvuOmoo6LB9kbAYT8HXffUl6memuszlwDC/qvFAJw49XJ5NROSFNPxp3iQg1GqkFhaY/CR0IA== @@ -6621,6 +6654,15 @@ jsesc@~0.5.0: resolved "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz#e7dee66e35d6fc16f710fe91d5cf69f70f08911d" integrity sha1-597mbjXW/Bb3EP6R1c9p9w8IkR0= +json-fixer@^1.5.1: + version "1.6.13" + resolved "https://registry.yarnpkg.com/json-fixer/-/json-fixer-1.6.13.tgz#27d2f0e837aec54afbc9ec1cd8c1dd965bf534c9" + integrity sha512-DKQ71M+0uwAG3QsUkeVgh6XREw/OkpnTfHfM+sdmxRjHvYZ8PlcMVF4ibsHQ1ckR63NROs68qUr1I0u6yPVePQ== + dependencies: + "@babel/runtime" "^7.14.6" + chalk "^4.1.2" + pegjs "^0.10.0" + json-parse-better-errors@^1.0.1: version "1.0.2" resolved "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9" @@ -6931,7 +6973,7 @@ lodash.truncate@^4.4.2: resolved "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz#5a350da0b1113b837ecfffd5812cbe58d6eae193" integrity sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM= -lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.21, lodash@^4.7.0: +lodash@^4.11.2, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.21, lodash@^4.7.0: version "4.17.21" resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== @@ -7414,7 +7456,7 @@ neo-async@^2.6.0: resolved "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== -node-fetch@^2.6.1: +node-fetch@^2.6.0, node-fetch@^2.6.1: version "2.6.6" resolved "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.6.tgz#1751a7c01834e8e1697758732e9efb6eeadfaf89" integrity sha512-Z8/6vRlTUChSdIgMa51jxQ4lrw/Jy5SOW10ObaA47/RElsAN2c5Pn8bTgFGWn/ibwzXTE8qwr1Yzx28vsecXEA== @@ -8032,6 +8074,11 @@ path-type@^4.0.0: resolved "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== +pegjs@^0.10.0: + version "0.10.0" + resolved "https://registry.yarnpkg.com/pegjs/-/pegjs-0.10.0.tgz#cf8bafae6eddff4b5a7efb185269eaaf4610ddbd" + integrity sha1-z4uvrm7d/0tafvsYUmnqr0YQ3b0= + performance-now@^2.1.0: version "2.1.0" resolved "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz#6309f4e0e5fa913ec1c69307ae364b4b377c9e7b" @@ -10499,7 +10546,7 @@ yargs-parser@^20.2.2, yargs-parser@^20.2.3: resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz#2eb7dc3b0289718fc295f362753845c41a0c94ee" integrity sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w== -yargs@^15.1.0: +yargs@^15.0.1, yargs@^15.1.0: version "15.4.1" resolved "https://registry.npmjs.org/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8" integrity sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A== From 9d5e7e51e2d80a71722d7bd506c17bc5e1a5cf8b Mon Sep 17 00:00:00 2001 From: TinsFox <1414849373@qq.com> Date: Mon, 20 Dec 2021 15:46:34 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20update=20README.md=20=E5=A4=84?= =?UTF-8?q?=E7=90=86=E6=A0=87=E9=A2=98=E7=BA=A7=E5=88=AB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 56 ++++++++++++++++++------------------------------------- 1 file changed, 18 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index f4125a3882..dd2bbb3464 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Vue DevUI 是 Vue3 版本的 DevUI 组件库，基于 [https://github.com/devclo DevUI 官方网站：[https://devui.design](https://devui.design) -# 当前状态: Beta +## 当前状态: Beta 该项目还处于孵化和演进阶段，欢迎大家参与到 Vue DevUI 项目的建设中来！🎉🎉 @@ -23,9 +23,9 @@ DevUI 官方网站：[https://devui.design](https://devui.design) [贡献指南](https://github.com/DevCloudFE/vue-devui/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97) -# 快速开始 +## 快速开始 -## 1 安装依赖 +### 1 安装依赖 ``` yarn(推荐) @@ -35,7 +35,7 @@ or npm i ``` -## 2 启动 +### 2 启动 ``` yarn dev(推荐) @@ -45,11 +45,11 @@ or npm run dev ``` -## 3 访问 +### 3 访问 [http://localhost:3000/](http://localhost:3000/) -## 4 生产打包 +### 4 生产打包 ``` yarn build(推荐) @@ -59,15 +59,15 @@ or npm run build ``` -# 使用 Vue DevUI +## 使用 Vue DevUI -## 1. 安装 +### 1. 安装 ``` yarn add vue-devui ``` -## 2. 全量引入 +### 2. 全量引入 在`main.ts`文件中编写以下代码： ``` @@ -84,7 +84,7 @@ createApp(App) .mount('#app') ``` -## 3. 按需引入 +### 3. 按需引入 除了全量引入，我们也支持单个组件按需引入。 @@ -104,7 +104,7 @@ createApp(App) .mount('#app') ``` -## 4. 配置自动按需引入`unplugin-vue-components`（推荐） +### 4. 配置自动按需引入`unplugin-vue-components`（推荐） 配置`unplugin-vue-components`插件可以无需引入Vue DevUI就可以直接按需使用其中的组件，具体使用方式如下： @@ -129,7 +129,7 @@ export default defineConfig({ 配置了以上插件，就可以直接在代码中使用`Vue DevUI`的组件，而无需在`main.ts`文件中引入`Vue DevUI`。 -## 5. 使用 +### 5. 使用 ``` ``` -# 图标库 +## 图标库 图标库推荐使用[DevUI图标库](https://devui.design/icon/ruleResource)，也可以使用第三方图标库，比如：iconfont。 -## 使用DevUI图标库 +### 使用DevUI图标库 -### 安装 +#### 安装 ``` yarn add @devui-design/icons(推荐) @@ -153,7 +153,7 @@ or npm i @devui-design/icons ``` -### 引入 +#### 引入 在`main.ts`文件中，编写以下代码： @@ -161,7 +161,7 @@ npm i @devui-design/icons import '@devui-design/icons/icomoon/devui-icon.css' ``` -### 使用 +#### 使用 ``` @@ -187,26 +187,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! -# License +## License [MIT](https://github.com/DevCloudFE/vue-devui/blob/dev/LICENSE) - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - -

Kagol
🚧 💻 📖
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file