diff --git a/LICENSE b/LICENSE index a203c5d..cfc6b98 100644 --- a/LICENSE +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index 0c3e650..4032495 100644 --- a/README.md +++ b/README.md @@ -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? :) +

+ +## 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 :) +

## 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**: diff --git a/index.json b/index.json index eb7e6aa..1da6956 100644 --- a/index.json +++ b/index.json @@ -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" } diff --git a/package.json b/package.json index 17393fd..ef2d15a 100644 --- a/package.json +++ b/package.json @@ -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", @@ -14,6 +14,9 @@ "format", "mj-pa" ], + "publishConfig": { + "registry": "https://registry.npmjs.org" + }, "author": "killshot13", "license": "MIT" } diff --git a/resources/javascript.pdf b/resources/javascript.pdf new file mode 100644 index 0000000..7a9b93a Binary files /dev/null and b/resources/javascript.pdf differ diff --git a/resources/mjpa.ppt b/resources/mjpa.ppt new file mode 100644 index 0000000..be07192 Binary files /dev/null and b/resources/mjpa.ppt differ diff --git a/resources/react.js.pdf b/resources/react.js.pdf new file mode 100644 index 0000000..d113ec8 Binary files /dev/null and b/resources/react.js.pdf differ diff --git a/resources/runkit.pdf b/resources/runkit.pdf new file mode 100644 index 0000000..538b56a Binary files /dev/null and b/resources/runkit.pdf differ