/prettier

Prettier is an opinionated code formatter.

Primary LanguageJavaScriptMIT LicenseMIT

🍴 This is a fork.

Compared to prettier, @brigad/prettier moves binary operators to the beginning of new lines in long expressions instead of the end of the previous line. That's it.

// Before:
const before =
  bom.length >= 2 &&
  ((bom.charCodeAt(0) === 0xff && bom.charCodeAt(1) === 0xfe) ||
    (bom.charCodeAt(0) === 0xfe && bom.charCodeAt(1) === 0xff));

// After:
const after =
  bom.length >= 2 &&
  ((bom.charCodeAt(0) === 0xff && bom.charCodeAt(1) === 0xfe) ||
    (bom.charCodeAt(0) === 0xfe && bom.charCodeAt(1) === 0xff));

Usage

If you use Yarn, you can install using an alias so that require('prettier') transparently resolves to this fork:

$ yarn add -D prettier@npm:@brigad/prettier

Releases

Releases of the forked package are done by rebasing the line-before-operator branch on top of the most recent version tag in master.

# Get the latest changes and update the master branch
$ git checkout master
$ git pull
$ git push fork
# Rebase the release branch on the latest version
$ git checkout line-before-operator
$ git rebase x.y.z
# Fix conflicts as necessary
$ git rebase --continue
# Update packages to give accurate test results
$ yarn install
# If any conflicts in snapshots, discard and update automatically
$ yarn test -u
# With rebasing done, run tests, push tags, build, and publish
$ yarn test
$ git tag x.y.z-fork
$ git push --force-with-lease
$ git push --tags
$ yarn run build
$ yarn run test:dist
$ cd dist
$ npm publish

Prettier Banner

Opinionated Code Formatter

JavaScript · TypeScript · Flow · JSX · JSON
CSS · SCSS · Less
HTML · Vue · Angular
GraphQL · Markdown · YAML
Your favorite language?

Azure Pipelines Build Status Codecov Coverage Status Blazing Fast
npm version weekly downloads from npm code style: prettier Chat on Gitter Follow Prettier on Twitter

Intro

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.

Input

foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());

Output

foo(
  reallyLongArg(),
  omgSoManyParameters(),
  IShouldRefactorThis(),
  isThereSeriouslyAnotherOne(),
);

Prettier can be run in your editor on-save, in a pre-commit hook, or in CI environments to ensure your codebase has a consistent style without devs ever having to post a nit-picky comment on a code review ever again!


Documentation

Install · Options · CLI · API

Playground


Badge

Show the world you're using Prettiercode style: prettier

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

Contributing

See CONTRIBUTING.md.