eslint-config-prettier - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

CHANGELOG.md

@@ -0,1 +1,5 @@
+### Version 1.0.2 (2017-01-30)
+
+- Improved: CLI helper tool instructions.
+
 ### Version 1.0.1 (2017-01-29)
@@ -2,0 +6,0 @@

cli.js

@@ -13,6 +13,8 @@ #!/usr/bin/env node
       "",
-      "eslint --print-config .eslintrc.js | ./node_modules/.bin/eslint-config-prettier-check",
+      "  eslint --print-config .eslintrc.js | eslint-config-prettier-check",
       "",
-      "(Swap out .eslintrc.js with the path to your config, and the path to this",
-      "tool if needed.)"
+      "(Swap out .eslintrc.js with the path to your config if needed.)",
+      "",
+      "For more information, see:",
+      "https://github.com/lydell/eslint-config-prettier#cli-helper-tool"
     ].join("\n")
@@ -19,0 +21,0 @@ );

package.json

 {
   "name": "eslint-config-prettier",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
@@ -5,0 +5,0 @@ "author": "Simon Lydell",

README.md

@@ -17,3 +17,3 @@ # eslint-config-prettier [![Build Status][travis-badge]][travis]
 ```
-$ npm install eslint-config-prettier
+$ npm install --save-dev eslint-config-prettier
 ```
@@ -52,11 +52,18 @@
 your configuration contains any rules that are unnecessary or conflict with
-prettier. You can run it like this:
+prettier.
 
+First, add a script for it to package.json:
+
+```json
+{
+  "scripts": {
+    "eslint-check": "eslint --print-config .eslintrc.js | eslint-config-prettier-check"
+  }
+}
 ```
-eslint --print-config .eslintrc.js | ./node_modules/.bin/eslint-config-prettier-check
-```
 
-(Swap out .eslintrc.js with the path to your config, and the path to this tool
-if needed.)
+Then run `npm run eslint-check`.
 
+(Swap out .eslintrc.js with the path to your config if needed.)
+
 ## Example configuration
@@ -63,0 +70,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11379

increased by1.85%

Lines of code

169

increased by1.2%

Number of lines in readme file

193

increased by3.76%

No dependency changes