prettier-standard
Prettier and standard brought together!
Last updated a month ago by sheerun .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install prettier-standard 
SYNC missed versions from official npm registry.

prettier-standard

Build Status version Modern Node

Formats with prettier (actually prettierx) and lints with eslint preconfigured with standard rules (✿◠‿◠)

You don't have to fix any whitespace errors and waste time configuring eslint presets :relieved:

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

Usage
  $ prettier-standard [<glob>]

Options
  --format  Just format all files in current repository
  --lint    Additionally lint code after formatting
  --check   Do not format, just check formatting
  --staged  Run only on staged files
  --changed Run only on changed files
  --since   Run only on changed files since given revision
  --lines   Run only on changed lines (warning: experimental!)
  --stdin   Force reading input from stdin
  --parser  Force parser to use for stdin (default: babel)
  --help    Tells how to use prettier-standard

Examples
  $ prettier-standard --changed --lint
  $ prettier-standard --lint '**/*.{js,css}'
  $ prettier-standard --since master
  $ "precommit": "prettier-standard --lint --staged" # in package.json
  $ echo 'const {foo} = "bar";' | prettier-standard --stdin
  $ echo '.foo { color: "red"; }' | prettier-standard --parser css

Warning: --lines flag should be considered experimental as prettier has issues with range formatting:

Examples

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

{
  "scripts": {
    "format": "prettier-standard --format"
  }
}

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

