From f20af8e9db644e5adf9de3a3963b60eefcfde971 Mon Sep 17 00:00:00 2001 From: Michael Rehnert Date: Wed, 21 Oct 2020 22:57:57 -0500 Subject: [PATCH] Finalized version to publish on npm --- LICENSE | 21 +++++++++++++++++++ README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++ index.json | 18 +++++++++++++++++ package.json | 19 ++++++++++++++++++ 4 files changed, 115 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 index.json create mode 100644 package.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a203c5d --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7372f88 --- /dev/null +++ b/README.md @@ -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). diff --git a/index.json b/index.json new file mode 100644 index 0000000..eb7e6aa --- /dev/null +++ b/index.json @@ -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" +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..17393fd --- /dev/null +++ b/package.json @@ -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" +}