Skip to content

Added converter for react-a11y-image-button-has-alt, react-a11y-img-has-alt #1144

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

Merged
merged 3 commits into from
Jul 14, 2021
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
4 changes: 4 additions & 0 deletions src/converters/lintConfigs/rules/ruleConverters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ import { convertQuotemark } from "./ruleConverters/quotemark";
import { convertRadix } from "./ruleConverters/radix";
import { convertReactA11yAccessibleHeadings } from "./ruleConverters/react-a11y-accessible-headings";
import { convertReactA11yAnchors } from "./ruleConverters/react-a11y-anchors";
import { convertReactA11yImageButtonHasAlt } from "./ruleConverters/react-a11y-image-button-has-alt";
import { convertReactA11yImgHasAlt } from "./ruleConverters/react-a11y-img-has-alt";
import { convertReactA11yProps } from "./ruleConverters/react-a11y-props";
import { convertReactA11yTabIndexNoPositive } from "./ruleConverters/react-a11y-tabindex-no-positive";
import { convertReactNoDangerousHtml } from "./ruleConverters/react-no-dangerous-html";
Expand Down Expand Up @@ -494,6 +496,8 @@ export const ruleConverters = new Map([
["quotemark", convertQuotemark],
["radix", convertRadix],
["react-a11y-anchors", convertReactA11yAnchors],
["react-a11y-image-button-has-alt", convertReactA11yImageButtonHasAlt],
["react-a11y-img-has-alt", convertReactA11yImgHasAlt],
["react-a11y-props", convertReactA11yProps],
["react-a11y-tabindex-no-positive", convertReactA11yTabIndexNoPositive],
["react-no-dangerous-html", convertReactNoDangerousHtml],
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { RuleConverter } from "../ruleConverter";

export const convertReactA11yImageButtonHasAlt: RuleConverter = () => {
return {
notices: ["jsx-a11y/alt-text covers more cases than react-a11y-image-button-has-alt"],
plugins: ["jsx-a11y"],
rules: [
{
ruleName: "jsx-a11y/alt-text",
},
],
};
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { RuleConverter } from "../ruleConverter";

export const convertReactA11yImgHasAlt: RuleConverter = (tslintRule) => {
return {
notices: ["jsx-a11y/alt-text covers more cases than react-a11y-img-has-alt"],
plugins: ["jsx-a11y"],
rules: [
{
...(tslintRule.ruleArguments.length !== 0 && {
ruleArguments: [
{
elements: tslintRule.ruleArguments,
},
],
}),
ruleName: "jsx-a11y/alt-text",
},
],
};
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { convertReactA11yImageButtonHasAlt } from "../react-a11y-image-button-has-alt";

describe(convertReactA11yImageButtonHasAlt, () => {
test("conversion without arguments", () => {
const result = convertReactA11yImageButtonHasAlt({
ruleArguments: [],
});

expect(result).toEqual({
notices: ["jsx-a11y/alt-text covers more cases than react-a11y-image-button-has-alt"],
plugins: ["jsx-a11y"],
rules: [
{
ruleName: "jsx-a11y/alt-text",
},
],
});
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { convertReactA11yImgHasAlt } from "../react-a11y-img-has-alt";

describe(convertReactA11yImgHasAlt, () => {
test("conversion without arguments", () => {
const result = convertReactA11yImgHasAlt({
ruleArguments: [],
});

expect(result).toEqual({
notices: ["jsx-a11y/alt-text covers more cases than react-a11y-img-has-alt"],
plugins: ["jsx-a11y"],
rules: [
{
ruleName: "jsx-a11y/alt-text",
},
],
});
});

test("conversion with an argument", () => {
const elements = ["Image"];
const result = convertReactA11yImgHasAlt({
ruleArguments: elements,
});

expect(result).toEqual({
notices: ["jsx-a11y/alt-text covers more cases than react-a11y-img-has-alt"],
plugins: ["jsx-a11y"],
rules: [
{
ruleArguments: [{ elements }],
ruleName: "jsx-a11y/alt-text",
},
],
});
});
});
2 changes: 2 additions & 0 deletions src/converters/lintConfigs/rules/ruleMergers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { mergeBanTypes } from "./ruleMergers/ban-types";
import { mergeConsistentTypeAssertions } from "./ruleMergers/consistent-type-assertions";
import { mergeIndent } from "./ruleMergers/indent";
import { mergeJsxA11yAltText } from "./ruleMergers/jsx-a11y-alt-text";
import { mergeNoMemberDelimiterStyle } from "./ruleMergers/member-delimiter-style";
import { mergeNamingConvention } from "./ruleMergers/naming-convention";
import { mergeNoEmpty } from "./ruleMergers/no-empty";
Expand All @@ -18,6 +19,7 @@ export const ruleMergers = new Map([
["@typescript-eslint/no-use-before-define", mergeNoUseBeforeDefine],
["@typescript-eslint/no-unnecessary-type-assertion", mergeNoUnnecessaryTypeAssertion],
["@typescript-eslint/triple-slash-reference", mergeTripleSlashReference],
["jsx-a11y/alt-text", mergeJsxA11yAltText],
["no-empty", mergeNoEmpty],
["no-eval", mergeNoEval],
]);
15 changes: 15 additions & 0 deletions src/converters/lintConfigs/rules/ruleMergers/jsx-a11y-alt-text.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { uniqueFromSources } from "../../../../utils";
import { RuleMerger } from "../ruleMerger";

export const mergeJsxA11yAltText: RuleMerger = (existingOptions, newOptions) => {
const existingElements = existingOptions?.[0]?.elements;
const newElements = newOptions?.[0]?.elements;

return existingElements || newElements
? [
{
elements: uniqueFromSources(existingElements ?? [], newElements ?? []),
},
]
: [];
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { mergeJsxA11yAltText } from "../jsx-a11y-alt-text";

describe(mergeJsxA11yAltText, () => {
test("neither options existing", () => {
const result = mergeJsxA11yAltText(undefined, undefined);

expect(result).toEqual([]);
});

test("original elements existing", () => {
const result = mergeJsxA11yAltText([{ elements: ["Image"] }], undefined);

expect(result).toEqual([{ elements: ["Image"] }]);
});

test("new elements existing", () => {
const result = mergeJsxA11yAltText(undefined, [{ elements: ["Image"] }]);

expect(result).toEqual([{ elements: ["Image"] }]);
});

test("both elements existing", () => {
const result = mergeJsxA11yAltText(
[{ elements: ["Button", "Image"] }],
[{ elements: ["Image"] }],
);

expect(result).toEqual([{ elements: ["Button", "Image"] }]);
});
});