-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit f20af8e
Showing
4 changed files
with
115 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 Michael Rehnert | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# mj-pa | ||
|
||
## A custom [Prettier](https://prettier.io) config tailored for JavaScript environments | ||
|
||
### Why mj-pa? | ||
|
||
#### make-javascript-pretty-again! | ||
|
||
#### Because what javascript developer doesn't love a good one-liner? :) | ||
|
||
## 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. | ||
|
||
#### **Installation**: | ||
|
||
from the command line: | ||
|
||
NPM | ||
|
||
``` | ||
$ npm install --save-dev mj-pa | ||
``` | ||
|
||
YARN | ||
|
||
``` | ||
yarn add --dev mj-pa | ||
``` | ||
|
||
#### **Configuration**: | ||
|
||
manually edit the `package.json` file for your project: | ||
|
||
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" | ||
} | ||
``` | ||
|
||
#### **Usage**: | ||
|
||
nothing changes here, run the `check` or `write` command as you normally would. | ||
|
||
``` | ||
npx prettier --check . | ||
``` | ||
|
||
``` | ||
npx prettier --write . | ||
``` | ||
|
||
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). | ||
|
||
If you have any questions, comments, or suggestions, you can open a pull request or [drop me an email](mailto:dmreh@outlook.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{ | ||
"printWidth": 90, | ||
"tabWidth": 1, | ||
"useTabs": true, | ||
"semi": false, | ||
"singleQuote": true, | ||
"quoteProps": "consistent", | ||
"jsxSingleQuote": false, | ||
"trailingComma": "es5", | ||
"bracketSpacing": true, | ||
"jsxBracketSameLine": true, | ||
"arrowParens": "avoid", | ||
"proseWrap": "preserve", | ||
"htmlWhitespaceSensitivity": "css", | ||
"vueIndentScriptAndStyle": true, | ||
"endOfLine": "auto", | ||
"embeddedLanguageFormatting": "auto" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
"name": "mj-pa", | ||
"version": "1.0.0", | ||
"description": "Custom Prettier config tailored for JavaScript environments", | ||
"main": "index.json", | ||
"repository": { | ||
"type": "git", | ||
"url": "github.com/killshot13/mj-pa" | ||
}, | ||
"keywords": [ | ||
"prettier", | ||
"javascript", | ||
"formatter", | ||
"format", | ||
"mj-pa" | ||
], | ||
"author": "killshot13", | ||
"license": "MIT" | ||
} |