JSPM

  • Created
  • Published
  • Downloads 17546
  • Score
    100M100P100Q137440F
  • License MIT

Prettier and standard brought together!

Package Exports

  • prettier-standard

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (prettier-standard) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

(✿◠‿◠) prettier-standard Build Status version Modern Node

prettier and standard brought together

Installation

yarn add --dev prettier-standard

If you're using the npm: npm install --save-dev prettier-standard.

You can also install globally with npm install -g prettier-standard

Usage

Prettier and standard brought together!

Usage
  $ prettier-standard [<glob>...]

Options
  --log-level  Log level to use (default: warn)

Examples
  $ prettier-standard 'src/**/*.js'
  $ echo "const {foo} = "bar";" | prettier-standard

Typically you'll use this in your npm scripts (or package scripts):

{
  "scripts": {
    "format": "prettier-standard 'src/**/*.js'"
  }
}

We also encourage to use husky and lint-staged. You can configure it as follows:

{
  "lint-staged": {
    "linters": {
      "src/**/*.js": [
        "prettier-standard",
        "git add"
      ]
    }
  }
}

NOTE: Unlike prettier this package simplifies your workflow by making --write flag a default, and allowing for passing code to stdin without additional --stdin flag. Now that's prettier!

Vim

Vim users can add the following to their .vimrc:

autocmd FileType javascript set formatprg=prettier-standard

This makes prettier-standard power the gq command for automatic formatting without any plugins. You can also add the following to your .vimrc to run prettier-standard when .js files are saved:

autocmd BufWritePre *.js :normal gggqG

Customizing

Because this package is built on top of prettier-eslint, you can fully configure its behavior with custom .eslintrc file. For example you might want to opt-out of single quotes with following. Any eslint rules are supported.

{
  "rules": {
    "quotes": ["error", "double"]
  }
}

Additionaly you can use different version of eslint and prettier, just include them as a devDependency of your project. prettier-standard will properly recognize this, and use your versions of prettier and eslint instead.

Contributors

This package follows all-contributors specification.


Adam Stankiewicz

💻 🚇

Kent C. Dodds

💻

Adam Harris

💻

Benoit Averty

🐛

LICENSE

MIT