eslint-plugin-prettier 2.5.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v2.7.0 (2018-09-26)
+
+* Update: Support prettierignore and custom processors ([#111](https://github.com/prettier/eslint-plugin-prettier/issues/111)) ([38537ba](https://github.com/prettier/eslint-plugin-prettier/commit/38537ba35fc9152852c3b91f3041d72556b43013))
+* Build: switch to release script package ([047dc8f](https://github.com/prettier/eslint-plugin-prettier/commit/047dc8ffdf006c74267df4902fec684c589dad12))
+
+## v2.6.2 (2018-07-06)
+
+* Fix: Add representation for \r to showInvisibles ([#100](https://github.com/prettier/eslint-plugin-prettier/issues/100)) ([731bbb5](https://github.com/prettier/eslint-plugin-prettier/commit/731bbb576ce422a5c73a1fa9750aa3466c7da928))
+* Docs: Add clarification about Flow/React support to readme ([#96](https://github.com/prettier/eslint-plugin-prettier/issues/96)) ([977aa77](https://github.com/prettier/eslint-plugin-prettier/commit/977aa77a119f22af3f8ca8d6f47e5bcfcc9e23fb))
+
+## v2.6.1 (2018-06-23)
+
+* Fix: respect editorconfig ([#92](https://github.com/prettier/eslint-plugin-prettier/issues/92)) ([0b04dd3](https://github.com/prettier/eslint-plugin-prettier/commit/0b04dd362d0d92534a7cf11eaebbab8eb59fc96d))
+
+## v2.6.0 (2018-02-02)
+
+* Update: Add option to skip loading prettierrc ([#83](https://github.com/prettier/eslint-plugin-prettier/issues/83)) ([9e0fb48](https://github.com/prettier/eslint-plugin-prettier/commit/9e0fb48d077214a81ac549731308ab11512c37cd))
+* Build: add Node 8 and 9 to Travis ([e5b5fa7](https://github.com/prettier/eslint-plugin-prettier/commit/e5b5fa74d06a06a53d04c4748b31e24fcd7a41b9))
+* Chore: add test for vue parsing ([1ab43fd](https://github.com/prettier/eslint-plugin-prettier/commit/1ab43fd601a67100cb03bbfe614203fd399d40bb))
+
 ## v2.5.0 (2018-01-16)
 
 * Fix: pass filepath to prettier ([#76](https://github.com/prettier/eslint-plugin-prettier/issues/76)) ([0b6ab55](https://github.com/prettier/eslint-plugin-prettier/commit/0b6ab55e0a48e9c31cfa1d7f3b891100e0580493))

package/README.md

@@ -66,7 +66,7 @@ To integrate this plugin with `eslint-config-prettier`, you can use the `"recomm
   npm install --save-dev eslint-config-prettier
   ```
 
-2. Then all you need in your `.eslintrc.json` is:
+2. Then you need to add `plugin:prettier/recommended` as the last extension in your `.eslintrc.json`:
 
   ```json
   {
@@ -78,12 +78,27 @@ To integrate this plugin with `eslint-config-prettier`, you can use the `"recomm
 
 This does three things:
 
-1. Enables `eslint-plugin-prettier`.
-2. Sets the `prettier/prettier` rule to `"error"`.
-3. Extends the `eslint-config-prettier` configuration.
+* Enables `eslint-plugin-prettier`.
+* Sets the `prettier/prettier` rule to `"error"`.
+* Extends the `eslint-config-prettier` configuration.
 
 You can then set Prettier's own options inside a `.prettierrc` file.
 
+3. In order to support special ESLint plugins (e.g. [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)), add extra exclusions for the plugins you use like so:
+
+```json
+{
+  "extends": [
+    "plugin:prettier/recommended",
+    "prettier/flowtype",
+    "prettier/react",
+    "prettier/standard"
+  ]
+}
+```
+
+For the list of every available exclusion rule set, please see the [readme of eslint-config-prettier](https://github.com/prettier/eslint-config-prettier/blob/master/README.md).
+
 ## Options
 
 > Note: While it is possible to pass options to Prettier via your ESLint configuration file, it is not recommended because editor extensions such as `prettier-atom` and `prettier-vscode` **will** read [`.prettierrc`](https://prettier.io/docs/en/configuration.html), but **won't** read settings from ESLint, which can lead to an inconsistent experience.
@@ -141,6 +156,24 @@ You can then set Prettier's own options inside a `.prettierrc` file.
     ```
 
     _This option is useful if you're migrating a large codebase and already use pragmas like `@flow`._
+  
+  - An object with the following options
+  
+    - `pragma`: Also sets the aforementioned `pragma`: a string with a pragma that triggers this rule. By default, this rule applies to all files. However, if you set a pragma (this option), only files with that pragma in the heading docblock will be checked. All pragmas must start with `@`.
+    
+      ```json
+      "prettier/prettier": ["error", null, {
+        "pragma": "@prettier"
+      }]
+      ```
+      
+    - `usePrettierrc`: Enables loading of the Prettier configuration file, (default: `true`). May be useful if you are using multiple tools that conflict with each other, or do not wish to mix your ESLint settings with your Prettier configuration.
+    
+      ```json
+      "prettier/prettier": ["error", null, {
+        "usePrettierrc": false
+      }]
+      ```
 
 * The rule is autofixable -- if you run `eslint` with the `--fix` flag, your code will be formatted according to `prettier` style.
 

package/eslint-plugin-prettier.js

@@ -100,6 +100,9 @@ function showInvisibles(str) {
       case '\t':
         ret += '↹'; // Left Arrow To Bar Over Right Arrow To Bar, \u21b9
         break;
+      case '\r':
+        ret += '␍'; // Carriage Return Symbol, \u240D
+        break;
       default:
         ret += str[i];
         break;
@@ -282,6 +285,25 @@ function reportReplace(context, offset, deleteText, insertText) {
   });
 }
 
+/**
+ * Get the pragma from the ESLint rule context.
+ * @param {RuleContext} context - The ESLint rule context.
+ * @returns {string|null}
+ */
+function getPragma(context) {
+  const pluginOptions = context.options[1];
+
+  if (!pluginOptions) {
+    return null;
+  }
+
+  const pragmaRef =
+    typeof pluginOptions === 'string' ? pluginOptions : pluginOptions.pragma;
+
+  // Remove leading @
+  return pragmaRef ? pragmaRef.slice(1) : null;
+}
+
 // ------------------------------------------------------------------------------
 //  Module Definition
 // ------------------------------------------------------------------------------
@@ -313,16 +335,28 @@ module.exports = {
               { type: 'object', properties: {}, additionalProperties: true }
             ]
           },
-          // Pragma:
-          { type: 'string', pattern: '^@\\w+$' }
+          {
+            anyOf: [
+              // Pragma:
+              { type: 'string', pattern: '^@\\w+$' },
+              {
+                type: 'object',
+                properties: {
+                  pragma: { type: 'string', pattern: '^@\\w+$' },
+                  usePrettierrc: { type: 'boolean' }
+                },
+                additionalProperties: true
+              }
+            ]
+          }
         ]
       },
       create(context) {
-        const pragma = context.options[1]
-          ? context.options[1].slice(1) // Remove leading @
-          : null;
-
+        const pragma = getPragma(context);
+        const usePrettierrc =
+          !context.options[1] || context.options[1].usePrettierrc !== false;
         const sourceCode = context.getSourceCode();
+        const filepath = context.getFilename();
         const source = sourceCode.text;
 
         // The pragma is only valid if it is found in a block comment at the very
@@ -364,15 +398,64 @@ module.exports = {
               context.options[0] === 'fb'
                 ? FB_PRETTIER_OPTIONS
                 : context.options[0];
+
             const prettierRcOptions =
-              prettier.resolveConfig && prettier.resolveConfig.sync
-                ? prettier.resolveConfig.sync(context.getFilename())
+              usePrettierrc &&
+              prettier.resolveConfig &&
+              prettier.resolveConfig.sync
+                ? prettier.resolveConfig.sync(filepath, {
+                    editorconfig: true
+                  })
                 : null;
+
+            // prettier.getFileInfo was added in v1.13
+            const prettierFileInfo =
+              prettier.getFileInfo && prettier.getFileInfo.sync
+                ? prettier.getFileInfo.sync(filepath, {
+                    ignorePath: '.prettierignore'
+                  })
+                : { ignored: false, inferredParser: null };
+
+            // Skip if file is ignored using a .prettierignore file
+            if (prettierFileInfo.ignored) {
+              return;
+            }
+
+            const initialOptions = {};
+
+            // ESLint suppports processors that let you extract and lint JS
+            // fragments within a non-JS language. In the cases where prettier
+            // supports the same language as a processor, we want to process
+            // the provided source code as javascript (as ESLint provides the
+            // rules with fragments of JS) instead of guessing the parser
+            // based off the filename. Otherwise, for instance, on a .md file we
+            // end up trying to run prettier over a fragment of JS using the
+            // markdown parser, which throws an error.
+            // If we can't infer the parser from from the filename, either
+            // because no filename was provided or because there is no parser
+            // found for the filename, use javascript.
+            // This is added to the options first, so that
+            // prettierRcOptions and eslintPrettierOptions can still override
+            // the parser.
+            //
+            // `parserBlocklist` should contain the list of prettier parser
+            // names for file types where:
+            // * Prettier supports parsing the file type
+            // * There is an ESLint processor that extracts JavaScript snippets
+            //   from the file type.
+            const parserBlocklist = [null, 'graphql', 'markdown', 'html'];
+            if (
+              parserBlocklist.indexOf(prettierFileInfo.inferredParser) !== -1
+            ) {
+              initialOptions.parser = 'babylon';
+            }
+
             const prettierOptions = Object.assign(
               {},
+              initialOptions,
               prettierRcOptions,
               eslintPrettierOptions,
-              { filepath: context.getFilename() }
+              { filepath }
             );
 
             const prettierSource = prettier.format(source, prettierOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-prettier",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "Runs prettier as an eslint rule",
   "keywords": [
     "eslint",
@@ -15,7 +15,8 @@
   "main": "eslint-plugin-prettier.js",
   "scripts": {
     "lint": "eslint .",
-    "test": "npm run lint && mocha"
+    "test": "npm run lint && mocha",
+    "generate-release": "node-release-script"
   },
   "repository": {
     "type": "git",
@@ -33,6 +34,7 @@
     "prettier": ">= 0.11.0"
   },
   "devDependencies": {
+    "@not-an-aardvark/node-release-script": "^0.1.0",
     "eslint": "^3.14.1",
     "eslint-config-not-an-aardvark": "^2.0.0",
     "eslint-config-prettier": "^1.3.0",
@@ -41,8 +43,9 @@
     "eslint-plugin-self": "^1.0.1",
     "mocha": "^3.1.2",
     "moment": "^2.18.1",
-    "prettier": "^1.10.2",
-    "semver": "^5.3.0"
+    "prettier": "^1.13.0",
+    "semver": "^5.3.0",
+    "vue-eslint-parser": "^2.0.2"
   },
   "engines": {
     "node": ">=4.0.0"