From 267be4439202ca2dac313e352698b4dadd158970 Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Mon, 23 Mar 2020 12:59:53 +0530 Subject: [PATCH] chore: extend prettier configuration for markdown --- CONTRIBUTING.md | 20 +++--- README.md | 179 ++++++++++++++++++++++-------------------------- _SETUP.md | 8 +-- open-bot.yaml | 18 ++--- package.json | 4 ++ 5 files changed, 108 insertions(+), 121 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d55d588fa..b6695e871 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ that include your webpack.config.js, relevant files, and the full error message **If you have discovered a bug or have a feature suggestion, please [create an issue on GitHub](https://github.com/webpack/webpack/issues/new).** -Do you want to fix an issue? Look at the issues with a tag of [X5: work required (PR / Help Wanted)](https://github.com/webpack/webpack/labels/X5%3A%20work%20required%20%28PR%20%2F%20Help%20Wanted%29). Each issue should be tagged with a difficulty tag - +Do you want to fix an issue? Look at the issues with a tag of [X5: work required (PR / Help Wanted)](https://github.com/webpack/webpack/labels/X5%3A%20work%20required%20%28PR%20%2F%20Help%20Wanted%29). Each issue should be tagged with a difficulty tag - - D0: My First Commit (Contribution Difficulty) - D1: Easy (Contribution Difficulty) @@ -41,12 +41,12 @@ your pull request should be accepted quickly. Something that will increase the chance that your pull request is accepted: -* [Write tests](./test/README.md) -* Follow the existing coding style -* Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) -* For a major fix/feature make sure your PR has an issue and if it doesn't, please create one. This would help discussion with the community, and polishing ideas in case of a new feature. -* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. ([More info](https://github.com/blog/1506-closing-issues-via-pull-requests)) -* When you have lot of commits in your PR, it's good practice to squash all your commits in one single commit. ([Learn how to squash here](https://davidwalsh.name/squash-commits-git)) +- [Write tests](./test/README.md) +- Follow the existing coding style +- Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +- For a major fix/feature make sure your PR has an issue and if it doesn't, please create one. This would help discussion with the community, and polishing ideas in case of a new feature. +- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. ([More info](https://github.com/blog/1506-closing-issues-via-pull-requests)) +- When you have lot of commits in your PR, it's good practice to squash all your commits in one single commit. ([Learn how to squash here](https://davidwalsh.name/squash-commits-git)) ## Documentation @@ -61,8 +61,8 @@ Gitter is only for small questions. To discuss a subject in detail, please send ## Join the development -- Before you join development, please [set up the project](./_SETUP.md) on your local machine, run it and go through the application completely. Use any command you can find and see what it does. Explore. +- Before you join development, please [set up the project](./_SETUP.md) on your local machine, run it and go through the application completely. Use any command you can find and see what it does. Explore. - > Don't worry ... Nothing will happen to the project or to you due to the exploring. Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the project. + > Don't worry ... Nothing will happen to the project or to you due to the exploring. Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the project. -- If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please feel free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely. +- If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please feel free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely. diff --git a/README.md b/README.md index 3359bf7a0..f37dedd2b 100644 --- a/README.md +++ b/README.md @@ -83,11 +83,11 @@ or packaging just about any resource or asset. **TL;DR** -* Bundles [ES Modules](https://www.2ality.com/2014/09/es6-modules-final.html), [CommonJS](http://wiki.commonjs.org/), and [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) modules (even combined). -* Can create a single bundle or multiple chunks that are asynchronously loaded at runtime (to reduce initial loading time). -* Dependencies are resolved during compilation, reducing the runtime size. -* Loaders can preprocess files while compiling, e.g. TypeScript to JavaScript, Handlebars strings to compiled functions, images to Base64, etc. -* Highly modular plugin system to do whatever else your application requires. +- Bundles [ES Modules](https://www.2ality.com/2014/09/es6-modules-final.html), [CommonJS](http://wiki.commonjs.org/), and [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) modules (even combined). +- Can create a single bundle or multiple chunks that are asynchronously loaded at runtime (to reduce initial loading time). +- Dependencies are resolved during compilation, reducing the runtime size. +- Loaders can preprocess files while compiling, e.g. TypeScript to JavaScript, Handlebars strings to compiled functions, images to Base64, etc. +- Highly modular plugin system to do whatever else your application requires. ### Get Started @@ -107,13 +107,13 @@ interface](https://webpack.js.org/plugins/). Most of the features within webpack itself use this plugin interface. This makes webpack very **flexible**. -|Name|Status|Install Size|Description| -|:--:|:----:|:----------:|:----------| -|[mini-css-extract-plugin][mini-css]|![mini-css-npm]|![mini-css-size]|Extracts CSS into separate files. It creates a CSS file per JS file which contains CSS.| -|[compression-webpack-plugin][compression]|![compression-npm]|![compression-size]|Prepares compressed versions of assets to serve them with Content-Encoding| -|[i18n-webpack-plugin][i18n]|![i18n-npm]|![i18n-size]|Adds i18n support to your bundles| -|[html-webpack-plugin][html-plugin]|![html-plugin-npm]|![html-plugin-size]| Simplifies creation of HTML files (`index.html`) to serve your bundles| -|[extract-text-webpack-plugin][extract]|![extract-npm]|![extract-size]|Extract text from a bundle, or bundles, into a separate file| +| Name | Status | Install Size | Description | +| :---------------------------------------: | :----------------: | :-----------------: | :-------------------------------------------------------------------------------------- | +| [mini-css-extract-plugin][mini-css] | ![mini-css-npm] | ![mini-css-size] | Extracts CSS into separate files. It creates a CSS file per JS file which contains CSS. | +| [compression-webpack-plugin][compression] | ![compression-npm] | ![compression-size] | Prepares compressed versions of assets to serve them with Content-Encoding | +| [i18n-webpack-plugin][i18n] | ![i18n-npm] | ![i18n-size] | Adds i18n support to your bundles | +| [html-webpack-plugin][html-plugin] | ![html-plugin-npm] | ![html-plugin-size] | Simplifies creation of HTML files (`index.html`) to serve your bundles | +| [extract-text-webpack-plugin][extract] | ![extract-npm] | ![extract-size] | Extract text from a bundle, or bundles, into a separate file | [common-npm]: https://img.shields.io/npm/v/webpack.svg [extract]: https://github.com/webpack-contrib/extract-text-webpack-plugin @@ -146,13 +146,12 @@ or are automatically applied via regex from your webpack configuration. #### Files -|Name|Status|Install Size|Description| -|:--:|:----:|:----------:|:----------| -|[raw-loader][raw]|![raw-npm]|![raw-size]|Loads raw content of a file (utf-8)| -|[val-loader][val]|![val-npm]|![val-size]|Executes code as module and considers exports as JS code| -|[url-loader][url]|![url-npm]|![url-size]|Works like the file loader, but can return a Data Url if the file is smaller than a limit| -|[file-loader][file]|![file-npm]|![file-size]|Emits the file into the output folder and returns the (relative) url| - +| Name | Status | Install Size | Description | +| :-----------------: | :---------: | :----------: | :---------------------------------------------------------------------------------------- | +| [raw-loader][raw] | ![raw-npm] | ![raw-size] | Loads raw content of a file (utf-8) | +| [val-loader][val] | ![val-npm] | ![val-size] | Executes code as module and considers exports as JS code | +| [url-loader][url] | ![url-npm] | ![url-size] | Works like the file loader, but can return a Data Url if the file is smaller than a limit | +| [file-loader][file] | ![file-npm] | ![file-size] | Emits the file into the output folder and returns the (relative) url | [raw]: https://github.com/webpack-contrib/raw-loader [raw-npm]: https://img.shields.io/npm/v/raw-loader.svg @@ -169,12 +168,11 @@ or are automatically applied via regex from your webpack configuration. #### JSON -|Name|Status|Install Size|Description| -|:--:|:----:|:----------:|:----------| -||![json-npm]|![json-size]|Loads a JSON file (included by default)| -||![json5-npm]|![json5-size]|Loads and transpiles a JSON 5 file| -||![cson-npm]|![cson-size]|Loads and transpiles a CSON file| - +| Name | Status | Install Size | Description | +| :----------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------: | :-----------: | :-------------------------------------- | +| | ![json-npm] | ![json-size] | Loads a JSON file (included by default) | +| | ![json5-npm] | ![json5-size] | Loads and transpiles a JSON 5 file | +| | ![cson-npm] | ![cson-size] | Loads and transpiles a CSON file | [json-npm]: https://img.shields.io/npm/v/json-loader.svg [json-size]: https://packagephobia.now.sh/badge?p=json-loader @@ -185,15 +183,14 @@ or are automatically applied via regex from your webpack configuration. #### Transpiling -|Name|Status|Install Size|Description| -|:--:|:----:|:----------:|:----------| -|`