chore(docs): Refactors links for badges (#859)

* chore(docs): refactors doc links in main readme created references for the links * chore(docs): refactors links for badges in all packages created macros for all readme.md badges links * fix(docs): removes conflict markers removed traces of conflict markers
webpack · May 4, 2019 · e241b7b · e241b7b
1 parent d16404a
commit e241b7b
Show file tree

Hide file tree

Showing 13 changed files with 121 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -11,16 +11,16 @@
 </p>
 <br>
 
-[![npm](https://img.shields.io/npm/v/webpack-cli.svg)](https://www.npmjs.com/package/webpack-cli)
-[![Build Status](https://travis-ci.org/webpack/webpack-cli.svg)](https://travis-ci.org/webpack/webpack-cli)
-[![Build2 Status](https://dev.azure.com/webpack/webpack/_apis/build/status/webpack.webpack-cli)](https://dev.azure.com/webpack/webpack/_build/latest?definitionId=4)
+[![npm][npm]][npm-url]
+[![Build Status][build-status]][build-status-url]
+[![Build2 Status][build-status-azure]][build-status-azure-url]
 [![deps][deps]][deps-url]
-[![Code Climate](https://codeclimate.com/github/webpack/webpack-cli/badges/gpa.svg)](https://codeclimate.com/github/webpack/webpack-cli)
-[![chat on gitter](https://badges.gitter.im/webpack/webpack.svg)](https://gitter.im/webpack/webpack)
-[![Install Size](https://packagephobia.now.sh/badge?p=webpack-cli)](https://packagephobia.now.sh/result?p=webpack-cli)
-[![npm](https://img.shields.io/npm/dw/webpack-cli.svg)](https://www.npmjs.com/package/webpack-cli)
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
-[![GitHub contributors](https://img.shields.io/github/contributors/webpack/webpack-cli.svg)](https://github.com/webpack/webpack-cli/graphs/contributors)
+[![Code Climate][maintainability]][maintainability-url]
+[![chat on gitter][chat]][chat-url]
+[![Install Size][size]][size-url]
+[![Downloads][downloads]][downloads-url]
+[![lerna][lerna]][lerna-url]
+[![GitHub contributors][contributors]][contributors-url]
 
 - [About](#about)
   - [How to install](#how-to-install)
@@ -87,5 +87,23 @@ You can read more about [Scaffolding](https://webpack.js.org/guides/scaffolding)
 
 The webpack family welcomes any contributor, small or big. We are happy to elaborate, guide you through the source code and find issues you might want to work on! To get started have a look at our [documentation on contributing](./.github/CONTRIBUTING.md).
 
+[build-status]: https://travis-ci.org/webpack/webpack-cli.svg
+[build-status-url]: https://travis-ci.org/webpack/webpack-cli
+[build-status-azure]: https://dev.azure.com/webpack/webpack/_apis/build/status/webpack.webpack-cli
+[build-status-azure-url]: https://dev.azure.com/webpack/webpack/_build/latest?definitionId=4
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack
+[contributors]: https://img.shields.io/github/contributors/webpack/webpack-cli.svg
+[contributors-url]: https://github.com/webpack/webpack-cli/graphs/contributors
 [deps]: https://img.shields.io/david/webpack/webpack.svg
 [deps-url]: https://david-dm.org/webpack/webpack-cli
+[downloads]: https://img.shields.io/npm/dw/webpack-cli.svg
+[downloads-url]: https://www.npmjs.com/package/webpack-cli
+[lerna]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
+[lerna-url]: http://www.lernajs.io/
+[npm]: https://img.shields.io/npm/v/webpack-cli.svg
+[npm-url]: https://www.npmjs.com/package/webpack-cli
+[maintainability]: https://codeclimate.com/github/webpack/webpack-cli/badges/gpa.svg
+[maintainability-url]: https://codeclimate.com/github/webpack/webpack-cli
+[size]: https://packagephobia.now.sh/badge?p=webpack-cli
+[size-url]: https://packagephobia.now.sh/result?p=webpack-cli
diff --git a/packages/add/README.md b/packages/add/README.md
@@ -1,6 +1,6 @@
 # webpack-cli add
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/add.svg)](https://www.npmjs.com/package/@webpack-cli/add)
+[![NPM downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -34,3 +34,6 @@ add();
 ```bash
 npx webpack-cli add
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/add.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/add
diff --git a/packages/generate-loader/README.md b/packages/generate-loader/README.md
@@ -1,6 +1,6 @@
 # webpack-cli generate-loader
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/generate-loader.svg)](https://www.npmjs.com/package/@webpack-cli/generate-loader)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -28,3 +28,6 @@ generateLoader();
 ```bash
 npx webpack-cli generate-loader
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/generate-loader.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/generate-loader
diff --git a/packages/generate-plugin/README.md b/packages/generate-plugin/README.md
@@ -1,6 +1,6 @@
 # webpack-cli generate-plugin
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/generate-plugin.svg)](https://www.npmjs.com/package/@webpack-cli/generate-plugin)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -28,3 +28,6 @@ generatePlugin();
 ```bash
 npx webpack-cli generate-plugin
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/generate-plugin.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/generate-plugin
diff --git a/packages/generators/README.md b/packages/generators/README.md
@@ -1,6 +1,6 @@
 # webpack-cli generators
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/generators.svg)](https://www.npmjs.com/package/@webpack-cli/generators)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -44,3 +44,6 @@ const {
 ---
 
 [Back to Packages](https://github.com/webpack/webpack-cli/tree/master/packages)
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/generators.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/generators
diff --git a/packages/info/README.md b/packages/info/README.md
@@ -1,6 +1,6 @@
 # webpack-cli info
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/info.svg)](https://www.npmjs.com/package/@webpack-cli/info)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -26,3 +26,6 @@ envinfo();
 ```bash
 npx webpack-cli info
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/info.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/info
diff --git a/packages/init/README.md b/packages/init/README.md
@@ -1,6 +1,6 @@
 # webpack-cli init
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/init.svg)](https://www.npmjs.com/package/@webpack-cli/init)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -49,3 +49,6 @@ npx webpack-cli init webpack-scaffold-[name]
 ```bash
 npx webpack-cli init [path]
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/init.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/init
diff --git a/packages/migrate/README.md b/packages/migrate/README.md
@@ -1,6 +1,6 @@
 # webpack-cli migrate
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/migrate.svg)](https://www.npmjs.com/package/@webpack-cli/migrate)
+[![npm][downloads]][downloads-url]
 
 ## Description
 
@@ -30,3 +30,6 @@ migrate(null, null, inputPath, outputPath);
 ```bash
 npx webpack-cli migrate
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/migrate.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/migrate
diff --git a/packages/remove/README.md b/packages/remove/README.md
@@ -1,6 +1,6 @@
 # webpack-cli remove
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/remove.svg)](https://www.npmjs.com/package/@webpack-cli/remove)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -28,3 +28,6 @@ remove();
 ```bash
 npx webpack-cli remove
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/remove.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/remove
diff --git a/packages/serve/README.md b/packages/serve/README.md
@@ -1,6 +1,6 @@
 # webpack-cli serve
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/serve.svg)](https://www.npmjs.com/package/@webpack-cli/serve)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -28,3 +28,6 @@ serve();
 ```bash
 npx webpack-cli serve
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/serve.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/serve
diff --git a/packages/update/README.md b/packages/update/README.md
@@ -1,6 +1,6 @@
 # webpack-cli update
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/update.svg)](https://www.npmjs.com/package/@webpack-cli/update)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -28,3 +28,6 @@ update();
 ```bash
 npx webpack-cli update
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/update.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/update
diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -1,6 +1,6 @@
 # webpack-cli utils (WIP, not yet published)
 
-[![npm](https://img.shields.io/npm/dm/@webpack-cli/utils.svg)](https://www.npmjs.com/package/@webpack-cli/utils)
+[![NPM Downloads][downloads]][downloads-url]
 
 ## Description
 
@@ -30,3 +30,6 @@ npm i -D webpack-cli @webpack-cli/utils
 const utils = require("@webpack-cli/utils");
 // API yet to be exposed
 ```
+
+[downloads]: https://img.shields.io/npm/dm/@webpack-cli/utils.svg
+[downloads-url]: https://www.npmjs.com/package/@webpack-cli/utils