Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamolegga/prettier-loader
prettier loader for webpack
https://github.com/iamolegga/prettier-loader
loader prettier webpack
Last synced: 17 days ago
JSON representation
prettier loader for webpack
- Host: GitHub
- URL: https://github.com/iamolegga/prettier-loader
- Owner: iamolegga
- License: mit
- Created: 2017-06-20T14:56:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T04:57:33.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T07:07:24.050Z (7 months ago)
- Topics: loader, prettier, webpack
- Language: JavaScript
- Homepage:
- Size: 957 KB
- Stars: 30
- Watchers: 3
- Forks: 8
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# prettier-loader
[Prettier](https://github.com/prettier/prettier) loader for [Webpack](https://github.com/webpack/webpack).
---
[![Travis][travis-badge]][travis]
[![Coverage Status][coveralls-badge]][coveralls]
[![Snyk Vulnerabilities for npm package][snyk-badge]][snyk]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmcharts]
[![Node version support][node-version]][package]
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
## Purpose
Prettier is one of the best tools that really help developers not to waste time on codestyle.
Listed below are some of the ways one could employ prettier in a project:
- [Editor Integration](https://prettier.io/docs/en/editors.html)
- Pros:
- no overhead bootstrapping code
- autoformatting on every save
- Cons:
- every developer needs to setup and configure editor's plugin manually
- teammates can have conflicting plugin settings that might override default settings in an unpredictable way. Or one could forget to install `node_modules` and a globally installed `prettier` will be used instead, which might be of older version, etc. This leads to frustrating hiccups in the workflow and, potentially, bugs.
- [Pre-commit Hook](https://prettier.io/docs/en/precommit.html)
- Pros:
- works in the background (i.e. developer doesn't have to think about it)
- consistent prettier settings in the project
- Cons:
- you can not see prettier changes on save
- [Watching For Changes](https://prettier.io/docs/en/watching-files.html)
+ Pros:
- no overhead bootstrapping code
- autoformatting on every save
- works in the background
- consistent prettier settings in the project
- Cons:
- if you already have another watcher (e.g. `webpack-dev-server` or `watchman`), you'll be wasting resources and your bundler will be triggered twice on every change: first by user, then by prettier formatting
- [CLI](https://prettier.io/docs/en/cli.html)
+ Pros:
- no overhead bootstrapping code
- Cons:
- you can not see prettier changes on save
- prone to errors unless stored somewhere (e.g. npm-scripts)
- [This Webpack Loader](https://www.npmjs.com/package/prettier-loader)
+ Pros:
- autoformatting on every save (if working with webpack-dev-server)
- works in the background
- consistent prettier settings in the project
- updates all the codebase when new prettier version is released
- Cons:
- works only on webpack-dependent projects
In short, idea is to make source code auto-`prettier`-fy on every save. But to do it in a cross-IDE manner. Use of `webpack`, eliminates the need to install and configure plugins on each developer's machine and also provides better efficency, as no other watchers are needed.
## Features
- support [prettier configuration files](https://prettier.io/docs/en/configuration.html): `.prettierrc`, `prettier.config.js`, `"prettier"` key in your `package.json` file
- support of [ignoring code](https://prettier.io/docs/en/ignore.html) using both comments and `.prettierignore` file
- override configuration files in loader options
- zero configuration of loader options for supporting all features out of the box
## Requirements
- webpack >= 2
- prettier >= 1.6
Create an issue on pr, if you __really__ need to support Webpack 1.
## Installation
```
npm install prettier-loader prettier --save-dev
```
## Usage
### Minimal config example
```js
// webpack.config.js
module.exports = {
// ...
module: {
rules: [
{
test: /\.jsx?$/,
use: {
loader: 'prettier-loader',
exclude: /node_modules/,
}
}
]
}
};
```
### Full config example with description
```js
// webpack.config.js
module.exports = {
// ...
module: {
rules: [
{
test: /\.jsx?$/,
use: {
loader: 'prettier-loader',
// force this loader to run first if it's not first in loaders list
enforce: 'pre',
// avoid running prettier on all the files!
// use it only on your source code and not on dependencies!
exclude: /node_modules/,
// additional prettier options assigned to options in
// - .prettierrc,
// - prettier.config.js,
// - "prettier" property in package.json
options: {
trailingComma: 'es5',
tabWidth: 4,
// additional options object for resolveConfig method
// @see https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath-options
resolveConfigOptions: {
editorconfig: true,
config: 'config/prettier.config.js'
},
// skip rewriting source file.
// if true, only prettier the output
skipRewritingSource: false,
// skip prettifying file at startup.
// if true, prettier will be triggered after the modification of a file
ignoreInitial: false,
},
}
}
]
}
};
```
### Working with HTML preprocessor
If you work with HTML preprocessor (Twig, EJS, Nunjucks, ...), you may want to process the output stream.
Still you don't want the input template to be rewritten with the output.
In that case, you'll need to tell the loader to keep the source file unchanged.
```js
// webpack.config.js
module.exports = {
// ...
module: {
rules: [
{
test: /\.njk?$/,
use: [
{
loader: 'html-loader',
},
{
loader: 'prettier-loader',
options: {
skipRewritingSource: true,
},
},
{
loader: 'nunjucks-html-loader',
},
],
}
]
}
};
```
## Pro Tip
Install and use it only in development environment if you minimize code for production, don't do unnecessary work!
## Known issue
As a loader, that is modifying source code, it has [known issue](https://github.com/iamolegga/prettier-loader/issues/1) with double compilation in watch mode. With current `webpack` API this problem can not be solved (the same problem exists in [other](https://github.com/rchaser53/awesome-prettier-loader/issues/3) [similar](https://github.com/webpack-contrib/eslint-loader/issues/303) [projects](https://github.com/hawkins/prettier-webpack-plugin/issues/2)). [Webpack maintainers are not going to help with this](https://github.com/webpack/webpack/issues/9763).
## Contributing
All pull requests that respect next rules are welcome:
- Before opening pull request to this repo run `npm t` to lint, prettify and run test on code.
- All bugfixes and features should contain tests.
## License
MIT License
Copyright (c) 2017 Oleg Repin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[travis-badge]: https://img.shields.io/travis/iamolegga/prettier-loader.svg?style=flat-square
[travis]: https://travis-ci.org/iamolegga/prettier-loader
[coveralls-badge]: https://img.shields.io/coveralls/github/iamolegga/prettier-loader.svg?style=flat-square
[coveralls]: https://coveralls.io/github/iamolegga/prettier-loader?branch=master
[snyk-badge]: https://img.shields.io/snyk/vulnerabilities/npm/prettier-loader
[snyk]: https://snyk.io/test/github/iamolegga/prettier-loader
[version-badge]: https://img.shields.io/npm/v/prettier-loader.svg?style=flat-square
[package]: https://www.npmjs.com/package/prettier-loader
[downloads-badge]: https://img.shields.io/npm/dm/prettier-loader.svg?style=flat-square
[npmcharts]: https://npmcharts.com/compare/prettier-loader
[node-version]: https://img.shields.io/node/v/prettier-loader.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/prettier-loader.svg?style=flat-square
[license]: https://github.com/iamolegga/prettier-loader/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/iamolegga/prettier-loader/blob/master/CODE_OF_CONDUCT.md