joakim / prettiest

Prettiest is a somewhat less opinionated code formatter.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Prettiest

(a somewhat less) Opinionated Code Formatter

Prettiest is a friendly yet cheeky fork of Prettier that is, subjectively speaking, the prettiest of the two.

It was made to serve my own requirements and is not intended as a publicly maintained project. I have made it public in case it might be useful for others, but it comes with no guarantees. Use at your own risk.

The only changes made to Prettier are the addition of extra options.

Install

  1. Remove Prettier if already installed: yarn remove prettier
  2. Install Prettiest to replace it: yarn add joakim/prettiest --dev

Prettiest will be installed as prettier.

Extra options

Option Default Override
Brace style
Style of braced statements (see Indentation style on Wikipedia).

Valid options:
  • 1tbs – "The One True Brace Style" with closing and opening braces on the same line
  • stroustrup – Bjarne Stroustrup's variant with newline between conditional blocks
Credits: @phaux in PR #6017
"1tbs" CLI: --brace-style <1tbs|stroustrup>
API: braceStyle: "<1tbs|stroustrup>"

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.

About

Prettiest is a somewhat less opinionated code formatter.

License:MIT License


Languages

Language:JavaScript 84.4%Language:CSS 7.0%Language:TypeScript 4.4%Language:HTML 3.8%Language:Vue 0.4%Language:Shell 0.0%