Skip to content

Commit

Permalink
v1.2.0 offical release
Browse files Browse the repository at this point in the history
  • Loading branch information
killshot13 committed Dec 23, 2020
1 parent add1b9c commit eaf406b
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 32 deletions.
42 changes: 21 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +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.
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.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,34 @@
# mj-pa
## A custom [Prettier](https://prettier.io) config tailored for JavaScript environments
# mj-pa v1.2.0

## A custom [Prettier](https://prettier.io) config tailored for JSX & JS environments

### Why mj-pa?

#### make-javascript-pretty-again!

#### mj-pa == make-javascript-pretty-again!
#### Because what javascript developer doesn't love a good one-liner? :)
<br></br>

## v1.2.0 Release Notes

#### Improvements

1. This version was published both to [npm](https://www.npmjs.com/package/mj-pa) and to [Github](https://github.com/killshot13/mj-pa/packages/)!

2. Added the ("parser": "typescript") parameter, which favors the [typescript parser (via @typescript-eslint/typescript-estree)](https://github.com/typescript-eslint/typescript-eslint) over traditional [babel parser (via @babel/parser)](https://github.com/babel/babel/tree/main/packages/babel-parser). This is somewhat of a personal preference, but also a nod to `eslint`, which holds the top spot in overall popularity over other `javascript` linters.

#### Adjustments

1. The `jsxSingleQuote` parameter was changed from `false` to `true`. This decision was based primarily on user feedback which heavily favored not using quotation marks when defining `jsx` classes. It also looks less bulky, which is consistent with the overall intent of `mj-pa`.

2. Changed the ("endOfLine") parameter from `auto` to `lf`. With the exponential increase in popularity for Linux-based development since Microsoft released `wsl2` (Windows Subsystem for Linux v2), there is no longer much justification left for the `auto` setting; which carries the obvious risk of allowing mixed line endings in any shared git repository.

3. That is all for now :)
<br></br>

## 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.

#### [View it on npm](https://npmjs.com/package/mj-pa)
#### [Test it on RunKit](https://runkit.com/killshot13/mj-pa-runkit)
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.

#### **Installation**:

Expand Down
5 changes: 3 additions & 2 deletions index.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@
"semi": false,
"singleQuote": true,
"quoteProps": "consistent",
"jsxSingleQuote": false,
"jsxSingleQuote": true,
"trailingComma": "es5",
"bracketSpacing": true,
"jsxBracketSameLine": true,
"arrowParens": "avoid",
"parser": "typescript",
"proseWrap": "preserve",
"htmlWhitespaceSensitivity": "css",
"vueIndentScriptAndStyle": true,
"endOfLine": "auto",
"endOfLine": "lf",
"embeddedLanguageFormatting": "auto"
}
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "mj-pa",
"version": "1.0.0",
"description": "Custom Prettier config tailored for JavaScript environments",
"version": "1.2.0",
"description": "Custom Prettier config tailored for JSX & JS environments",
"main": "index.json",
"repository": {
"type": "git",
"url": "github.com/killshot13/mj-pa"
"url": "https://github.com/killshot13/mj-pa"
},
"keywords": [
"prettier",
Expand All @@ -14,6 +14,9 @@
"format",
"mj-pa"
],
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"author": "killshot13",
"license": "MIT"
}
Binary file added resources/javascript.pdf
Binary file not shown.
Binary file added resources/mjpa.ppt
Binary file not shown.
Binary file added resources/react.js.pdf
Binary file not shown.
Binary file added resources/runkit.pdf
Binary file not shown.

0 comments on commit eaf406b

Please sign in to comment.