Skip to content

Commit

Permalink
[prettierx] quick doc updates
Browse files Browse the repository at this point in the history
- Add note that it is desired to provide the additional formatting
  options in a prettier plugin as discussed in #37

- Add phrase that #40 is resolved by
  #41 which is to be included by an upcoming merge.
  • Loading branch information
Christopher J. Brody committed Jan 22, 2019
1 parent 5c53b1d commit b808119
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Language parsers are supported as if this were `prettier` version `1.15.3` / `1.

Minimum Node.js version: 6

FUTURE TODO: It is desired to provide the additional formatting options in a prettier plugin as discussed in ([`brodybits/prettierx#37`](https://github.com/brodybits/prettierx/issues/37)).

## CLI Usage

**Quick CLI usage:**
Expand Down Expand Up @@ -38,7 +40,7 @@ The following options should be used to _format_ the code according to [standard
- `--no-semi` (`semi: false`)
- `--yield-star-spacing` (`yieldStarSpacing: true`)

Known conflict with `standard` in ternary returning objects ([brodybits/prettierx#40](https://github.com/brodybits/prettierx/issues/40))
Known conflict with `standard` in ternary returning objects ([brodybits/prettierx#40](https://github.com/brodybits/prettierx/issues/40)), which is resolved by [brodybits/prettierx#41](https://github.com/brodybits/prettierx/pull/41) which is to be included by an upcoming merge.

Note that this tool does _not_ follow any of the other [standard js](https://standardjs.com/) rules. It is recommended to use this tool together with eslint, in some form, to achive correct formatting according to [standard js](https://standardjs.com/).

Expand Down

0 comments on commit b808119

Please sign in to comment.