chore: require prettier@1.7.0+

BREAKING CHANGE: require prettier@1.7.0+
prettier · Sep 16, 2018 · bd50395 · bd50395
1 parent 9349dd6
commit bd50395
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 70 deletions.
diff --git a/README.md b/README.md
@@ -8,8 +8,6 @@
 
 Runs Prettier as a TSLint rule and reports differences as individual TSLint issues.
 
-**NOTE**: This project uses official reporter from [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier).
-
 [Changelog](https://github.com/ikatyang/tslint-plugin-prettier/blob/master/CHANGELOG.md)
 
 ## Sample
@@ -41,11 +39,13 @@ npm install --save-dev tslint-plugin-prettier prettier
 yarn add --dev tslint-plugin-prettier prettier
 ```
 
+(require `prettier@^1.7.0`)
+
 ## Usage
 
 (tslint.json)
 
-for `tslint@5.0.0+`
+for `tslint@^5.0.0`
 
 ```json
 {
@@ -56,7 +56,7 @@ for `tslint@5.0.0+`
 }
 ```
 
-for `tslint@5.2.0+`
+for `tslint@^5.2.0`
 
 ```json
 {
@@ -71,7 +71,7 @@ for `tslint@5.2.0+`
 
 ## Options
 
-If there is no option provided, it'll try to load [config file](https://prettier.io/docs/en/configuration.html) if possible (require `prettier@1.7.0+`), uses Prettier's default option if not found.
+If there is no option provided, it'll try to load [config file](https://prettier.io/docs/en/configuration.html) if possible, uses Prettier's default option if not found.
 
 ```json
 {

diff --git a/package.json b/package.json
@@ -44,7 +44,7 @@
     "typescript": "3.0.3"
   },
   "peerDependencies": {
-    "prettier": "^1.4.0",
+    "prettier": "^1.7.0",
     "tslint": "^5.0.0"
   },
   "engines": {

diff --git a/src/prettierRule.ts b/src/prettierRule.ts
@@ -1,4 +1,3 @@
-import assert = require('assert');
 import * as utils from 'eslint-plugin-prettier';
 import * as path from 'path';
 import * as prettier from 'prettier';
@@ -24,17 +23,6 @@ class Walker extends tslint.AbstractWalker<any[]> {
         options = ruleArgument1 as prettier.Options;
         break;
       case 'string': {
-        try {
-          assert_existence_of_resolve_config_sync();
-        } catch {
-          // istanbul ignore next
-          throw new Error(
-            `Require prettier@1.7.0+ to specify config file, but got prettier@${
-              prettier.version
-            }.`,
-          );
-        }
-
         const filePath = path.resolve(process.cwd(), ruleArgument1 as string);
         const resolvedConfig = prettier.resolveConfig.sync(filePath);
 
@@ -47,14 +35,6 @@ class Walker extends tslint.AbstractWalker<any[]> {
         break;
       }
       default: {
-        try {
-          assert_existence_of_resolve_config_sync();
-        } catch {
-          // backward compatibility: use default options if no resolveConfig.sync()
-          // istanbul ignore next
-          break;
-        }
-
         const resolvedConfig = prettier.resolveConfig.sync(sourceFile.fileName);
 
         if (resolvedConfig !== null) {
@@ -75,51 +55,55 @@ class Walker extends tslint.AbstractWalker<any[]> {
       return;
     }
 
-    utils.generateDifferences(source, formatted).forEach(difference => {
-      const {
-        operation,
-        offset: start,
-        deleteText = '',
-        insertText = '',
-      } = difference;
-
-      const end = start + deleteText.length;
-      const deleteCode = utils.showInvisibles(deleteText);
-      const insertCode = utils.showInvisibles(insertText);
-
-      switch (operation) {
-        case 'insert':
-          this.addFailureAt(
-            start,
-            1,
-            `Insert \`${insertCode}\``,
-            tslint.Replacement.appendText(start, insertText),
-          );
-          break;
-        case 'delete':
-          this.addFailure(
-            start,
-            end,
-            `Delete \`${deleteCode}\``,
-            tslint.Replacement.deleteFromTo(start, end),
-          );
-          break;
-        case 'replace':
-          this.addFailure(
-            start,
-            end,
-            `Replace \`${deleteCode}\` with \`${insertCode}\``,
-            tslint.Replacement.replaceFromTo(start, end, insertText),
-          );
-          break;
-        // istanbul ignore next
-        default:
-          throw new Error(`Unexpected operation '${operation}'`);
-      }
-    });
+    reportDifferences(this, source, formatted);
   }
 }
 
-function assert_existence_of_resolve_config_sync() {
-  assert(typeof prettier.resolveConfig.sync === 'function');
+function reportDifferences(
+  walkContext: tslint.WalkContext<any>,
+  source: string,
+  formatted: string,
+) {
+  utils.generateDifferences(source, formatted).forEach(difference => {
+    const {
+      operation,
+      offset: start,
+      deleteText = '',
+      insertText = '',
+    } = difference;
+
+    const end = start + deleteText.length;
+    const deleteCode = utils.showInvisibles(deleteText);
+    const insertCode = utils.showInvisibles(insertText);
+
+    switch (operation) {
+      case 'insert':
+        walkContext.addFailureAt(
+          start,
+          1,
+          `Insert \`${insertCode}\``,
+          tslint.Replacement.appendText(start, insertText),
+        );
+        break;
+      case 'delete':
+        walkContext.addFailure(
+          start,
+          end,
+          `Delete \`${deleteCode}\``,
+          tslint.Replacement.deleteFromTo(start, end),
+        );
+        break;
+      case 'replace':
+        walkContext.addFailure(
+          start,
+          end,
+          `Replace \`${deleteCode}\` with \`${insertCode}\``,
+          tslint.Replacement.replaceFromTo(start, end, insertText),
+        );
+        break;
+      // istanbul ignore next
+      default:
+        throw new Error(`Unexpected operation '${operation}'`);
+    }
+  });
 }