-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* WIP use-page-header-tools * adding space * targeting JSXIdentifiers * updates to match card-rename-components, WIP * matching error messages * make rule error * adding data-codemods * leaving room for headerTools prop * fix import * WIP, fixed AST type * rename-toolbar-components * adjust tests * once more * rename rule * update readme Co-authored-by: jenny-s51 <[email protected]> Co-authored-by: redallen <[email protected]>
- Loading branch information
3 people
authored
Jun 3, 2020
1 parent
3dc5ce2
commit a8bed7b
Showing
12 changed files
with
335 additions
and
7 deletions.
There are no files selected for viewing
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
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
71 changes: 71 additions & 0 deletions
71
packages/eslint-plugin-pf-codemods/lib/rules/page-header-move-avatar.js
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,71 @@ | ||
| const { getPackageImports } = require('../helpers'); | ||
|
|
||
| const components = [ | ||
| 'PageHeader', | ||
| 'PageHeaderTools' | ||
| ] | ||
|
|
||
| // https://github.com/patternfly/patternfly-react/pull/4246 | ||
| module.exports = { | ||
| create: function(context) { | ||
| const imports = getPackageImports(context, '@patternfly/react-core') | ||
| .filter(specifier => components.includes(specifier.imported.name)); | ||
|
|
||
| return imports.length === 0 ? {} : { | ||
| JSXElement(node) { | ||
| // find avatar attribute | ||
| let avatarValue; | ||
| if (node.openingElement.name.name === 'PageHeader' && node.openingElement.attributes.length) { | ||
| const avatarAttr = node.openingElement.attributes.find(attr => attr.name.name === 'avatar'); | ||
| const toolbarAttr = node.openingElement.attributes.find(attr => attr.name.name === 'toolbar'); | ||
| if (toolbarAttr) { | ||
| // not ready yet this round, wait for other rules to kick in first | ||
| return context.report({ | ||
| node, | ||
| message: `avatar prop was removed from PageHeader, move the avatar component into PageHeaderTools` | ||
| }); | ||
| } | ||
| const headerToolsAttr = node.openingElement.attributes.find(attr => attr.name.name === 'headerTools'); | ||
| if (avatarAttr) { | ||
| context.report({ | ||
| node, | ||
| message: `avatar prop was removed from PageHeader, move the avatar component into PageHeaderTools`, | ||
| fix(fixer) { | ||
| if (!headerToolsAttr) { | ||
| // comment out | ||
| return fixer.replaceText(avatarAttr, `/*TODO: move to PageHeaderTools - ${context.getSourceCode().getText(avatarAttr)}*/`) | ||
| } else { | ||
| // move into headerTools if possible | ||
| if ( | ||
| headerToolsAttr.value.type === 'JSXExpressionContainer' && | ||
| headerToolsAttr.value.expression.type === 'JSXElement' && | ||
| headerToolsAttr.value.expression.openingElement.name.name === 'PageHeaderTools' && | ||
| headerToolsAttr.value.expression.closingElement | ||
| ) { | ||
| const intermediateValue = context.getSourceCode().getText(avatarAttr.value); | ||
| if (avatarAttr.value.expression && avatarAttr.value.expression.type === 'JSXElement') { | ||
| avatarValue = `${intermediateValue.substring(1, intermediateValue.length - 1)}`; | ||
| } else { | ||
| avatarValue = intermediateValue; | ||
| } | ||
| return [ | ||
| fixer.insertTextBefore( | ||
| headerToolsAttr.value.expression.closingElement, | ||
| avatarValue | ||
| ), | ||
| fixer.remove(avatarAttr) | ||
| ] | ||
| } else { | ||
| // well we tried... just comment it out then | ||
| return fixer.replaceText(avatarAttr, `/*TODO: move to PageHeaderTools - ${context.getSourceCode().getText(avatarAttr)}*/`) | ||
| } | ||
|
|
||
| } | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| } | ||
| }; |
12 changes: 12 additions & 0 deletions
12
packages/eslint-plugin-pf-codemods/lib/rules/page-header-prop-rename.js
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,12 @@ | ||
| const { renameProp } = require('../helpers'); | ||
|
|
||
| // https://github.com/patternfly/patternfly-react/pull/4246 | ||
| module.exports = { | ||
| create: renameProp( | ||
| 'PageHeader', | ||
| { | ||
| 'toolbar': 'headerTools' | ||
| }, | ||
| node => `toolbar prop has been removed from ${node.name.name}. Use headerTools instead` | ||
| ), | ||
| }; |
12 changes: 12 additions & 0 deletions
12
packages/eslint-plugin-pf-codemods/lib/rules/rename-toolbar-components.js
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,12 @@ | ||
| const { renameComponent } = require('../helpers'); | ||
|
|
||
| // https://github.com/patternfly/patternfly-react/pull/4246 | ||
| module.exports = { | ||
| create: renameComponent( | ||
| { | ||
| 'Toolbar': 'PageHeaderTools', | ||
| 'ToolbarGroup': 'PageHeaderToolsGroup', | ||
| 'ToolbarItem': 'PageHeaderToolsItem' | ||
| } | ||
| ) | ||
| }; |
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
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
36 changes: 36 additions & 0 deletions
36
packages/eslint-plugin-pf-codemods/test/rules/page-header-move-avatar.js
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,36 @@ | ||
| const ruleTester = require("./ruletester"); | ||
| const rule = require("../../lib/rules/page-header-move-avatar"); | ||
|
|
||
| ruleTester.run("page-header-move-avatar", rule, { | ||
| valid: [ | ||
| { | ||
| code: `import { Avatar, PageHeader } from '@patternfly/react-core'; <PageHeader headerTools="tools" />` | ||
| }, | ||
| { | ||
| // no @patternfly import | ||
| code: `<PageHeader avatar={<Avatar />} />` | ||
| } | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: `import { Avatar, PageHeader } from '@patternfly/react-core'; <PageHeader avatar={<Avatar />} />`, | ||
| output: `import { Avatar, PageHeader } from '@patternfly/react-core'; <PageHeader /*TODO: move to PageHeaderTools - avatar={<Avatar />}*/ />`, | ||
| errors: [ | ||
| { | ||
| message: 'avatar prop was removed from PageHeader, move the avatar component into PageHeaderTools', | ||
| type: 'JSXElement' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| code: `import { Avatar, PageHeader, PageHeaderTools } from '@patternfly/react-core'; <PageHeader avatar={<Avatar />} headerTools={<PageHeaderTools></PageHeaderTools>} />`, | ||
| output: `import { Avatar, PageHeader, PageHeaderTools } from '@patternfly/react-core'; <PageHeader headerTools={<PageHeaderTools><Avatar /></PageHeaderTools>} />`, | ||
| errors: [ | ||
| { | ||
| message: 'avatar prop was removed from PageHeader, move the avatar component into PageHeaderTools', | ||
| type: 'JSXElement' | ||
| } | ||
| ] | ||
| }, | ||
| ] | ||
| }); |
23 changes: 23 additions & 0 deletions
23
packages/eslint-plugin-pf-codemods/test/rules/page-header-prop-rename.js
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,23 @@ | ||
| const ruleTester = require('./ruletester'); | ||
| const rule = require('../../lib/rules/page-header-prop-rename'); | ||
|
|
||
| ruleTester.run("page-header-prop-rename", rule, { | ||
| valid: [ | ||
| { | ||
| code: `import { PageHeader } from '@patternfly/react-core'; <PageHeader headerTools="tools" />`, | ||
| }, | ||
| { | ||
| // no @patternfly import | ||
| code: `<PageHeader toolbar="tools" />`} | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: `import { PageHeader } from '@patternfly/react-core'; <PageHeader toolbar="tools" />`, | ||
| output: `import { PageHeader } from '@patternfly/react-core'; <PageHeader headerTools="tools" />`, | ||
| errors: [{ | ||
| message: `toolbar prop has been removed from PageHeader. Use headerTools instead`, | ||
| type: "JSXOpeningElement", | ||
| }] | ||
| }, | ||
| ] | ||
| }); |
90 changes: 90 additions & 0 deletions
90
packages/eslint-plugin-pf-codemods/test/rules/rename-toolbar-components.js
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,90 @@ | ||
| const ruleTester = require('./ruletester'); | ||
| const rule = require('../../lib/rules/rename-toolbar-components'); | ||
|
|
||
| ruleTester.run("rename-toolbar-components", rule, { | ||
| valid: [ | ||
| { | ||
| code: `import { PageHeaderTools, PageHeaderToolsGroup, PageHeaderToolsItem } from '@patternfly/react-core'; | ||
| <PageHeaderTools> | ||
| <PageHeaderToolsGroup> | ||
| <PageHeaderToolsItem /> | ||
| </PageHeaderToolsGroup> | ||
| </PageHeaderTools> | ||
| `, | ||
| }, | ||
| { | ||
| // No @patternfly/react-core import | ||
| code: ` | ||
| <Toolbar> | ||
| <ToolbarGroup> | ||
| <ToolbarItem /> | ||
| </ToolbarGroup> | ||
| </Toolbar> | ||
| ` | ||
| } | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: ` | ||
| import { Page, PageHeader, Toolbar, ToolbarGroup, ToolbarItem } from '@patternfly/react-core'; | ||
| <Page> | ||
| <PageHeader toolbar={ | ||
| <Toolbar> | ||
| <ToolbarGroup> | ||
| <ToolbarItem /> | ||
| </ToolbarGroup> | ||
| </Toolbar> | ||
| } | ||
| /> | ||
| </Page> | ||
| `, | ||
| output: ` | ||
| import { Page, PageHeader, PageHeaderTools, PageHeaderToolsGroup, PageHeaderToolsItem } from '@patternfly/react-core'; | ||
| <Page> | ||
| <PageHeader toolbar={ | ||
| <PageHeaderTools> | ||
| <PageHeaderToolsGroup> | ||
| <PageHeaderToolsItem /> | ||
| </PageHeaderToolsGroup> | ||
| </PageHeaderTools> | ||
| } | ||
| /> | ||
| </Page> | ||
| `, | ||
| errors: [ | ||
| { | ||
| message: `Toolbar has been replaced with PageHeaderTools`, | ||
| type: "ImportSpecifier", | ||
| }, | ||
| { | ||
| message: `ToolbarGroup has been replaced with PageHeaderToolsGroup`, | ||
| type: "ImportSpecifier", | ||
| }, | ||
| { | ||
| message: `ToolbarItem has been replaced with PageHeaderToolsItem`, | ||
| type: "ImportSpecifier", | ||
| }, | ||
| { | ||
| message: `Toolbar has been replaced with PageHeaderTools`, | ||
| type: "JSXIdentifier", | ||
| }, | ||
| { | ||
| message: `ToolbarGroup has been replaced with PageHeaderToolsGroup`, | ||
| type: "JSXIdentifier", | ||
| }, | ||
| { | ||
| message: `ToolbarItem has been replaced with PageHeaderToolsItem`, | ||
| type: "JSXIdentifier", | ||
| }, | ||
| { | ||
| message: `ToolbarGroup has been replaced with PageHeaderToolsGroup`, | ||
| type: "JSXIdentifier", | ||
| }, | ||
| { | ||
| message: `Toolbar has been replaced with PageHeaderTools`, | ||
| type: "JSXIdentifier", | ||
| }, | ||
| ] | ||
| }, | ||
| ] | ||
| }); |
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
Oops, something went wrong.