Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 2.45 KB

README.md

File metadata and controls

66 lines (41 loc) · 2.45 KB

mj-pa

code style: prettier Known Vulnerabilities Try on RunKit

about

  • mj-pa is my personal Prettier config tailored to format JS, JSON, & JSX.
  • Opinionated by nature, it seeks to improve code simplicity and readability.
  • For best results, mj-pa should be used in a React- or Vue-based environment.

Here is a look at the configuration object it exports.

output of .prettierrc.json

usage

IMPORTANT: You must have Prettier installed in your project for mj-pa to work properly.

1) install

Using npm

npm install --save-dev mj-pa

Using yarn

yarn add -D mj-pa

2) configure

Edit the package.json file for your project to extend Prettier with mj-pa. Or, to be more specific, copy the following line of code and paste it underneath the version line of your project's package.json file in the root directory.

{
 "prettier": "mj-pa"
}

3) format

Nothing changes here; run the check or write command as you normally would

npx prettier --check .
npx prettier --write .

output

👉 FUN FACT: mj-pa is short for "Make JavaScript Pretty Again"— because what JS developer doesn't love a good one-liner? 😎

Here is an example of how your VSCode logs will appear when mj-pa is used to extend the default configuration so formatting can be applied in turn by the VS Code plugin for Prettier.

Sample VSCode log output...mj-pa is extending the default configuration and formatting is being applied by the VS Code plugin for Prettier.

If you have any questions, comments, or suggestions, you can open a pull request or drop me an email

To learn more about how Prettier works or to create your own configuration file, you can reference the Prettier documentation