eslint-plugin-prettier - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

package.json

 {
   "name": "eslint-plugin-prettier",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Runs prettier as an eslint rule",
@@ -16,8 +16,16 @@ "keywords": [
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/not-an-aardvark/eslint-plugin-prettier.git"
+  },
+  "bugs": {
+    "url": "https://github.com/not-an-aardvark/eslint-plugin-prettier/issues"
+  },
+  "homepage": "https://github.com/not-an-aardvark/eslint-plugin-prettier#readme",
   "dependencies": {
-    "prettier": "^0.11.0",
     "requireindex": "~1.1.0"
   },
   "peerDependencies": {
-    "eslint": "^3.14.1"
+    "eslint": "^3.14.1",
+    "prettier": ">= 0.11.0"
   },
@@ -29,3 +37,4 @@ "devDependencies": {
     "eslint-plugin-node": "^3.0.5",
-    "mocha": "^3.1.2"
+    "mocha": "^3.1.2",
+    "prettier": ">= 0.11.0"
   },
@@ -32,0 +41,0 @@ "engines": {

README.md

@@ -19,2 +19,8 @@ # eslint-plugin-prettier
 
+Finally, install `prettier`:
+
+```
+$ npm install prettier --save-dev
+```
+
 **Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-prettier` globally.
@@ -56,1 +62,15 @@
 The rule will report an error if your code does not match `prettier` style. The rule is autofixable -- if you run `eslint` with the `--fix` flag, your code will be formatted according to `prettier` style.
+
+---
+
+This plugin works best if you disable all other ESLint rules relating to code formatting, and only enable rules that detect patterns in the AST. (If another active ESLint rule disagrees with `prettier` about how code should be formatted, it will be impossible to avoid lint errors.) If your desired formatting does not match the `prettier` output (e.g. if you don't want semicolons), you should use a different tool such as [prettier-eslint](https://github.com/kentcdodds/prettier-eslint) instead.
+
+## Migrating to 2.0.0
+
+Starting in 2.0.0, `prettier` is a peerDependency of this module, rather than a dependency. This means that you can use any version of `prettier` with this plugin, but it also means that you need to install it separately and include it as a devDependency in your project.
+
+To install `prettier`, use:
+
+```bash
+npm install prettier --save-dev
+```

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10320

increased by27.02%

Number of package files

10

increased by11.11%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

75

increased by36.36%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

6

increased by20%

Dependency changes

• + Addedprettier@3.2.5(transitive)

• - Removedprettier@^0.11.0

• - Removedast-types@0.8.18(transitive)

• - Removedbabel-code-frame@6.22.0(transitive)

• - Removedbabylon@6.15.0(transitive)

• - Removedcolors@1.4.0(transitive)

• - Removedesutils@2.0.2(transitive)

• - Removedflow-parser@0.38.0(transitive)

• - Removedget-stdin@5.0.1(transitive)

• - Removedglob@7.1.1(transitive)

• - Removedminimist@1.2.0(transitive)

• - Removedprettier@0.11.0(transitive)