mirror of https://github.com/webpack/webpack.git
chore: extend prettier configuration for markdown
This commit is contained in:
parent
9a3358c605
commit
267be44392
|
@ -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
|
||||
|
||||
|
|
179
README.md
179
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|
|
||||
|:--:|:----:|:----------:|:----------|
|
||||
|<a href="https://github.com/webpack-contrib/json-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/json.svg"></a>|![json-npm]|![json-size]|Loads a JSON file (included by default)|
|
||||
|<a href="https://github.com/webpack-contrib/json5-loader"><img width="48" height="10.656" src="https://cdn.rawgit.com/json5/json5-logo/master/json5-logo.svg"></a>|![json5-npm]|![json5-size]|Loads and transpiles a JSON 5 file|
|
||||
|<a href="https://github.com/awnist/cson-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/coffeescript.svg"></a>|![cson-npm]|![cson-size]|Loads and transpiles a CSON file|
|
||||
|
||||
| Name | Status | Install Size | Description |
|
||||
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------: | :-----------: | :-------------------------------------- |
|
||||
| <a href="https://github.com/webpack-contrib/json-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/json.svg"></a> | ![json-npm] | ![json-size] | Loads a JSON file (included by default) |
|
||||
| <a href="https://github.com/webpack-contrib/json5-loader"><img width="48" height="10.656" src="https://cdn.rawgit.com/json5/json5-logo/master/json5-logo.svg"></a> | ![json5-npm] | ![json5-size] | Loads and transpiles a JSON 5 file |
|
||||
| <a href="https://github.com/awnist/cson-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/coffeescript.svg"></a> | ![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|
|
||||
|:--:|:----:|:----------:|:----------|
|
||||
|<a href="https://github.com/webpack-contrib/script-loader">`<script>`</a>|![script-npm]|![script-size]|Executes a JavaScript file once in global context (like in script tag), `require()`s are not parsed|
|
||||
|<a href="https://github.com/babel/babel-loader"><img width="48" height="48" title="babel-loader" src="https://worldvectorlogo.com/logos/babel-10.svg"></a>|![babel-npm]|![babel-size]|Loads ES2015+ code and transpiles to ES5 using <a href="https://github.com/babel/babel">Babel</a>|
|
||||
|<a href="https://github.com/jupl/traceur-loader"><img width="48" height="48" src="https://google.github.com/traceur-compiler/logo/tc.svg"></a>|![traceur-npm]|![traceur-size]|Loads ES2015+ code and transpiles to ES5 using [Traceur](https://github.com/google/traceur-compiler)|
|
||||
|<a href="https://github.com/TypeStrong/ts-loader"><img width="48" height="48" src="https://cdn.rawgit.com/Microsoft/TypeScript/master/doc/logo.svg"></a>|![type-npm]|![type-size]|Loads TypeScript like JavaScript|
|
||||
|[`awesome-typescript-loader`](https://github.com/s-panferov/awesome-typescript-loader)|![awesome-typescript-npm]|![awesome-typescript-size]|Awesome TypeScript loader for webpack|
|
||||
|<a href="https://github.com/webpack-contrib/coffee-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/coffeescript.svg"></a>|![coffee-npm]|![coffee-size]|Loads CoffeeScript like JavaScript|
|
||||
|
||||
| Name | Status | Install Size | Description |
|
||||
| :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------: | :------------------------: | :--------------------------------------------------------------------------------------------------- |
|
||||
| <a href="https://github.com/webpack-contrib/script-loader">`<script>`</a> | ![script-npm] | ![script-size] | Executes a JavaScript file once in global context (like in script tag), `require()`s are not parsed |
|
||||
| <a href="https://github.com/babel/babel-loader"><img width="48" height="48" title="babel-loader" src="https://worldvectorlogo.com/logos/babel-10.svg"></a> | ![babel-npm] | ![babel-size] | Loads ES2015+ code and transpiles to ES5 using <a href="https://github.com/babel/babel">Babel</a> |
|
||||
| <a href="https://github.com/jupl/traceur-loader"><img width="48" height="48" src="https://google.github.com/traceur-compiler/logo/tc.svg"></a> | ![traceur-npm] | ![traceur-size] | Loads ES2015+ code and transpiles to ES5 using [Traceur](https://github.com/google/traceur-compiler) |
|
||||
| <a href="https://github.com/TypeStrong/ts-loader"><img width="48" height="48" src="https://cdn.rawgit.com/Microsoft/TypeScript/master/doc/logo.svg"></a> | ![type-npm] | ![type-size] | Loads TypeScript like JavaScript |
|
||||
| [`awesome-typescript-loader`](https://github.com/s-panferov/awesome-typescript-loader) | ![awesome-typescript-npm] | ![awesome-typescript-size] | Awesome TypeScript loader for webpack |
|
||||
| <a href="https://github.com/webpack-contrib/coffee-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/coffeescript.svg"></a> | ![coffee-npm] | ![coffee-size] | Loads CoffeeScript like JavaScript |
|
||||
|
||||
[script-npm]: https://img.shields.io/npm/v/script-loader.svg
|
||||
[script-size]: https://packagephobia.now.sh/badge?p=script-loader
|
||||
|
@ -210,14 +207,13 @@ or are automatically applied via regex from your webpack configuration.
|
|||
|
||||
#### Templating
|
||||
|
||||
|Name|Status|Install Size|Description|
|
||||
|:--:|:----:|:----------:|:----------|
|
||||
|<a href="https://github.com/webpack-contrib/html-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/html5.svg"></a>|![html-npm]|![html-size]|Exports HTML as string, requires references to static resources|
|
||||
|<a href="https://github.com/pugjs/pug-loader"><img width="48" height="48" src="https://cdn.rawgit.com/pugjs/pug-logo/master/SVG/pug-final-logo-_-colour-128.svg"></a>|![pug-npm]|![pug-size]|Loads Pug templates and returns a function|
|
||||
|<a href="https://github.com/peerigon/markdown-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/markdown.svg"></a>|![md-npm]|![md-size]|Compiles Markdown to HTML|
|
||||
|<a href="https://github.com/posthtml/posthtml-loader"><img width="48" height="48" src="https://posthtml.github.io/posthtml/logo.svg"></a>|![posthtml-npm]|![posthtml-size]|Loads and transforms a HTML file using [PostHTML](https://github.com/posthtml/posthtml)|
|
||||
|<a href="https://github.com/pcardune/handlebars-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/handlebars-1.svg"></a>|![hbs-npm]|![hbs-size]| Compiles Handlebars to HTML|
|
||||
|
||||
| Name | Status | Install Size | Description |
|
||||
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: | :--------------: | :-------------------------------------------------------------------------------------- |
|
||||
| <a href="https://github.com/webpack-contrib/html-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/html5.svg"></a> | ![html-npm] | ![html-size] | Exports HTML as string, requires references to static resources |
|
||||
| <a href="https://github.com/pugjs/pug-loader"><img width="48" height="48" src="https://cdn.rawgit.com/pugjs/pug-logo/master/SVG/pug-final-logo-_-colour-128.svg"></a> | ![pug-npm] | ![pug-size] | Loads Pug templates and returns a function |
|
||||
| <a href="https://github.com/peerigon/markdown-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/markdown.svg"></a> | ![md-npm] | ![md-size] | Compiles Markdown to HTML |
|
||||
| <a href="https://github.com/posthtml/posthtml-loader"><img width="48" height="48" src="https://posthtml.github.io/posthtml/logo.svg"></a> | ![posthtml-npm] | ![posthtml-size] | Loads and transforms a HTML file using [PostHTML](https://github.com/posthtml/posthtml) |
|
||||
| <a href="https://github.com/pcardune/handlebars-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/handlebars-1.svg"></a> | ![hbs-npm] | ![hbs-size] | Compiles Handlebars to HTML |
|
||||
|
||||
[html-npm]: https://img.shields.io/npm/v/html-loader.svg
|
||||
[html-size]: https://packagephobia.now.sh/badge?p=html-loader
|
||||
|
@ -234,15 +230,14 @@ or are automatically applied via regex from your webpack configuration.
|
|||
|
||||
#### Styling
|
||||
|
||||
|Name|Status|Install Size|Description|
|
||||
|:--:|:----:|:----------:|:----------|
|
||||
|<a href="https://github.com/webpack-contrib/style-loader">`<style>`</a>|![style-npm]|![style-size]|Add exports of a module as style to DOM|
|
||||
|<a href="https://github.com/webpack-contrib/css-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/css-3.svg"></a>|![css-npm]|![css-size]|Loads CSS file with resolved imports and returns CSS code|
|
||||
|<a href="https://github.com/webpack-contrib/less-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/less-63.svg"></a>|![less-npm]|![less-size]|Loads and compiles a LESS file|
|
||||
|<a href="https://github.com/webpack-contrib/sass-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/sass-1.svg"></a>|![sass-npm]|![sass-size]|Loads and compiles a Sass/SCSS file|
|
||||
|<a href="https://github.com/shama/stylus-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/stylus.svg"></a>|![stylus-npm]|![stylus-size]|Loads and compiles a Stylus file|
|
||||
|<a href="https://github.com/postcss/postcss-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/postcss.svg"></a>|![postcss-npm]|![postcss-size]|Loads and transforms a CSS/SSS file using [PostCSS](https://postcss.org)|
|
||||
|
||||
| Name | Status | Install Size | Description |
|
||||
| :-------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | :-------------: | :----------------------------------------------------------------------- |
|
||||
| <a href="https://github.com/webpack-contrib/style-loader">`<style>`</a> | ![style-npm] | ![style-size] | Add exports of a module as style to DOM |
|
||||
| <a href="https://github.com/webpack-contrib/css-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/css-3.svg"></a> | ![css-npm] | ![css-size] | Loads CSS file with resolved imports and returns CSS code |
|
||||
| <a href="https://github.com/webpack-contrib/less-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/less-63.svg"></a> | ![less-npm] | ![less-size] | Loads and compiles a LESS file |
|
||||
| <a href="https://github.com/webpack-contrib/sass-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/sass-1.svg"></a> | ![sass-npm] | ![sass-size] | Loads and compiles a Sass/SCSS file |
|
||||
| <a href="https://github.com/shama/stylus-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/stylus.svg"></a> | ![stylus-npm] | ![stylus-size] | Loads and compiles a Stylus file |
|
||||
| <a href="https://github.com/postcss/postcss-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/postcss.svg"></a> | ![postcss-npm] | ![postcss-size] | Loads and transforms a CSS/SSS file using [PostCSS](https://postcss.org) |
|
||||
|
||||
[style-npm]: https://img.shields.io/npm/v/style-loader.svg
|
||||
[style-size]: https://packagephobia.now.sh/badge?p=style-loader
|
||||
|
@ -259,11 +254,11 @@ or are automatically applied via regex from your webpack configuration.
|
|||
|
||||
#### Linting & Testing
|
||||
|
||||
|Name|Status|Install Size|Description|
|
||||
|:--:|:----:|:----------:|:----------|
|
||||
|<a href="https://github.com/webpack-contrib/mocha-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/mocha.svg"></a>|![mocha-npm]|![mocha-size]|Tests with mocha (Browser/NodeJS)|
|
||||
|<a href="https://github.com/webpack-contrib/eslint-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/eslint.svg"></a>|![eslint-npm]|![eslint-size]|PreLoader for linting code using ESLint|
|
||||
|<a href="https://github.com/webpack-contrib/jshint-loader"><img width="48" height="20.64" src="https://jshint.com/res/jshint-dark.png"></a>|![jshint-npm]|![jshint-size]|PreLoader for linting code using JSHint|
|
||||
| Name | Status | Install Size | Description |
|
||||
| :--------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: | :------------: | :-------------------------------------- |
|
||||
| <a href="https://github.com/webpack-contrib/mocha-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/mocha.svg"></a> | ![mocha-npm] | ![mocha-size] | Tests with mocha (Browser/NodeJS) |
|
||||
| <a href="https://github.com/webpack-contrib/eslint-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/eslint.svg"></a> | ![eslint-npm] | ![eslint-size] | PreLoader for linting code using ESLint |
|
||||
| <a href="https://github.com/webpack-contrib/jshint-loader"><img width="48" height="20.64" src="https://jshint.com/res/jshint-dark.png"></a> | ![jshint-npm] | ![jshint-size] | PreLoader for linting code using JSHint |
|
||||
|
||||
[mocha-npm]: https://img.shields.io/npm/v/mocha-loader.svg
|
||||
[mocha-size]: https://packagephobia.now.sh/badge?p=mocha-loader
|
||||
|
@ -276,14 +271,12 @@ or are automatically applied via regex from your webpack configuration.
|
|||
|
||||
#### Frameworks
|
||||
|
||||
|Name|Status|Install Size|Description|
|
||||
|:--:|:----:|:----------:|:----------|
|
||||
|<a href="https://github.com/vuejs/vue-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/vue-9.svg"></a>|![vue-npm]|![vue-size]|Loads and compiles Vue Components|
|
||||
|<a href="https://github.com/webpack-contrib/polymer-webpack-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/polymer.svg"></a>|![polymer-npm]|![polymer-size]|Process HTML & CSS with preprocessor of choice and `require()` Web Components like first-class modules|
|
||||
|<a href="https://github.com/TheLarkInn/angular2-template-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/angular-icon-1.svg"></a>|![angular-npm]|![angular-size]| Loads and compiles Angular 2 Components|
|
||||
|<a href="https://github.com/riot/webpack-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/riot.svg"></a>|![riot-npm]|![riot-size]| Riot official webpack loader|
|
||||
|
||||
|
||||
| Name | Status | Install Size | Description |
|
||||
| :----------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | :-------------: | :----------------------------------------------------------------------------------------------------- |
|
||||
| <a href="https://github.com/vuejs/vue-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/vue-9.svg"></a> | ![vue-npm] | ![vue-size] | Loads and compiles Vue Components |
|
||||
| <a href="https://github.com/webpack-contrib/polymer-webpack-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/polymer.svg"></a> | ![polymer-npm] | ![polymer-size] | Process HTML & CSS with preprocessor of choice and `require()` Web Components like first-class modules |
|
||||
| <a href="https://github.com/TheLarkInn/angular2-template-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/angular-icon-1.svg"></a> | ![angular-npm] | ![angular-size] | Loads and compiles Angular 2 Components |
|
||||
| <a href="https://github.com/riot/webpack-loader"><img width="48" height="48" src="https://worldvectorlogo.com/logos/riot.svg"></a> | ![riot-npm] | ![riot-size] | Riot official webpack loader |
|
||||
|
||||
[vue-npm]: https://img.shields.io/npm/v/vue-loader.svg
|
||||
[vue-size]: https://packagephobia.now.sh/badge?p=vue-loader
|
||||
|
@ -324,15 +317,15 @@ friendly** by using hashes.
|
|||
|
||||
Contributions go far beyond pull requests and commits. Although we love giving you the opportunity to put your stamp on webpack, we also are thrilled to receive a variety of other contributions including:
|
||||
|
||||
* [Documentation](https://github.com/webpack/webpack.js.org) updates, enhancements, designs, or bugfixes
|
||||
* Spelling or grammar fixes
|
||||
* README.md corrections or redesigns
|
||||
* Adding unit, or functional tests
|
||||
* Triaging GitHub issues -- especially determining whether an issue still persists or is reproducible.
|
||||
* [Searching #webpack on twitter](https://twitter.com/search?q=webpack) and helping someone else who needs help
|
||||
* Teaching others how to contribute to one of the many webpack's repos!
|
||||
* [Blogging, speaking about, or creating tutorials](https://github.com/webpack-contrib/awesome-webpack) about one of webpack's many features.
|
||||
* Helping others in our webpack [gitter channel](https://gitter.im/webpack/webpack).
|
||||
- [Documentation](https://github.com/webpack/webpack.js.org) updates, enhancements, designs, or bugfixes
|
||||
- Spelling or grammar fixes
|
||||
- README.md corrections or redesigns
|
||||
- Adding unit, or functional tests
|
||||
- Triaging GitHub issues -- especially determining whether an issue still persists or is reproducible.
|
||||
- [Searching #webpack on twitter](https://twitter.com/search?q=webpack) and helping someone else who needs help
|
||||
- Teaching others how to contribute to one of the many webpack's repos!
|
||||
- [Blogging, speaking about, or creating tutorials](https://github.com/webpack-contrib/awesome-webpack) about one of webpack's many features.
|
||||
- Helping others in our webpack [gitter channel](https://gitter.im/webpack/webpack).
|
||||
|
||||
If you are worried or don't know where to start, you can **always** reach out to [Sean Larkin (@TheLarkInn) on Twitter](https://twitter.com/thelarkinn) or simply submit an issue and a maintainer can help give you guidance!
|
||||
|
||||
|
@ -416,13 +409,12 @@ Most of the core team members, webpack contributors and contributors in the ecos
|
|||
|
||||
This is how we use the donations:
|
||||
|
||||
* Allow the core team to work on webpack
|
||||
* Thank contributors if they invested a large amount of time in contributing
|
||||
* Support projects in the ecosystem that are of great value for users
|
||||
* Support projects that are voted most (work in progress)
|
||||
* Infrastructure cost
|
||||
* Fees for money handling
|
||||
|
||||
- Allow the core team to work on webpack
|
||||
- Thank contributors if they invested a large amount of time in contributing
|
||||
- Support projects in the ecosystem that are of great value for users
|
||||
- Support projects that are voted most (work in progress)
|
||||
- Infrastructure cost
|
||||
- Fees for money handling
|
||||
|
||||
<h2 align="center">Premium Partners</h2>
|
||||
|
||||
|
@ -745,40 +737,31 @@ src="https://static.monei.net/monei-logo.svg" height="30" alt="MONEI"></a>
|
|||
<h2 align="center">Special Thanks to</h2>
|
||||
<p align="center">(In chronological order)</p>
|
||||
|
||||
* @google for [Google Web Toolkit (GWT)](http://www.gwtproject.org/), which aims to compile Java to JavaScript. It features a similar [Code Splitting](http://www.gwtproject.org/doc/latest/DevGuideCodeSplitting.html) as webpack.
|
||||
* @medikoo for [modules-webmake](https://github.com/medikoo/modules-webmake), which is a similar project. webpack was born because I wanted Code Splitting for modules-webmake. Interestingly the [Code Splitting issue is still open](https://github.com/medikoo/modules-webmake/issues/7) (thanks also to @Phoscur for the discussion).
|
||||
* @substack for [browserify](http://browserify.org/), which is a similar project and source for many ideas.
|
||||
* @jrburke for [require.js](https://requirejs.org/), which is a similar project and source for many ideas.
|
||||
* @defunctzombie for the [browser-field spec](https://github.com/defunctzombie/package-browser-field-spec), which makes modules available for node.js, browserify and webpack.
|
||||
* Every early webpack user, which contributed to webpack by writing issues or PRs. You influenced the direction...
|
||||
* @shama, @jhnns and @sokra for maintaining this project
|
||||
* Everyone who has written a loader for webpack. You are the ecosystem...
|
||||
* Everyone I forgot to mention here, but also influenced webpack.
|
||||
|
||||
- @google for [Google Web Toolkit (GWT)](http://www.gwtproject.org/), which aims to compile Java to JavaScript. It features a similar [Code Splitting](http://www.gwtproject.org/doc/latest/DevGuideCodeSplitting.html) as webpack.
|
||||
- @medikoo for [modules-webmake](https://github.com/medikoo/modules-webmake), which is a similar project. webpack was born because I wanted Code Splitting for modules-webmake. Interestingly the [Code Splitting issue is still open](https://github.com/medikoo/modules-webmake/issues/7) (thanks also to @Phoscur for the discussion).
|
||||
- @substack for [browserify](http://browserify.org/), which is a similar project and source for many ideas.
|
||||
- @jrburke for [require.js](https://requirejs.org/), which is a similar project and source for many ideas.
|
||||
- @defunctzombie for the [browser-field spec](https://github.com/defunctzombie/package-browser-field-spec), which makes modules available for node.js, browserify and webpack.
|
||||
- Every early webpack user, which contributed to webpack by writing issues or PRs. You influenced the direction...
|
||||
- @shama, @jhnns and @sokra for maintaining this project
|
||||
- Everyone who has written a loader for webpack. You are the ecosystem...
|
||||
- Everyone I forgot to mention here, but also influenced webpack.
|
||||
|
||||
[npm]: https://img.shields.io/npm/v/webpack.svg
|
||||
[npm-url]: https://npmjs.com/package/webpack
|
||||
|
||||
[node]: https://img.shields.io/node/v/webpack.svg
|
||||
[node-url]: https://nodejs.org
|
||||
|
||||
[deps]: https://img.shields.io/david/webpack/webpack.svg
|
||||
[deps-url]: https://david-dm.org/webpack/webpack
|
||||
|
||||
[tests]: https://img.shields.io/travis/webpack/webpack/master.svg
|
||||
[tests-url]: https://travis-ci.org/webpack/webpack
|
||||
|
||||
[prs]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
|
||||
[prs-url]: https://webpack.js.org/contribute/
|
||||
|
||||
[builds-url]: https://ci.appveyor.com/project/sokra/webpack/branch/master
|
||||
[builds]: https://ci.appveyor.com/api/projects/status/github/webpack/webpack?svg=true
|
||||
|
||||
[builds2]: https://dev.azure.com/webpack/webpack/_apis/build/status/webpack.webpack
|
||||
[builds2-url]: https://dev.azure.com/webpack/webpack/_build/latest?definitionId=3
|
||||
|
||||
[licenses-url]: https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fwebpack%2Fwebpack?ref=badge_shield
|
||||
[licenses]: https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fwebpack%2Fwebpack.svg?type=shield
|
||||
|
||||
[cover]: https://img.shields.io/coveralls/webpack/webpack.svg
|
||||
[cover-url]: https://coveralls.io/r/webpack/webpack/
|
||||
|
|
|
@ -67,10 +67,10 @@ yarn pretty
|
|||
|
||||
This performs linting on:
|
||||
|
||||
* eslint (code-lint script)
|
||||
* schema + dependencies (jest-lint script)
|
||||
* types (type-lint script)
|
||||
* format + generated files (special-lint script)
|
||||
- eslint (code-lint script)
|
||||
- schema + dependencies (jest-lint script)
|
||||
- types (type-lint script)
|
||||
- format + generated files (special-lint script)
|
||||
|
||||
```bash
|
||||
yarn lint
|
||||
|
|
|
@ -138,6 +138,7 @@
|
|||
"special-lint-fix": "node tooling/inherit-types --write --override && node tooling/format-schemas --write && node tooling/format-file-header --write && node tooling/compile-to-definitions --write",
|
||||
"fix": "yarn code-lint --fix && yarn special-lint-fix",
|
||||
"pretty": "prettier --loglevel warn --write \"*.{ts,js,json,yml,yaml}\" \"{setup,lib,bin,hot,benchmark,tooling,schemas}/**/*.{js,json}\" \"test/*.js\" \"test/helpers/*.js\" \"test/{configCases,watchCases,statsCases,hotCases}/**/webpack.config.js\" \"examples/**/webpack.config.js\"",
|
||||
"pretty:md": "prettier --write ./**.md",
|
||||
"jest-lint": "node --max-old-space-size=4096 node_modules/jest-cli/bin/jest --testMatch \"<rootDir>/test/*.lint.js\" --no-verbose",
|
||||
"benchmark": "node --max-old-space-size=4096 --trace-deprecation node_modules/jest-cli/bin/jest --testMatch \"<rootDir>/test/*.benchmark.js\" --runInBand",
|
||||
"cover": "yarn cover:all && yarn cover:report",
|
||||
|
@ -157,6 +158,9 @@
|
|||
"*.js|{lib,setup,bin,hot,tooling,schemas}/**/*.js|test/*.js|{test,examples}/**/webpack.config.js}": [
|
||||
"eslint --cache"
|
||||
],
|
||||
"*.md": [
|
||||
"yarn pretty:md"
|
||||
],
|
||||
"*.md|{.github,benchmark,bin,examples,hot,lib,schemas,setup,tooling}/**/*.{md,yml,yaml,js,json}": [
|
||||
"cspell"
|
||||
]
|
||||
|
|
Loading…
Reference in New Issue