chore: implement replaceNodeText utility and update consistent nullish comparison rule to use it

Author: Rel1cx

.pkgs/tsl-local/dist/index.js

@@ -2,11 +2,18 @@ import { match } from "ts-pattern";
 import { defineRule } from "tsl";
 import { SyntaxKind } from "typescript";
 
-//#region src/utils/ast.ts
-function getStartAndEnd(node) {
+//#region src/utils/fix.ts
+/**
+* Replaces the text of a node with new text.
+* @param node The node to replace.
+* @param newText The new text to insert.
+* @returns An object containing the start and end positions of the node and the new text.
+*/
+function replaceNodeText(node, newText) {
 	return {
 		start: node.getStart(),
-		end: node.getEnd()
+		end: node.getEnd(),
+		newText
 	};
 }
 
@@ -35,13 +42,7 @@ const consistentNullishComparison = defineRule(() => ({
 			node,
 			suggestions: [{
 				message: offendingChild === node.left ? `Replace with 'null ${newOperatorText} ${node.right.getText()}'.` : `Replace with '${node.left.getText()} ${newOperatorText} null'.`,
-				changes: [{
-					...getStartAndEnd(node.operatorToken),
-					newText: newOperatorText
-				}, {
-					...getStartAndEnd(offendingChild),
-					newText: "null"
-				}]
+				changes: [replaceNodeText(node.operatorToken, newOperatorText), replaceNodeText(offendingChild, "null")]
 			}]
 		});
 	} }

.pkgs/tsl-local/src/rules/consistent-nullish-comparison.ts

@@ -2,7 +2,7 @@ import { match } from "ts-pattern";
 import { defineRule } from "tsl";
 import { SyntaxKind } from "typescript";
 
-import { getStartAndEnd } from "../utils";
+import { replaceNodeText } from "../utils";
 
 /**
  * Rule to enforce the use of `== null` or `!= null` for nullish comparisons.
@@ -38,14 +38,8 @@ export const consistentNullishComparison = defineRule(() => ({
               ? `Replace with 'null ${newOperatorText} ${node.right.getText()}'.`
               : `Replace with '${node.left.getText()} ${newOperatorText} null'.`,
             changes: [
-              {
-                ...getStartAndEnd(node.operatorToken),
-                newText: newOperatorText,
-              },
-              {
-                ...getStartAndEnd(offendingChild),
-                newText: "null",
-              },
+              replaceNodeText(node.operatorToken, newOperatorText),
+              replaceNodeText(offendingChild, "null"),
             ],
           },
         ],

.pkgs/tsl-local/src/utils/fix.ts

@@ -0,0 +1,13 @@
+/**
+ * Replaces the text of a node with new text.
+ * @param node The node to replace.
+ * @param newText The new text to insert.
+ * @returns An object containing the start and end positions of the node and the new text.
+ */
+export function replaceNodeText(node: { getStart: () => number; getEnd: () => number }, newText: string) {
+  return {
+    start: node.getStart(),
+    end: node.getEnd(),
+    newText,
+  } as const;
+}

.pkgs/tsl-local/src/utils/index.ts

@@ -1 +1,2 @@
 export * from "./ast";
+export * from "./fix";