eslint-plugin-prettier 2.7.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v3.0.0 (2018-10-01)
+
+* Chore: Add eslint peer-dependency ([d55d79c](https://github.com/prettier/eslint-plugin-prettier/commit/d55d79c6a64f659f405788fc75f344704619979f))
+* Breaking: Extract showInvisibles and generateDifferences ([bf7c40c](https://github.com/prettier/eslint-plugin-prettier/commit/bf7c40c240d9833548a7c9d210a28c90a4f3957b))
+* Breaking: Defining prettier options must use an object ([478c7e5](https://github.com/prettier/eslint-plugin-prettier/commit/478c7e5d2165f3e67e893c9a317b602159eaff9c))
+* Breaking: Drop support for ESLint v3 and v4 ([2326231](https://github.com/prettier/eslint-plugin-prettier/commit/232623179b16b99c0cf89ec9b8ed7660c69b092d))
+* Chore: Update dependencies ([1ec94c8](https://github.com/prettier/eslint-plugin-prettier/commit/1ec94c8e3495f6964588da5264b890cb49616fff))
+* Chore: remove two unused dependencies ([bfe459c](https://github.com/prettier/eslint-plugin-prettier/commit/bfe459c39b742115137e81278f03f8e6abfd7dcf))
+* Chore: Rename test files to keep them sequential ([d38ea52](https://github.com/prettier/eslint-plugin-prettier/commit/d38ea52debdf9da718c60933f42a709fa05f550f))
+* Breaking: Remove pragma support ([3af422c](https://github.com/prettier/eslint-plugin-prettier/commit/3af422c8e301978b611cfc665e052d48c102b443))
+* Breaking: Update minimum required pretter version to 1.13.0 ([29c0506](https://github.com/prettier/eslint-plugin-prettier/commit/29c050605674fda2975b3b620c89a7eb9332641a))
+* Breaking: Drop support for node v4, v7 and v9 ([be460bd](https://github.com/prettier/eslint-plugin-prettier/commit/be460bdd06fafb04442b440efabc7b36b12934a7))
+* Chore: Add vscode config to autoformat on save ([9fac6b4](https://github.com/prettier/eslint-plugin-prettier/commit/9fac6b4039c1983b83073fa7af7864f0d7e1f2d3))
+* Chore: Improve travis matrix ([46d2444](https://github.com/prettier/eslint-plugin-prettier/commit/46d244409e397ba9ff2dea621e99a4ea90e0585b))
+* Chore: Add format script to run prettier ([d46aa6d](https://github.com/prettier/eslint-plugin-prettier/commit/d46aa6dbd8028802121231d3ae0fe3f837bca9ad))
+
 ## 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))

package/LICENSE.md

@@ -1,5 +1,4 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
 
 Copyright © 2017 Andres Suarez and Teddy Katz
 

package/README.md

@@ -43,9 +43,7 @@ Then, in your `.eslintrc.json`:
 
 ```json
 {
-  "plugins": [
-    "prettier"
-  ],
+  "plugins": ["prettier"],
   "rules": {
     "prettier/prettier": "error"
   }
@@ -62,25 +60,23 @@ To integrate this plugin with `eslint-config-prettier`, you can use the `"recomm
 
 1. In addition to the above installation instructions, install `eslint-config-prettier`:
 
-  ```sh
-  npm install --save-dev eslint-config-prettier
-  ```
+   ```sh
+   npm install --save-dev eslint-config-prettier
+   ```
 
 2. Then you need to add `plugin:prettier/recommended` as the last extension in your `.eslintrc.json`:
 
-  ```json
-  {
-    "extends": [
-      "plugin:prettier/recommended"
-    ]
-  }
-  ```
+   ```json
+   {
+     "extends": ["plugin:prettier/recommended"]
+   }
+   ```
 
 This does three things:
 
-* Enables `eslint-plugin-prettier`.
-* Sets the `prettier/prettier` rule to `"error"`.
-* 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.
 
@@ -103,79 +99,29 @@ For the list of every available exclusion rule set, please see the [readme of es
 
 > 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.
 
-* The first option:
-  - Objects are passed directly to Prettier as [options](https://prettier.io/docs/en/options.html). Example:
-    
-    ```json
-    "prettier/prettier": ["error", {"singleQuote": true, "parser": "flow"}]
-    ```
-
-  - Or the string `"fb"` may be used to set "Facebook style" defaults:
-
-    ```json
-    "prettier/prettier": ["error", "fb"]
-    ```
-
-    Equivalent to:
-
-    ```json
-    "prettier/prettier": ["error", {
-      "singleQuote": true,
-      "trailingComma": "all",
-      "bracketSpacing": false,
-      "jsxBracketSameLine": true,
-      "parser": "flow"
-    }]
-    ```
-  NB: This option will merge and override any config set with `.prettierrc` files (for Prettier < 1.7.0, [config files are ignored](https://github.com/prettier/eslint-plugin-prettier/issues/46))
-
-* The second option:
+- The first option:
 
-  - 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 `@`. Example:
+  - An object representing [options](https://prettier.io/docs/en/options.html) that will be passed into prettier. Example:
 
     ```json
-    "prettier/prettier": ["error", null, "@prettier"]
-    ```
-
-    Only files with `@prettier` in the heading docblock will be checked:
-
-    ```js
-    /** @prettier */
-
-    console.log(1 + 2 + 3);
+    "prettier/prettier": ["error", {"singleQuote": true, "parser": "flow"}]
     ```
 
-    Or:
-
-    ```js
-    /**
-     * @prettier
-     */
+    NB: This option will merge and override any config set with `.prettierrc` files
 
-    console.log(4 + 5 + 6);
-    ```
+- The second option:
 
-    _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, {
+      "prettier/prettier": ["error", {}, {
         "usePrettierrc": false
       }]
       ```
 
-* The rule is autofixable -- if you run `eslint` with the `--fix` flag, your code will be formatted according to `prettier` style.
+- 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

@@ -9,27 +9,16 @@
 //  Requirements
 // ------------------------------------------------------------------------------
 
-const diff = require('fast-diff');
-const docblock = require('jest-docblock');
+const {
+  showInvisibles,
+  generateDifferences
+} = require('prettier-linter-helpers');
 
 // ------------------------------------------------------------------------------
 //  Constants
 // ------------------------------------------------------------------------------
 
-// Preferred Facebook style.
-const FB_PRETTIER_OPTIONS = {
-  singleQuote: true,
-  trailingComma: 'all',
-  bracketSpacing: false,
-  jsxBracketSameLine: true,
-  parser: 'flow'
-};
-
-const LINE_ENDING_RE = /\r\n|[\r\n\u2028\u2029]/;
-
-const OPERATION_INSERT = 'insert';
-const OPERATION_DELETE = 'delete';
-const OPERATION_REPLACE = 'replace';
+const { INSERT, DELETE, REPLACE } = generateDifferences;
 
 // ------------------------------------------------------------------------------
 //  Privates
@@ -38,182 +27,6 @@ const OPERATION_REPLACE = 'replace';
 // Lazily-loaded Prettier.
 let prettier;
 
-// ------------------------------------------------------------------------------
-//  Helpers
-// ------------------------------------------------------------------------------
-
-/**
- * Gets the location of a given index in the source code for a given context.
- * @param {RuleContext} context - The ESLint rule context.
- * @param {number} index - An index in the source code.
- * @returns {Object} An object containing numeric `line` and `column` keys.
- */
-function getLocFromIndex(context, index) {
-  // If `sourceCode.getLocFromIndex` is available from ESLint, use it - added
-  // in ESLint 3.16.0.
-  const sourceCode = context.getSourceCode();
-  if (typeof sourceCode.getLocFromIndex === 'function') {
-    return sourceCode.getLocFromIndex(index);
-  }
-  const text = sourceCode.getText();
-  if (typeof index !== 'number') {
-    throw new TypeError('Expected `index` to be a number.');
-  }
-  if (index < 0 || index > text.length) {
-    throw new RangeError('Index out of range.');
-  }
-  // Loosely based on
-  // https://github.com/eslint/eslint/blob/18a519fa/lib/ast-utils.js#L408-L438
-  const lineEndingPattern = /\r\n|[\r\n\u2028\u2029]/g;
-  let offset = 0;
-  let line = 0;
-  let match;
-  while ((match = lineEndingPattern.exec(text))) {
-    const next = match.index + match[0].length;
-    if (index < next) {
-      break;
-    }
-    line++;
-    offset = next;
-  }
-  return {
-    line: line + 1,
-    column: index - offset
-  };
-}
-
-/**
- * Converts invisible characters to a commonly recognizable visible form.
- * @param {string} str - The string with invisibles to convert.
- * @returns {string} The converted string.
- */
-function showInvisibles(str) {
-  let ret = '';
-  for (let i = 0; i < str.length; i++) {
-    switch (str[i]) {
-      case ' ':
-        ret += '·'; // Middle Dot, \u00B7
-        break;
-      case '\n':
-        ret += '⏎'; // Return Symbol, \u23ce
-        break;
-      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;
-    }
-  }
-  return ret;
-}
-
-/**
- * Generate results for differences between source code and formatted version.
- * @param {string} source - The original source.
- * @param {string} prettierSource - The Prettier formatted source.
- * @returns {Array} - An array contains { operation, offset, insertText, deleteText }
- */
-function generateDifferences(source, prettierSource) {
-  // fast-diff returns the differences between two texts as a series of
-  // INSERT, DELETE or EQUAL operations. The results occur only in these
-  // sequences:
-  //           /-> INSERT -> EQUAL
-  //    EQUAL |           /-> EQUAL
-  //           \-> DELETE |
-  //                      \-> INSERT -> EQUAL
-  // Instead of reporting issues at each INSERT or DELETE, certain sequences
-  // are batched together and are reported as a friendlier "replace" operation:
-  // - A DELETE immediately followed by an INSERT.
-  // - Any number of INSERTs and DELETEs where the joining EQUAL of one's end
-  // and another's beginning does not have line endings (i.e. issues that occur
-  // on contiguous lines).
-
-  const results = diff(source, prettierSource);
-  const differences = [];
-
-  const batch = [];
-  let offset = 0; // NOTE: INSERT never advances the offset.
-  while (results.length) {
-    const result = results.shift();
-    const op = result[0];
-    const text = result[1];
-    switch (op) {
-      case diff.INSERT:
-      case diff.DELETE:
-        batch.push(result);
-        break;
-      case diff.EQUAL:
-        if (results.length) {
-          if (batch.length) {
-            if (LINE_ENDING_RE.test(text)) {
-              flush();
-              offset += text.length;
-            } else {
-              batch.push(result);
-            }
-          } else {
-            offset += text.length;
-          }
-        }
-        break;
-      default:
-        throw new Error(`Unexpected fast-diff operation "${op}"`);
-    }
-    if (batch.length && !results.length) {
-      flush();
-    }
-  }
-
-  return differences;
-
-  function flush() {
-    let aheadDeleteText = '';
-    let aheadInsertText = '';
-    while (batch.length) {
-      const next = batch.shift();
-      const op = next[0];
-      const text = next[1];
-      switch (op) {
-        case diff.INSERT:
-          aheadInsertText += text;
-          break;
-        case diff.DELETE:
-          aheadDeleteText += text;
-          break;
-        case diff.EQUAL:
-          aheadDeleteText += text;
-          aheadInsertText += text;
-          break;
-      }
-    }
-    if (aheadDeleteText && aheadInsertText) {
-      differences.push({
-        offset,
-        operation: OPERATION_REPLACE,
-        insertText: aheadInsertText,
-        deleteText: aheadDeleteText
-      });
-    } else if (!aheadDeleteText && aheadInsertText) {
-      differences.push({
-        offset,
-        operation: OPERATION_INSERT,
-        insertText: aheadInsertText
-      });
-    } else if (aheadDeleteText && !aheadInsertText) {
-      differences.push({
-        offset,
-        operation: OPERATION_DELETE,
-        deleteText: aheadDeleteText
-      });
-    }
-    offset += aheadDeleteText.length;
-  }
-}
-
 // ------------------------------------------------------------------------------
 //  Rule Definition
 // ------------------------------------------------------------------------------
@@ -226,7 +39,7 @@ function generateDifferences(source, prettierSource) {
  * @returns {void}
  */
 function reportInsert(context, offset, text) {
-  const pos = getLocFromIndex(context, offset);
+  const pos = context.getSourceCode().getLocFromIndex(offset);
   const range = [offset, offset];
   context.report({
     message: 'Insert `{{ code }}`',
@@ -246,8 +59,8 @@ function reportInsert(context, offset, text) {
  * @returns {void}
  */
 function reportDelete(context, offset, text) {
-  const start = getLocFromIndex(context, offset);
-  const end = getLocFromIndex(context, offset + text.length);
+  const start = context.getSourceCode().getLocFromIndex(offset);
+  const end = context.getSourceCode().getLocFromIndex(offset + text.length);
   const range = [offset, offset + text.length];
   context.report({
     message: 'Delete `{{ code }}`',
@@ -269,8 +82,10 @@ function reportDelete(context, offset, text) {
  * @returns {void}
  */
 function reportReplace(context, offset, deleteText, insertText) {
-  const start = getLocFromIndex(context, offset);
-  const end = getLocFromIndex(context, offset + deleteText.length);
+  const start = context.getSourceCode().getLocFromIndex(offset);
+  const end = context
+    .getSourceCode()
+    .getLocFromIndex(offset + deleteText.length);
   const range = [offset, offset + deleteText.length];
   context.report({
     message: 'Replace `{{ deleteCode }}` with `{{ insertCode }}`',
@@ -285,32 +100,11 @@ 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
 // ------------------------------------------------------------------------------
 
 module.exports = {
-  showInvisibles,
-  generateDifferences,
   configs: {
     recommended: {
       extends: ['prettier'],
@@ -330,59 +124,26 @@ module.exports = {
         schema: [
           // Prettier options:
           {
-            anyOf: [
-              { enum: [null, 'fb'] },
-              { type: 'object', properties: {}, additionalProperties: true }
-            ]
+            type: 'object',
+            properties: {},
+            additionalProperties: true
           },
           {
-            anyOf: [
-              // Pragma:
-              { type: 'string', pattern: '^@\\w+$' },
-              {
-                type: 'object',
-                properties: {
-                  pragma: { type: 'string', pattern: '^@\\w+$' },
-                  usePrettierrc: { type: 'boolean' }
-                },
-                additionalProperties: true
-              }
-            ]
+            type: 'object',
+            properties: {
+              usePrettierrc: { type: 'boolean' }
+            },
+            additionalProperties: true
           }
         ]
       },
       create(context) {
-        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
-        // start of the file.
-        if (pragma) {
-          // ESLint 3.x reports the shebang as a "Line" node, while ESLint 4.x
-          // reports it as a "Shebang" node. This works for both versions:
-          const hasShebang = source.startsWith('#!');
-          const allComments = sourceCode.getAllComments();
-          const firstComment = hasShebang ? allComments[1] : allComments[0];
-          if (
-            !(
-              firstComment &&
-              firstComment.type === 'Block' &&
-              firstComment.loc.start.line === (hasShebang ? 2 : 1) &&
-              firstComment.loc.start.column === 0
-            )
-          ) {
-            return {};
-          }
-          const parsed = docblock.parse(firstComment.value);
-          if (parsed[pragma] !== '') {
-            return {};
-          }
-        }
-
         if (prettier && prettier.clearConfigCache) {
           prettier.clearConfigCache();
         }
@@ -394,27 +155,17 @@ module.exports = {
               prettier = require('prettier');
             }
 
-            const eslintPrettierOptions =
-              context.options[0] === 'fb'
-                ? FB_PRETTIER_OPTIONS
-                : context.options[0];
+            const eslintPrettierOptions = context.options[0] || {};
 
-            const prettierRcOptions =
-              usePrettierrc &&
-              prettier.resolveConfig &&
-              prettier.resolveConfig.sync
-                ? prettier.resolveConfig.sync(filepath, {
-                    editorconfig: true
-                  })
-                : null;
+            const prettierRcOptions = usePrettierrc
+              ? 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 };
+            const prettierFileInfo = prettier.getFileInfo.sync(filepath, {
+              ignorePath: '.prettierignore'
+            });
 
             // Skip if file is ignored using a .prettierignore file
             if (prettierFileInfo.ignored) {
@@ -464,21 +215,21 @@ module.exports = {
 
               differences.forEach(difference => {
                 switch (difference.operation) {
-                  case OPERATION_INSERT:
+                  case INSERT:
                     reportInsert(
                       context,
                       difference.offset,
                       difference.insertText
                     );
                     break;
-                  case OPERATION_DELETE:
+                  case DELETE:
                     reportDelete(
                       context,
                       difference.offset,
                       difference.deleteText
                     );
                     break;
-                  case OPERATION_REPLACE:
+                  case REPLACE:
                     reportReplace(
                       context,
                       difference.offset,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-prettier",
-  "version": "2.7.0",
+  "version": "3.0.0",
   "description": "Runs prettier as an eslint rule",
   "keywords": [
     "eslint",
@@ -16,6 +16,7 @@
   "scripts": {
     "lint": "eslint .",
     "test": "npm run lint && mocha",
+    "format": "yarn run prettier '**/*.{js,json,md,yml}' --write && yarn run lint --fix",
     "generate-release": "node-release-script"
   },
   "repository": {
@@ -27,28 +28,26 @@
   },
   "homepage": "https://github.com/prettier/eslint-plugin-prettier#readme",
   "dependencies": {
-    "fast-diff": "^1.1.1",
-    "jest-docblock": "^21.0.0"
+    "prettier-linter-helpers": "^1.0.0"
   },
   "peerDependencies": {
-    "prettier": ">= 0.11.0"
+    "eslint": ">= 5.0.0",
+    "prettier": ">= 1.13.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",
-    "eslint-plugin-eslint-plugin": "^0.7.1",
-    "eslint-plugin-node": "^4.2.2",
-    "eslint-plugin-self": "^1.0.1",
-    "mocha": "^3.1.2",
-    "moment": "^2.18.1",
+    "eslint": "^5.6.0",
+    "eslint-config-not-an-aardvark": "^2.1.0",
+    "eslint-config-prettier": "^3.1.0",
+    "eslint-plugin-eslint-plugin": "^1.4.0",
+    "eslint-plugin-node": "^7.0.1",
+    "eslint-plugin-self": "^1.1.0",
+    "mocha": "^5.2.0",
     "prettier": "^1.13.0",
-    "semver": "^5.3.0",
-    "vue-eslint-parser": "^2.0.2"
+    "vue-eslint-parser": "^3.2.2"
   },
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=6.0.0"
   },
   "license": "MIT"
 }