Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: No duplicate import specifiers rule #713

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/eslint-plugin-pf-codemods/src/ruleCustomization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,8 @@ export const setupRules = [
];

// rules that will run after other rules (cleanup imports?)
export const cleanupRules = ["no-unused-imports-v5", "no-unused-imports-v6"];
export const cleanupRules = [
"no-unused-imports-v5",
"no-unused-imports-v6",
"no-duplicate-import-specifiers",
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### no-duplicate-import-specifiers

Duplicate import specifiers should be removed. This is a cleanup rule which runs after other rules.

#### Examples

In:

```jsx
%inputExample%
```

Out:

```jsx
%outputExample%
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
const ruleTester = require("../../ruletester");
import * as rule from "./no-duplicate-import-specifiers";

ruleTester.run("no-duplicate-import-specifiers", rule, {
valid: [
{
// we care only about imports from "@patternfly/react-core"
code: `import { Button, Button } from "somewhere"`,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And maybe a valid test where Component is imported from react-core, but also react-core/[deprecated|next]?

},
{
code: `import { Button, Button as AnotherButton } from "@patternfly/react-core";
wise-king-sullyman marked this conversation as resolved.
Show resolved Hide resolved
<>
<Button>Sample button</Button>
<AnotherButton>Another one</AnotherButton>
</>`,
},
{
code: `import { Select } from '@patternfly/react-core/deprecated';
import { Select } from '@patternfly/react-core';`
},
{
code: `import { Select } from '@patternfly/react-core/deprecated';
import { Select } from '@patternfly/react-core/dist/dynamic/components/Select';`
},
{
code: `import { Select } from '@patternfly/react-core/next';
import { Select } from '@patternfly/react-core';`
},
{
code: `import { Select } from '@patternfly/react-core/next';
import { Select } from '@patternfly/react-core/dist/dynamic/components/Select';`
}
],
invalid: [
{
code: `import { Button, Button } from "@patternfly/react-core";
<Button>Sample button</Button>`,
output: `import { Button, } from "@patternfly/react-core";
<Button>Sample button</Button>`,
errors: [
{
message: `Duplicate import specifier Button imported from '@patternfly/react-core'.`,
type: "ImportSpecifier",
},
],
},
{
code: `import { Button } from "@patternfly/react-core";
import { Button } from "@patternfly/react-core";
Comment on lines +48 to +49
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also add an invalid test where Component is imported from react-core, but also imported from react-core/dist/...

<Button>Sample button</Button>`,
output: `import { Button } from "@patternfly/react-core";

<Button>Sample button</Button>`,
errors: [
{
message: `Duplicate import specifier Button imported from '@patternfly/react-core'.`,
type: "ImportSpecifier",
},
],
},
{
code: `import { Button } from "@patternfly/react-core";
import { Button } from '@patternfly/react-core/dist/dynamic/components/Button';
<Button>Sample button</Button>`,
output: `import { Button } from "@patternfly/react-core";

<Button>Sample button</Button>`,
errors: [
{
message: `Duplicate import specifier Button imported from '@patternfly/react-core/dist/dynamic/components/Button'.`,
type: "ImportSpecifier",
},
],
},
{
code: `import { Button as BTN, TextInput, Button as BTN } from "@patternfly/react-core";
<>
<BTN>Sample button</BTN>
<TextInput>Text</TextInput>
</>`,
output: `import { Button as BTN, TextInput, } from "@patternfly/react-core";
<>
<BTN>Sample button</BTN>
<TextInput>Text</TextInput>
</>`,
errors: [
{
message: `Duplicate import specifier BTN imported from '@patternfly/react-core'.`,
type: "ImportSpecifier",
},
],
},
],
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { Rule } from "eslint";
import { ImportDeclaration, ImportSpecifier } from "estree-jsx";
import { getFromPackage, removeSpecifierFromDeclaration } from "../../helpers";

// Cleanup from other rules
module.exports = {
meta: { fixable: "code" },
create: function (context: Rule.RuleContext) {
const { imports } = getFromPackage(context, "@patternfly/react-core");

const findDuplicates = (specifiers: ImportSpecifier[]) => {
const localNames = specifiers.map((spec) => spec.local.name);

return specifiers.filter(
(specifier, index) => localNames.indexOf(specifier.local.name) !== index
);
};

const duplicatesToRemove = findDuplicates(imports);

return !duplicatesToRemove.length
? {}
: {
ImportSpecifier(node: ImportSpecifier) {
if (duplicatesToRemove.includes(node)) {
const importDeclaration = context
.getAncestors()
.find(
(ancestor) => ancestor.type === "ImportDeclaration"
) as ImportDeclaration;

if (importDeclaration) {
context.report({
node,
message: `Duplicate import specifier ${node.local.name} imported from '${importDeclaration.source.value}'.`,
fix(fixer) {
return removeSpecifierFromDeclaration(
fixer,
context,
importDeclaration,
node
);
},
});
}
}
},
};
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { Button, Button } from "@patternfly/react-core";

export const NoDuplicateImportSpecifiersInput = () => (
<Button>Sample button</Button>
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { Button } from "@patternfly/react-core";

export const NoDuplicateImportSpecifiersInput = () => (
<Button>Sample button</Button>
);
Loading