Migrate away from restorers (ivov#127)

* Refactor to `getExtendsValue`

* Remove unused function

* Pin ESLint version to n8n's version

lib/ast/getters/credentialClassBody.getters.ts

@@ -1,7 +1,7 @@
 import { TSESTree } from "@typescript-eslint/utils";
 import { id } from "../identifiers";
-import { restoreArray } from "../restorers";
-import type { StringClassField } from "../../types";
+import { restoreValue } from "../utils/restoreValue";
+import type { GenericContext, StringClassField } from "../../types";
 
 // ----------------------------------
 //          credClassBody
@@ -37,13 +37,18 @@ export function getPlaceholder(classBody: TSESTree.ClassBody) {
 	return getStringClassField(id.credClassBody.isPlaceholder, classBody);
 }
 
-export function getExtendsOAuth2(classBody: TSESTree.ClassBody) {
-	const found = classBody.body.find(id.credClassBody.isFieldExtends);
+/**
+ * Get the value for the `extends` field in a cred class, e.g. `[ 'oAuth2Api' ]`
+ */
+export function getExtendsValue(
+	classBody: TSESTree.ClassBody,
+	context: GenericContext
+) {
+	const extendsNode = classBody.body.find(id.credClassBody.isFieldExtends);
 
-	if (!found) return null;
+	if (!extendsNode) return null;
 
-	return {
-		ast: found,
-		value: restoreArray(found.value.elements),
-	};
+	const extendsSource = context.getSourceCode().getText(extendsNode.value);
+
+	return restoreValue<string[]>(extendsSource) ?? null;
 }

lib/ast/index.ts

@@ -3,5 +3,6 @@ export * from "./utils/filename";
 export * from "./utils/format";
 export * from "./utils/insertion";
 export * from "./utils/range";
+export * from "./utils/restoreValue";
 export * from "./utils/rule";
 export * from "./utils/sort";

lib/ast/utils/index.ts

@@ -2,6 +2,7 @@ import * as filename from "./filename";
 import * as format from "./format";
 import * as insertion from "./insertion";
 import * as range from "./range";
+import * as restoreValue from "./restoreValue";
 import * as rule from "./rule";
 import * as sort from "./sort";
 
@@ -10,6 +11,7 @@ export const utils = {
 	...format,
 	...insertion,
 	...range,
+	...restoreValue,
 	...rule,
 	...sort,
 };

lib/ast/utils/restoreValue.ts

@@ -0,0 +1,7 @@
+export function restoreValue<T>(source: string): T | null {
+	try {
+		return eval(`(${source})`);
+	} catch (error) {
+		return null;
+	}
+}

lib/rules/cred-class-field-display-name-missing-oauth2.ts

@@ -13,7 +13,7 @@ export default utils.createRule({
 		},
 		schema: [],
 		messages: {
-			addOAuth2: "Insert 'OAuth2' [non-autofixable]", // unpredictable input
+			addOAuth2: "Add 'OAuth2' [non-autofixable]",
 		},
 	},
 	defaultOptions: [],
@@ -22,16 +22,19 @@ export default utils.createRule({
 			ClassDeclaration(node) {
 				if (!id.isCredentialClass(node)) return;
 
-				const extendsOAuth2 = getters.credClassBody.getExtendsOAuth2(node.body);
+				const extendsValue = getters.credClassBody.getExtendsValue(
+					node.body,
+					context
+				);
 
-				if (!extendsOAuth2) return;
+				if (!extendsValue) return;
 
 				const displayName = getters.credClassBody.getDisplayName(node.body);
 
 				if (!displayName) return;
 
 				if (
-					extendsOAuth2.value.includes("oAuth2Api") &&
+					extendsValue.includes("oAuth2Api") &&
 					!displayName.value.endsWith("OAuth2 API")
 				) {
 					context.report({

lib/rules/cred-class-field-name-missing-oauth2.ts

@@ -24,16 +24,16 @@ export default utils.createRule({
 
 				const { body: classBody } = node;
 
-				const extendsOAuth2 = getters.credClassBody.getExtendsOAuth2(classBody);
+				const extendsValue = getters.credClassBody.getExtendsValue(classBody, context);
 
-				if (!extendsOAuth2) return;
+				if (!extendsValue) return;
 
 				const name = getters.credClassBody.getName(classBody);
 
 				if (!name) return;
 
 				if (
-					extendsOAuth2.value.includes("oAuth2Api") &&
+					extendsValue.includes("oAuth2Api") &&
 					!name.value.endsWith("OAuth2Api")
 				) {
 					context.report({

lib/rules/cred-class-name-missing-oauth2-suffix.ts

@@ -1,6 +1,7 @@
 import { utils } from "../ast/utils";
 import { id } from "../ast/identifiers";
 import { getters } from "../ast/getters";
+import { RuleContext } from "@typescript-eslint/utils/dist/ts-eslint";
 
 export default utils.createRule({
 	name: utils.getRuleName(module),
@@ -22,16 +23,19 @@ export default utils.createRule({
 			ClassDeclaration(node) {
 				if (!id.isCredentialClass(node)) return;
 
-				const extendsOAuth2 = getters.credClassBody.getExtendsOAuth2(node.body);
+				const extendsValue = getters.credClassBody.getExtendsValue(
+					node.body,
+					context
+				);
 
-				if (!extendsOAuth2) return;
+				if (!extendsValue) return;
 
 				const className = getters.getClassName(node);
 
 				if (!className) return;
 
 				if (
-					extendsOAuth2.value.includes("oAuth2Api") &&
+					extendsValue.includes("oAuth2Api") &&
 					!className.value.endsWith("OAuth2Api")
 				) {
 					context.report({

lib/types.ts

@@ -1,4 +1,5 @@
-import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
+import type { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
+import type { RuleContext } from "@typescript-eslint/utils/dist/ts-eslint";
 
 type BaseProperty = TSESTree.PropertyNonComputedName;
 
@@ -44,3 +45,5 @@ export type TemplateStringProperty = BaseProperty & {
 export type StringClassField = TSESTree.PropertyDefinitionNonComputedName & {
 	value: { value: string };
 };
+
+export type GenericContext = Readonly<RuleContext<any, any>>; // TODO: Type properly

package.json

@@ -47,7 +47,7 @@
     "@typescript-eslint/parser": "^5.33.0",
     "esbuild": "^0.15.0",
     "esbuild-jest": "^0.5.0",
-    "eslint": "^8.0.0",
+    "eslint": "8.23.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-docgen": "^0.7.1",