From e241b7b3526cd7ac01dae7c7826c4fe2fe559205 Mon Sep 17 00:00:00 2001 From: Pranshu Chittora Date: Sat, 4 May 2019 12:59:32 +0530 Subject: [PATCH] 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 --- README.md | 36 +++++++--- packages/add/README.md | 5 +- packages/generate-loader/README.md | 5 +- packages/generate-plugin/README.md | 5 +- packages/generators/README.md | 5 +- packages/info/README.md | 5 +- packages/init/README.md | 5 +- packages/migrate/README.md | 5 +- packages/remove/README.md | 5 +- packages/serve/README.md | 5 +- packages/update/README.md | 5 +- packages/utils/README.md | 5 +- packages/webpack-scaffold/README.md | 102 ++++++++++++++-------------- 13 files changed, 121 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index 7238f3fede1..ec9fa54384e 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@


-[![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 index cc13015724b..82196d3e567 100644 --- 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 index cfe47ac1e8c..d1b6ad8a38c 100644 --- 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 index d4e75382cf5..096a0ad491e 100644 --- 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 index 1e81a201c9c..d35dd5eb2a7 100644 --- 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 index c6fa3efd22a..a1258e1affa 100644 --- 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 index 2cf0151e093..9f93a65754b 100644 --- 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 index baf8aa9ee29..a5fc77e87dc 100644 --- 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 index 4ba0e0221a3..f6404874945 100644 --- 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 index cc10f0300f8..204f5b65813 100644 --- 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 index 7aa6b462fee..ae6ab2e2dad 100644 --- 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 index 596f23476e6..4686cdb4238 100644 --- 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 diff --git a/packages/webpack-scaffold/README.md b/packages/webpack-scaffold/README.md index fcd01de288f..a0a92441b40 100755 --- a/packages/webpack-scaffold/README.md +++ b/packages/webpack-scaffold/README.md @@ -1,6 +1,6 @@ # webpack-scaffold -[![npm](https://img.shields.io/npm/dm/@webpack-cli/webpack-scaffold.svg)](https://www.npmjs.com/package/@webpack-cli/webpack-scaffold) +[![NPM Downloads][downloads]][downloads-url] This is the utility suite for creating a webpack `scaffold`, it contains utility functions to help you work with [Inquirer](https://github.com/SBoudrias/Inquirer.js/) prompting and scaffolding. @@ -11,20 +11,15 @@ npm i -D webpack-cli @webpack-cli/webpack-scaffold ``` # API -- [parseValue](#parsevalue) -- [createArrowFunction](#createarrowfunction) -- [createRegularFunction](#createregularfunction) -- [createDynamicPromise](#createdynamicpromise) -- [createAssetFilterFunction](#createassetfilterfunction) -- [createExternalFunction](#createexternalfunction) -- [createRequire](#createrequire) -- [Inquirer](#inquirer) - - [List](#list) - - [RawList](#rawlist) - - [CheckList](#checklist) - - [Input](#input) - - [InputValidate](#inputvalidate) - - [Confirm](#confirm) + +- [parseValue](#parsevalue) +- [createArrowFunction](#createarrowfunction) +- [createRegularFunction](#createregularfunction) +- [createDynamicPromise](#createdynamicpromise) +- [createAssetFilterFunction](#createassetfilterfunction) +- [createExternalFunction](#createexternalfunction) +- [createRequire](#createrequire) +- [Inquirer](#inquirer) - [List](#list) - [RawList](#rawlist) - [CheckList](#checklist) - [Input](#input) - [InputValidate](#inputvalidate) - [Confirm](#confirm) ## parseValue @@ -33,9 +28,9 @@ Param: `String` Used when you cannot use regular conventions. Handy for examples like `RegExp` or `output.sourcePrefix` ```js -const parseValue = require('@webpack-cli/webpack-scaffold').parseValue; +const parseValue = require("@webpack-cli/webpack-scaffold").parseValue; -this.configuration.myScaffold.webpackOptions.output.sourcePrefix = parseValue('\t') +this.configuration.myScaffold.webpackOptions.output.sourcePrefix = parseValue("\t"); // sourcePrefix: '\t' ``` @@ -46,9 +41,9 @@ Param: `String` Generally used when dealing with an entry point as an arrow function ```js -const createArrowFunction = require('@webpack-cli/webpack-scaffold').createArrowFunction; +const createArrowFunction = require("@webpack-cli/webpack-scaffold").createArrowFunction; -this.configuration.myScaffold.webpackOptions.entry = createArrowFunction('app.js') +this.configuration.myScaffold.webpackOptions.entry = createArrowFunction("app.js"); // entry: () => 'app.js' ``` @@ -59,9 +54,9 @@ Param: `String` Used when creating a function that returns a single value ```js -const createRegularFunction = require('@webpack-cli/webpack-scaffold').createRegularFunction; +const createRegularFunction = require("@webpack-cli/webpack-scaffold").createRegularFunction; -this.configuration.myScaffold.webpackOptions.entry = createRegularFunction('app.js') +this.configuration.myScaffold.webpackOptions.entry = createRegularFunction("app.js"); // entry: function() { return 'app.js' } ``` @@ -72,12 +67,12 @@ Param: `Array` | `String` Used to create a dynamic entry point ```js -const createDynamicPromise = require('@webpack-cli/webpack-scaffold').createDynamicPromise; +const createDynamicPromise = require("@webpack-cli/webpack-scaffold").createDynamicPromise; -this.confguration.myScaffold.webpackOptions.entry = createDynamicPromise('app.js') +this.confguration.myScaffold.webpackOptions.entry = createDynamicPromise("app.js"); // entry: () => new Promise((resolve) => resolve('app.js')) -this.configuration.myScaffold.webpackOptions.entry = createDynamicPromise(['app.js', 'index.js']) +this.configuration.myScaffold.webpackOptions.entry = createDynamicPromise(["app.js", "index.js"]); // entry: () => new Promise((resolve) => resolve(['app.js','index.js'])) ``` @@ -88,9 +83,9 @@ Param: `String` Used to create an [assetFilterFunction](https://webpack.js.org/configuration/performance/#performance-assetfilter) ```js -const createAssetFilterFunction = require('@webpack-cli/webpack-scaffold').createAssetFilterFunction; +const createAssetFilterFunction = require("@webpack-cli/webpack-scaffold").createAssetFilterFunction; -this.configuration.myScaffold.webpackOptions.performance.assetFilter = createAssetFilterFunction('js') +this.configuration.myScaffold.webpackOptions.performance.assetFilter = createAssetFilterFunction("js"); // assetFilter: function (assetFilename) { return assetFilename.endsWith('.js'); } ``` @@ -101,9 +96,9 @@ Param: `String` Used to create an [general function from Externals](https://webpack.js.org/configuration/externals/#function) ```js -const createExternalFunction = require('@webpack-cli/webpack-scaffold').createExternalFunction; +const createExternalFunction = require("@webpack-cli/webpack-scaffold").createExternalFunction; -this.configuration.myScaffold.webpackOptions.externals = [createExternalFunction('^yourregex$')] +this.configuration.myScaffold.webpackOptions.externals = [createExternalFunction("^yourregex$")]; /* externals: [ function(context, request, callback) { @@ -122,9 +117,9 @@ Param: `String` Used to create a module in `topScope` ```js -const createRequire = require('@webpack-cli/webpack-scaffold').createRequire; +const createRequire = require("@webpack-cli/webpack-scaffold").createRequire; -this.configuration.myScaffold.topScope = [createRequire('webpack')] +this.configuration.myScaffold.topScope = [createRequire("webpack")]; // const webpack = require('webpack') ``` @@ -137,21 +132,21 @@ Param: `name, message, choices` Creates a List from Inquirer ```js -const List = require('@webpack-cli/webpack-scaffold').List; +const List = require("@webpack-cli/webpack-scaffold").List; -List('entry', 'what kind of entry do you want?', ['Array', 'Function']) +List("entry", "what kind of entry do you want?", ["Array", "Function"]); ``` -### RawList +### RawList Param: `name, message, choices` Creates a RawList from Inquirer ```js -const RawList = require('@webpack-cli/webpack-scaffold').RawList; +const RawList = require("@webpack-cli/webpack-scaffold").RawList; -RawList('entry', 'what kind of entry do you want?', ['Array', 'Function']) +RawList("entry", "what kind of entry do you want?", ["Array", "Function"]); ``` ### CheckList @@ -161,21 +156,21 @@ Param: `name, message, choices` Creates a CheckList(`checkbox`) from Inquirer ```js -const CheckList = require('@webpack-cli/webpack-scaffold').CheckList; +const CheckList = require("@webpack-cli/webpack-scaffold").CheckList; -CheckList('entry', 'what kind of entry do you want?', ['Array', 'Function']) +CheckList("entry", "what kind of entry do you want?", ["Array", "Function"]); ``` -### Input +### Input Param: `name, message` Creates an Input from Inquirer ```js -const Input = require('@webpack-cli/webpack-scaffold').Input; +const Input = require("@webpack-cli/webpack-scaffold").Input; -Input('entry', 'what is your entry point?') +Input("entry", "what is your entry point?"); ``` ### InputValidate @@ -185,16 +180,16 @@ Param: `name, message, validate` Creates an Input from Inquirer ```js -const InputValidate = require('@webpack-cli/webpack-scaffold').InputValidate; - -const validation = (value) => { - if(value.length > 4) { - return true; - } else { - return 'Wow, that was short!' - } -} -InputValidate('entry', 'what is your entry point?', validation) +const InputValidate = require("@webpack-cli/webpack-scaffold").InputValidate; + +const validation = value => { + if (value.length > 4) { + return true; + } else { + return "Wow, that was short!"; + } +}; +InputValidate("entry", "what is your entry point?", validation); ``` ### Confirm @@ -204,7 +199,10 @@ Param: `name, message, default` Creates an Input from Inquirer ```js -const Confirm = require('@webpack-cli/webpack-scaffold').Confirm; +const Confirm = require("@webpack-cli/webpack-scaffold").Confirm; -Confirm('contextConfirm', 'Is this your context?') +Confirm("contextConfirm", "Is this your context?"); ``` + +[downloads]: https://img.shields.io/npm/dm/@webpack-cli/webpack-scaffold.svg +[downloads-url]: https://www.npmjs.com/package/@webpack-cli/webpack-scaffold