Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brodycj/prettier-plugin-x
https://github.com/brodycj/prettier-plugin-x
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brodycj/prettier-plugin-x
- Owner: brodycj
- License: other
- Created: 2019-11-19T00:08:50.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-25T00:10:13.000Z (over 3 years ago)
- Last Synced: 2024-10-31T19:39:32.896Z (3 months ago)
- Language: JavaScript
- Size: 60.5 KB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-Apache-2.0.txt
Awesome Lists containing this project
README
# prettier-plugin-x
[](./LICENSE.md)
[](https://www.npmjs.com/package/prettier-plugin-x)
Use [`prettier x-formatter`](https://github.com/brodybits/prettier-x-formatter) -
a code formatter with enhanced estree printer options from
**[prettierX](https://github.com/brodybits/prettierx)**, all in a
**[Prettier plugin](https://prettier.io/docs/en/plugins.html)**.
Supported parsers:
- **[Babel](https://babeljs.io/)**
- **[Microsoft TypeScript](https://github.com/Microsoft/TypeScript)**
Requires explicit configuration of parser. Recommended configuation helpers:
- [`prettier-config-x`](https://github.com/brodybits/prettier-config-x)
- [`prettier-config-x-standard`](https://github.com/brodybits/prettier-config-x-standard)
Recommended alternative: [`prettier-plugin-x-babel`](https://github.com/brodybits/prettier-plugin-x-babel),
with fixed use of **[Babel](https://babeljs.io/)** parser for ES languages JavaScript, Flow, and TypeScript.
Includes options from **[prettierX](https://github.com/brodybits/prettierx)** for
improved consistency with **["Standard JS"](https://standardjs.com/)** formatting,
for example:
```js
function * a () {}
console.log(typeof a)
```
with the following `.prettierrc` configuration:
```js
{
semi: false,
generatorStarSpacing: true,
spaceBeforeFunctionParen: true
}
```
Note that for the non-Babel `x-typescript` parser this plugin uses the TypeScript parser that is bundled with stock Prettier.
## Installation
with Yarn (recommended):
```console
yarn add --dev prettier-plugin-x
```
or with npm:
```console
npm install --save-dev prettier-plugin-x
```
## Sample usage
```console
prettier --config ./sample-prettierx-prettierrc --parser=x-babel --check sample.js
```
with `babel-ts` parser:
```console
prettier --config ./sample-prettierx-prettierrc --parser=x-babel-ts --check sample.js
```
or with the TypeScript parser:
```console
prettier --config ./sample-prettierx-prettierrc --parser=x-typescript --check sample.js
```
with `babel-flow` parser:
```console
prettier --config ./sample-prettierx-prettierrc --parser=x-babel-flow --check sample.js
```
## Thanks and credits
- Thanks to **[`@prettier/plugin-php`](https://github.com/prettier/plugin-php)**
for an easy-to-understand Prettier plugin,
which helped with the initial structure of this Prettier plugin.