prettierx

prettierx - less opinionated code formatter fork of prettier

Unofficial fork, intended to provide some additional options to help improve consistency with feross/standard and Flet/semistandard. This fork is an attempt to pick up where arijs/prettier-miscellaneous left off.

prettierx as a Prettier plugin

Provides the additional formatting options in a prettier plugin (or two).

Status: experimental

• brodybits/prettier-plugin-prettierx-babel
• brodybits/prettier-plugin-prettierx-typescript

Major TODO items:

• update to use recent prettierx which uses Babel parser to parse TypeScript by default ref: brodybits/prettierx#54
• support the additional formatting options from the command line, somehow (additional formatting options will work from the command line if run with the plugin)
• improve the documentation

ref: brodybits/prettierx#8

CLI Usage

Quick CLI usage:

prettierx <options> <file(s)>

Additional prettierx options

Option	Default value	CLI Override	API Override	Description
Align object properties	false	--align-object-properties	alignObjectProperties: <bool>	Align colons in multiline object literals (not applied with any of the JSON parsers).
Space before function parentheses	false	--space-before-function-paren	spaceBeforeFunctionParen: <bool>	Put a space before function parenthesis, in all declarations. (Default is to put a space before function parenthesis for anonymous functions only.)
Spaces around the star (*) in generator functions	false	--generator-star-spacing	generatorStarSpacing: <bool>	Add spaces around the star (*) in generator functions (before and after - from eslint). (Default is after only.)
Spaces around the star (*) in yield* expressions	false	--yield-star-spacing	yieldStarSpacing: <bool>	Add spaces around the star (*) in yield* expressions (before and after - from eslint).
Indent chains	true	--no-indent-chains	indentChains: <bool>	Print indents at the start of chained calls.
Align ternary lines	true	--no-align-ternary-lines	alignTernaryLines: <bool>	Keep default alignment of ternary expression lines, which is in conflict with "Standard JS" formatting in case of certain nested ternary expressions. See ./docs/options.md ..
paren spacing	false	--paren-spacing	parenSpacing: <bool>	Print spaces between parens, WordPress style (not recommended with default `arrowParens: "always" setting). Status: experimental, with some known paren spacing formatting issues.
break before else	false	--break-before-else	breakBeforeElse: <bool>	Always add a line break before else.
Formatting of import statements	auto	see ./docs/options.md	see ./docs/options.md	Formatting of import statements, may be oneline to avoid conflict with VSCode "Organize Imports" feature.
HTML void element tags	false	--html-void-tags	Format void HTML elements as void tags.
break long method chains	false	--break-long-method-chains	breakLongMethodChains: <bool>	Break method chains with more than 3 method calls, like Prettier 1.x.

"Standard JS" formatting options

The following options should be used to format the code as consistently as possible with "Standard JS":

• --arrow-parens avoid (arrowParens: "avoid")
• --generator-star-spacing (generatorStarSpacing: true)
• --space-before-function-paren (spaceBeforeFunctionParen: true)
• --single-quote (singleQuote: true)
• --jsx-single-quote (jsxSingleQuote: true)
• --no-semi (semi: false)
• --yield-star-spacing (yieldStarSpacing: true)
• --trailing-comma none (trailingComma: "none")
• and possibly --no-align-ternary-lines (alignTernaryLines: false) - see ./docs/options.md for some more info

Note that this tool does not follow any of the other "Standard JS" rules. It is recommended to use this tool together with eslint, in some form, to archive correct formatting according to "Standard JS".

Any known conflicts with "Standard JS" will be tracked in open issues with the conflict-with-standard tag.

recommended options

• --arrow-parens avoid (arrowParens: "avoid"), especially in combination with --paren-spacing (parenSpacing: true).
• break-long-method-chains

Input

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

Output

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

Integration with eslint

A couple packages by @aMarCruz (Alberto Martínez):

• eslint-plugin-prettierx
• eslint-config-standardized

---

Contributing

See CONTRIBUTING.md.

Changelog

prettierx 0.16.0

• add & implement --break-long-method-chains option
• Update fast-glob -> 3.2.5 in dependencies
• cleanup: remove extra parent.object conditions not needed

compare prettierx-0.15.0...prettierx-0.16.0