fix(experimental-utils): add back SourceCode.isSpaceBetweenTokens

bradzacher · bradzacher · commit ae82ea4a85a4 · 2020-05-21T09:34:45.000-07:00
SourceCode.isSpaceBetween only exists in 6.7.0, so isSpaceBetweenTokens is a valid alternative until older versions are dead.
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -147,7 +147,7 @@ export default util.createRule<Options, MessageIds>({
       }
 
       const nextToken = sourceCode.getTokenAfter(prevToken);
-      if (nextToken && sourceCode.isSpaceBetween(prevToken, nextToken)) {
+      if (nextToken && sourceCode.isSpaceBetweenTokens(prevToken, nextToken)) {
         return false;
       }
 
diff --git a/packages/eslint-plugin/src/rules/comma-spacing.ts b/packages/eslint-plugin/src/rules/comma-spacing.ts
@@ -111,7 +111,7 @@ export default createRule<Options, MessageIds>({
       if (
         prevToken &&
         isTokenOnSameLine(prevToken, commaToken) &&
-        spaceBefore !== sourceCode.isSpaceBetween(prevToken, commaToken)
+        spaceBefore !== sourceCode.isSpaceBetweenTokens(prevToken, commaToken)
       ) {
         context.report({
           node: commaToken,
@@ -140,7 +140,7 @@ export default createRule<Options, MessageIds>({
       if (
         nextToken &&
         isTokenOnSameLine(commaToken, nextToken) &&
-        spaceAfter !== sourceCode.isSpaceBetween(commaToken, nextToken)
+        spaceAfter !== sourceCode.isSpaceBetweenTokens(commaToken, nextToken)
       ) {
         context.report({
           node: commaToken,
diff --git a/packages/eslint-plugin/src/rules/space-before-function-paren.ts b/packages/eslint-plugin/src/rules/space-before-function-paren.ts
@@ -145,7 +145,7 @@ export default util.createRule<Options, MessageIds>({
         rightToken = sourceCode.getFirstToken(node, util.isOpeningParenToken)!;
         leftToken = sourceCode.getTokenBefore(rightToken)!;
       }
-      const hasSpacing = sourceCode.isSpaceBetween(leftToken, rightToken);
+      const hasSpacing = sourceCode.isSpaceBetweenTokens(leftToken, rightToken);
 
       if (hasSpacing && functionConfig === 'never') {
         context.report({
diff --git a/packages/experimental-utils/src/ts-eslint/ESLint.ts b/packages/experimental-utils/src/ts-eslint/ESLint.ts
@@ -346,6 +346,8 @@ namespace ESLint {
  * This class depends on the Node.js fs module and the file system, so you cannot use it in browsers.
  *
  * If you want to lint code on browsers, use the Linter class instead.
+ *
+ * @since 7.0.0
  */
 class ESLint extends (ESLintESLint as typeof ESLintBase) {}
 
diff --git a/packages/experimental-utils/src/ts-eslint/RuleTester.ts b/packages/experimental-utils/src/ts-eslint/RuleTester.ts
@@ -159,9 +159,6 @@ declare class RuleTesterBase {
   static it?: (text: string, callback: () => void) => void;
 }
 
-/**
- * @deprecated - use RuleTesterSafe instead
- */
 class RuleTester extends (ESLintRuleTester as typeof RuleTesterBase) {}
 
 export {
diff --git a/packages/experimental-utils/src/ts-eslint/SourceCode.ts b/packages/experimental-utils/src/ts-eslint/SourceCode.ts
@@ -296,14 +296,29 @@ declare class SourceCodeBase extends TokenStore {
    * Determines if two nodes or tokens have at least one whitespace character
    * between them. Order does not matter. Returns false if the given nodes or
    * tokens overlap.
+   * This was added in v6.7.0.
+   * @since 6.7.0
    * @param first The first node or token to check between.
    * @param second The second node or token to check between.
    * @returns True if there is a whitespace character between any of the tokens found between the two given nodes or tokens.
    */
-  isSpaceBetween(
+  isSpaceBetween?(
     first: TSESTree.Token | TSESTree.Comment | TSESTree.Node,
     second: TSESTree.Token | TSESTree.Comment | TSESTree.Node,
   ): boolean;
+  /**
+   * Determines if two nodes or tokens have at least one whitespace character
+   * between them. Order does not matter. Returns false if the given nodes or
+   * tokens overlap.
+   * For backward compatibility, this method returns true if there are
+   * `JSXText` tokens that contain whitespace between the two.
+   * @param first The first node or token to check between.
+   * @param second The second node or token to check between.
+   * @returns {boolean} True if there is a whitespace character between
+   * any of the tokens found between the two given nodes or tokens.
+   * @deprecated in favor of isSpaceBetween
+   */
+  isSpaceBetweenTokens(first: TSESTree.Token, second: TSESTree.Token): boolean;
   /**
    * The source code split into lines according to ECMA-262 specification.
    * This is done to avoid each rule needing to do so separately.

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ export default util.createRule<Options, MessageIds>({`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`const nextToken = sourceCode.getTokenAfter(prevToken);`
`150`		`- if (nextToken && sourceCode.isSpaceBetween(prevToken, nextToken)) {`
	`150`	`+ if (nextToken && sourceCode.isSpaceBetweenTokens(prevToken, nextToken)) {`
`151`	`151`	`return false;`
`152`	`152`	`}`
`153`	`153`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ export default util.createRule<Options, MessageIds>({`
`145`	`145`	`rightToken = sourceCode.getFirstToken(node, util.isOpeningParenToken)!;`
`146`	`146`	`leftToken = sourceCode.getTokenBefore(rightToken)!;`
`147`	`147`	`}`
`148`		`- const hasSpacing = sourceCode.isSpaceBetween(leftToken, rightToken);`
	`148`	`+ const hasSpacing = sourceCode.isSpaceBetweenTokens(leftToken, rightToken);`
`149`	`149`
`150`	`150`	`if (hasSpacing && functionConfig === 'never') {`
`151`	`151`	`context.report({`
Original file line number	Diff line number	Diff line change
`@@ -346,6 +346,8 @@ namespace ESLint {`
`346`	`346`	`* This class depends on the Node.js fs module and the file system, so you cannot use it in browsers.`
`347`	`347`	`*`
`348`	`348`	`* If you want to lint code on browsers, use the Linter class instead.`
	`349`	`+ *`
	`350`	`+ * @since 7.0.0`
`349`	`351`	`*/`
`350`	`352`	`class ESLint extends (ESLintESLint as typeof ESLintBase) {}`
`351`	`353`
Original file line number	Diff line number	Diff line change
`@@ -159,9 +159,6 @@ declare class RuleTesterBase {`
`159`	`159`	`static it?: (text: string, callback: () => void) => void;`
`160`	`160`	`}`
`161`	`161`
`162`		`-/**`
`163`		`- * @deprecated - use RuleTesterSafe instead`
`164`		`- */`
`165`	`162`	`class RuleTester extends (ESLintRuleTester as typeof RuleTesterBase) {}`
`166`	`163`
`167`	`164`	`export {`