feat(FormFiledGroupHeaderTitleTextObject): interface renamed (typo) (#…

…610)
patternfly · Mar 27, 2024 · a58b56d · a58b56d
1 parent cee5bcd
commit a58b56d
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 0 deletions.
diff --git a/...roupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.md b/...roupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.md
@@ -0,0 +1,18 @@
+### formFiledGroupHeaderTitleTextObject-renamed [(#10016)](https://github.com/patternfly/patternfly-react/pull/10016)
+
+There was a typo in FormFiledGroupHeaderTitleTextObject interface. It was renamed to the intended FormFieldGroupHeaderTitleTextObject.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```
+
diff --git a/...iledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.test.ts b/...iledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.test.ts
@@ -0,0 +1,43 @@
+const ruleTester = require("../../ruletester");
+import * as rule from "./formFiledGroupHeaderTitleTextObject-renamed";
+
+const errorMessage =
+  "There was a typo in FormFiledGroupHeaderTitleTextObject interface. It was renamed to the intended FormFieldGroupHeaderTitleTextObject.";
+
+ruleTester.run("formFiledGroupHeaderTitleTextObject-renamed", rule, {
+  valid: [
+    {
+      code: `const titleTextObject: FormFiledGroupHeaderTitleTextObject = {text: "Some title", id: "form-field-group-header-title-text"};`,
+    },
+  ],
+  invalid: [
+    {
+      code: `import { FormFiledGroupHeaderTitleTextObject } from '@patternfly/react-core'; const titleTextObject: FormFiledGroupHeaderTitleTextObject = {text: "Some title", id: "form-field-group-header-title-text"};`,
+      output: `import { FormFieldGroupHeaderTitleTextObject } from '@patternfly/react-core'; const titleTextObject: FormFieldGroupHeaderTitleTextObject = {text: "Some title", id: "form-field-group-header-title-text"};`,
+      errors: [
+        {
+          message: errorMessage,
+          type: "ImportSpecifier",
+        },
+        {
+          message: errorMessage,
+          type: "TSTypeReference",
+        },
+      ],
+    },
+    {
+      code: `import { FormFiledGroupHeaderTitleTextObject } from '@patternfly/react-core'; interface MyExtension extends FormFiledGroupHeaderTitleTextObject {}`,
+      output: `import { FormFieldGroupHeaderTitleTextObject } from '@patternfly/react-core'; interface MyExtension extends FormFieldGroupHeaderTitleTextObject {}`,
+      errors: [
+        {
+          message: errorMessage,
+          type: "ImportSpecifier",
+        },
+        {
+          message: errorMessage,
+          type: "TSInterfaceHeritage",
+        },
+      ],
+    },
+  ],
+});
diff --git a/...formFiledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.ts b/...formFiledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.ts
@@ -0,0 +1,59 @@
+import { AST, Rule } from "eslint";
+import { ImportSpecifier, Identifier, Node } from "estree-jsx";
+import { getFromPackage } from "../../helpers";
+
+// https://github.com/patternfly/patternfly-react/pull/10016
+module.exports = {
+  meta: { fixable: "code" },
+  create: function (context: Rule.RuleContext) {
+    const { imports } = getFromPackage(context, "@patternfly/react-core");
+
+    const previousName = "FormFiledGroupHeaderTitleTextObject";
+    const newName = "FormFieldGroupHeaderTitleTextObject";
+
+    const interfaceImport = imports.find(
+      (specifier) => specifier.imported.name === previousName
+    );
+
+    if (!interfaceImport) {
+      return {};
+    }
+
+    const hasAlias = (specifier: ImportSpecifier) =>
+      specifier.local.name !== specifier.imported.name;
+
+    const reportMessage =
+      "There was a typo in FormFiledGroupHeaderTitleTextObject interface. It was renamed to the intended FormFieldGroupHeaderTitleTextObject.";
+
+    const callContextReport = (node: Node, nodeToReplace: Node | AST.Token) => {
+      context.report({
+        node,
+        message: reportMessage,
+        fix(fixer) {
+          return fixer.replaceText(nodeToReplace, newName);
+        },
+      });
+    };
+
+    return {
+      ImportSpecifier(node: ImportSpecifier) {
+        if (node.imported.name === interfaceImport.imported.name) {
+          callContextReport(node, node.imported);
+        }
+      },
+      TSTypeReference(node: { typeName: Identifier }) {
+        if (!hasAlias(interfaceImport) && node.typeName.name === previousName) {
+          callContextReport(node as unknown as Node, node.typeName);
+        }
+      },
+      TSInterfaceHeritage(node: { expression: Identifier }) {
+        if (
+          !hasAlias(interfaceImport) &&
+          node.expression.name === previousName
+        ) {
+          callContextReport(node as unknown as Node, node.expression);
+        }
+      },
+    };
+  },
+};
diff --git a/...iledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObjectRenamedInput.tsx b/...iledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObjectRenamedInput.tsx
@@ -0,0 +1,8 @@
+import { FormFiledGroupHeaderTitleTextObject } from "@patternfly/react-core";
+
+interface MyExtension extends FormFiledGroupHeaderTitleTextObject {}
+
+const titleTextObject: FormFiledGroupHeaderTitleTextObject = {
+  text: "Some title",
+  id: "form-field-group-header-title-text",
+};
diff --git a/...ledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObjectRenamedOutput.tsx b/...ledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObjectRenamedOutput.tsx
@@ -0,0 +1,8 @@
+import { FormFieldGroupHeaderTitleTextObject } from "@patternfly/react-core";
+
+interface MyExtension extends FormFieldGroupHeaderTitleTextObject {}
+
+const titleTextObject: FormFieldGroupHeaderTitleTextObject = {
+  text: "Some title",
+  id: "form-field-group-header-title-text",
+};