New: rule prefer-replace-text (fixes eslint-community#47).

Author: aladdin-add

README.md

@@ -59,6 +59,7 @@ Name | ✔️ | 🛠 | Description
 [no-useless-token-range](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-useless-token-range.md) | ✔️ | 🛠 | Disallow unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken
 [prefer-output-null](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-output-null.md) |  | 🛠 | disallows invalid RuleTester test cases with the output the same as the code.
 [prefer-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-placeholders.md) |  |  | disallow template literals as report messages
+[prefer-replace-text](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-replace-text.md) |  | 🛠 | prefer using replaceText instead of replaceTextRange.
 [report-message-format](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/report-message-format.md) |  |  | enforce a consistent format for rule report messages
 [require-meta-fixable](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-fixable.md) | ✔️ |  | require rules to implement a meta.fixable property
 [test-case-property-ordering](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-property-ordering.md) |  | 🛠 | Requires the properties of a test case to be placed in a consistent order

lib/rules/prefer-replace-text.js

@@ -0,0 +1,83 @@
+/**
+ * @fileoverview prefer using replaceText instead of replaceTextRange.
+ * @author 薛定谔的猫<[email protected]>
+ */
+
+'use strict';
+
+const utils = require('../utils');
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'prefer using replaceText instead of replaceTextRange.',
+      category: 'Rules',
+      recommended: false,
+    },
+    fixable: 'code',
+    schema: [],
+  },
+
+  create (context) {
+    const sourceCode = context.getSourceCode();
+    const message = 'prefer using replaceText instead of replaceTextRange.';
+    let funcInfo = {
+      upper: null,
+      codePath: null,
+      shouldCheck: false,
+      node: null,
+    };
+    let contextIdentifiers;
+
+    return {
+      Program (node) {
+        contextIdentifiers = utils.getContextIdentifiers(context, node);
+      },
+
+      // Stacks this function's information.
+      onCodePathStart (codePath, node) {
+        const parent = node.parent;
+        const shouldCheck = node.type === 'FunctionExpression' &&
+          parent.parent.type === 'ObjectExpression' &&
+          parent.parent.parent.type === 'CallExpression' &&
+          contextIdentifiers.has(parent.parent.parent.callee.object) &&
+          parent.parent.parent.callee.property.name === 'report' &&
+          utils.getReportInfo(parent.parent.parent.arguments).fix === node;
+
+        funcInfo = {
+          upper: funcInfo,
+          codePath,
+          shouldCheck,
+          node,
+        };
+      },
+
+      // Pops this function's information.
+      onCodePathEnd () {
+        funcInfo = funcInfo.upper;
+      },
+
+      // Checks the return statement is valid.
+      'CallExpression[arguments.length>1]' (node) {
+        if (funcInfo.shouldCheck &&
+          node.callee.property.name === 'replaceTextRange') {
+          const arg = node.arguments[0];
+          if ((arg.type === 'MemberExpression' && arg.property.name === 'range')
+            || (
+              arg.type === 'ArrayExpression' && arg.elements.length === 2 &&
+              arg.elements[0].type === 'MemberExpression' && arg.elements[0].type === 'MemberExpression' && sourceCode.getText(arg.elements[0].object) === sourceCode.getText(arg.elements[1].object))
+          ) {
+            context.report({
+              node,
+              message,
+            });
+          }
+        }
+      },
+    };
+  },
+};

tests/lib/rules/prefer-replace-text.js

@@ -0,0 +1,68 @@
+/**
+ * @fileoverview prefer using replaceText instead of replaceTextRange
+ * @author 薛定谔的猫<[email protected]>
+ */
+
+'use strict';
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/prefer-replace-text');
+const RuleTester = require('eslint').RuleTester;
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
+const ERROR = { message: 'prefer using replaceText instead of replaceTextRange.' };
+
+
+ruleTester.run('prefer-placeholders', rule, {
+  valid: [
+    `
+      module.exports = {
+        create(context) {
+          context.report({
+            fix(fixer) {
+              return fixer.replaceTextRange([start, end], '');
+            }
+          });
+        }
+      };
+    `,
+  ],
+
+  invalid: [
+    {
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({
+              fix(fixer) {
+                return fixer.replaceTextRange(node.range, '');
+              }
+            });
+          }
+        };
+    `,
+      errors: [ERROR],
+    },
+    {
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({
+              fix(fixer) {
+                return fixer.replaceTextRange([node.range[0], node.range[1]], '');
+              }
+            });
+          }
+        };
+    `,
+      errors: [ERROR],
+    },
+  ],
+});