eslint-plugin-prettier 2.5.0 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 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

@@ -141,6 +141,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

@@ -282,6 +282,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,15 +332,26 @@ 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 source = sourceCode.text;
 
@@ -365,7 +395,9 @@ module.exports = {
                 ? FB_PRETTIER_OPTIONS
                 : context.options[0];
             const prettierRcOptions =
-              prettier.resolveConfig && prettier.resolveConfig.sync
+              usePrettierrc &&
+              prettier.resolveConfig &&
+              prettier.resolveConfig.sync
                 ? prettier.resolveConfig.sync(context.getFilename())
                 : null;
             const prettierOptions = Object.assign(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-prettier",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Runs prettier as an eslint rule",
   "keywords": [
     "eslint",
@@ -42,7 +42,8 @@
     "mocha": "^3.1.2",
     "moment": "^2.18.1",
     "prettier": "^1.10.2",
-    "semver": "^5.3.0"
+    "semver": "^5.3.0",
+    "vue-eslint-parser": "^2.0.2"
   },
   "engines": {
     "node": ">=4.0.0"