-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(FormFiledGroupHeaderTitleTextObject): interface renamed (typo) (#…
…610)
- Loading branch information
1 parent
cee5bcd
commit a58b56d
Showing
5 changed files
with
136 additions
and
0 deletions.
There are no files selected for viewing
18 changes: 18 additions & 0 deletions
18
...roupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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% | ||
``` | ||
|
43 changes: 43 additions & 0 deletions
43
...iledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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", | ||
}, | ||
], | ||
}, | ||
], | ||
}); |
59 changes: 59 additions & 0 deletions
59
...formFiledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObject-renamed.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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); | ||
} | ||
}, | ||
}; | ||
}, | ||
}; |
8 changes: 8 additions & 0 deletions
8
...iledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObjectRenamedInput.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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", | ||
}; |
8 changes: 8 additions & 0 deletions
8
...ledGroupHeaderTitleTextObjectRenamed/formFiledGroupHeaderTitleTextObjectRenamedOutput.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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", | ||
}; |