https://github.com/killshot13/mj-pa
mj-pa is an opinionated config package that extends Prettier. It is tailored to format JS, JSON, & JSX code in a React- or Vue-based environment.
https://github.com/killshot13/mj-pa
configuration-files javascript mj-pa npm prettier prettier-config prettier-json
Last synced: about 2 months ago
JSON representation
mj-pa is an opinionated config package that extends Prettier. It is tailored to format JS, JSON, & JSX code in a React- or Vue-based environment.
- Host: GitHub
- URL: https://github.com/killshot13/mj-pa
- Owner: killshot13
- License: mit
- Created: 2020-10-22T03:54:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T08:49:08.000Z (about 1 year ago)
- Last Synced: 2025-03-12T14:04:34.495Z (about 2 months ago)
- Topics: configuration-files, javascript, mj-pa, npm, prettier, prettier-config, prettier-json
- Homepage: https://www.npmjs.com/package/mj-pa
- Size: 2.36 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mj-pa
| [](https://github.com/prettier/prettier) | [](https://snyk.io/test/github/killshot13/mj-pa) | [](https://npm.runkit.com/mj-pa) |
|-|-|-|
## about
- `mj-pa` is my personal [Prettier](https://prettier.io) 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.
## usage
> IMPORTANT: You must have [Prettier](https://www.npmjs.com/package/prettier) installed in your project for [mj-pa](https://www.npmjs.com/package/mj-pa) to work properly.
### 1) install
Using npm
```shell
npm install --save-dev mj-pa
```
Using yarn
```shell
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.
```json
{
"prettier": "mj-pa"
}
```
### 3) format
Nothing changes here; run the `check` or `write` command as you normally would
```shell
npx prettier --check .
```
```shell
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](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for Prettier.
If you have any questions, comments, or suggestions, you can open a pull request or [drop me an email](mailto:[email protected])
To learn more about how Prettier works or to create your own configuration file, you can reference the [Prettier documentation](https://prettier.io/docs/en/index.html)