{
  "scripts": {
    "precommit": "lint-staged"
  },
  "lint-staged": {
    "linters": {
      "**/*": ["prettier-standard --lint", "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.

Vim

It's probably best to use ale plugin. It supports multiple fixers, including prettier-standard:

Plug 'w0rp/ale'
let g:ale_fixers = {'javascript': ['prettier_standard']}
let g:ale_linters = {'javascript': ['']}
let g:ale_fix_on_save = 1

Sublime Text 3

It's possible to use 'prettier-standard' with Sublime Text 3.

  1. Install 'prettier-standard' globally according to the installation instructions above.
  2. Find the location of your installed executable file. On a unix based system (like MacOS):
$ which prettier-standard
  1. Copy the location. (e.g. /usr/local/bin/prettier-standard)
  2. Install SublimeJsPrettier according to their installation instructions.
  3. Open SublimeJsPrettier's default settings in Sublime and copy the line: "prettier_cli_path": ""
  4. Open SublimeJsPrettier's user settings in Sublime and add the line with the correct location of the 'prettier-standard' executable.
{
  "prettier_cli_path": "/usr/local/bin/prettier-standard"
}

You can now use 'prettier-standard' in Sublime Text 3 by opening the Command Palette (super + shift + p) and typing JsPrettier: Format Code.

Customizing

You can use .prettierrc for overriding some options, e.g to use semistandard:

{
  "semi": true
}

You can also configure linting by creating appropriate .eslintrc file that will override defaults:

{
  "rules": {
    "eqeqeq": "off"
  }
}

Ignoring Files

You can use .prettierignore file for ignoring any files to format, e.g:

dist
.next
**/*.ts

You can also use .eslintignore to format some files, but prevent linting others.

API

prettier-standard exposes the same API as prettier: https://prettier.io/docs/en/api.html

It also exposes one additional method that works similarly to its CLI:

run(cwd, config)

  • cwd - path where to execute prettier-standard
  • config - object configuring execution
    • patterns - patterns to use for formatting files (array of strings)
    • check - whether to check instead of format files (boolean, default: false)
    • lint - whether to perform linting (boolean, default: false)
    • changed - whether to format only changed lines (boolean, experimental, default: false)
    • since - format changes that happened since given branch (string, optional, example: "master")
    • onProcess - callback that is called for each processed file matching pattern: { file, formatted, check, runtime }

LICENSE

MIT

Current Tags

  • 14.0.0-beta.5                                ...           beta (9 months ago)
  • 16.3.0                                ...           latest (a month ago)

62 Versions

  • 16.3.0                                ...           a month ago
  • 16.2.1                                ...           3 months ago
  • 16.2.0                                ...           3 months ago
  • 16.1.0                                ...           6 months ago
  • 16.0.0                                ...           6 months ago
  • 15.0.1                                ...           8 months ago
  • 15.0.0                                ...           8 months ago
  • 14.1.1 [deprecated]           ...           8 months ago
  • 14.1.0 [deprecated]           ...           8 months ago
  • 14.0.7 [deprecated]           ...           8 months ago
  • 14.0.6 [deprecated]           ...           8 months ago
  • 14.0.5 [deprecated]           ...           9 months ago
  • 14.0.4 [deprecated]           ...           9 months ago
  • 14.0.3 [deprecated]           ...           9 months ago
  • 14.0.2 [deprecated]           ...           9 months ago
  • 14.0.1 [deprecated]           ...           9 months ago
  • 14.0.0 [deprecated]           ...           9 months ago
  • 14.0.0-beta.5                                ...           9 months ago
  • 14.0.0-beta.3                                ...           9 months ago
  • 14.0.0-beta.2                                ...           9 months ago
  • 14.0.0-beta.1                                ...           9 months ago
  • 14.0.0-beta.0                                ...           9 months ago
  • 13.0.6 [deprecated]           ...           9 months ago
  • 13.0.5 [deprecated]           ...           9 months ago
  • 13.0.4 [deprecated]           ...           9 months ago
  • 13.0.3 [deprecated]           ...           9 months ago
  • 13.0.2 [deprecated]           ...           9 months ago
  • 13.0.1 [deprecated]           ...           9 months ago
  • 13.0.0 [deprecated]           ...           9 months ago
  • 12.0.2 [deprecated]           ...           9 months ago
  • 12.0.1 [deprecated]           ...           9 months ago
  • 12.0.0 [deprecated]           ...           9 months ago
  • 12.0.0-beta.2                                ...           9 months ago
  • 12.0.0-beta.0                                ...           9 months ago
  • 11.0.0 [deprecated]           ...           9 months ago
  • 9.1.1 [deprecated]           ...           a year ago
  • 9.1.0 [deprecated]           ...           a year ago
  • 9.0.0 [deprecated]           ...           a year ago
  • 9.0.0-beta.0                                ...           a year ago
  • 8.0.1 [deprecated]           ...           2 years ago
  • 8.0.0 [deprecated]           ...           2 years ago
  • 7.0.3 [deprecated]           ...           3 years ago
  • 7.0.2 [deprecated]           ...           3 years ago
  • 7.0.1 [deprecated]           ...           3 years ago
  • 7.0.0 [deprecated]           ...           3 years ago
  • 6.0.0 [deprecated]           ...           3 years ago
  • 5.1.0 [deprecated]           ...           3 years ago
  • 5.0.0 [deprecated]           ...           3 years ago
  • 4.1.0 [deprecated]           ...           3 years ago
  • 4.0.0 [deprecated]           ...           3 years ago
  • 3.0.1 [deprecated]           ...           3 years ago
  • 3.0.0 [deprecated]           ...           3 years ago
  • 2.0.2 [deprecated]           ...           3 years ago
  • 2.0.1 [deprecated]           ...           3 years ago
  • 2.0.0 [deprecated]           ...           3 years ago
  • 1.0.6 [deprecated]           ...           3 years ago
  • 1.0.5 [deprecated]           ...           3 years ago
  • 1.0.4 [deprecated]           ...           3 years ago
  • 1.0.3 [deprecated]           ...           3 years ago
  • 1.0.2 [deprecated]           ...           3 years ago
  • 1.0.1 [deprecated]           ...           3 years ago
  • 1.0.0 [deprecated]           ...           3 years ago

Copyright 2014 - 2016 © taobao.org |