Katie Foster
🤔 ️️️️♿️
Kendall Gassner
💻 ️️️️♿️ 📖 🚇
Kate Higa
💻 ️️️️♿️ 📖 🚇
HonkingGoose
📖
JoshuaKGoldberg
💻
');
7 | expect(result).toBe("- Images should have alternate text (alt text) at line 1");
8 | result = await validate('');
9 | expect(result).toBe("- Images should have alternate text (alt text) at line 1");
10 | result = await validate('');
11 | expect(result).toBe("- Images should have alternate text (alt text) at line 1");
12 | });
13 | test("no-default-alt-text: should return errors", async () => {
14 | let result = await validate("![Cleanshot 2020-01-01 at 12.00.00.png]()");
15 | expect(result).toBe(
16 | "- Images should have meaningful alternative text (alt text) at line 1"
17 | );
18 | result = await validate("![Clean shot 2020-12-01 @12x]()");
19 | expect(result).toBe(
20 | "- Images should have meaningful alternative text (alt text) at line 1"
21 | );
22 | result = await validate("![Clean shot 2020-12-01 @12x]()");
23 | expect(result).toBe(
24 | "- Images should have meaningful alternative text (alt text) at line 1"
25 | );
26 |
27 | result = await validate("![Screen Shot 2020-01-01 at 12.00.00.png]()");
28 | expect(result).toBe(
29 | "- Images should have meaningful alternative text (alt text) at line 1"
30 | );
31 | result = await validate("![Screenshot 2020-01-01 at 12.00.00.png]()");
32 | expect(result).toBe(
33 | "- Images should have meaningful alternative text (alt text) at line 1"
34 | );
35 | result = await validate("![Screencast 2020-01-01 at 12.00.00.png]()");
36 | expect(result).toBe(
37 | "- Images should have meaningful alternative text (alt text) at line 1"
38 | );
39 | result = await validate("![image]()");
40 | expect(result).toBe(
41 | "- Images should have meaningful alternative text (alt text) at line 1"
42 | );
43 | result = await validate("![Image]()");
44 | expect(result).toBe(
45 | "- Images should have meaningful alternative text (alt text) at line 1"
46 | );
47 | result = await validate("Check this: ![Image]()");
48 | expect(result).toBe(
49 | "- Images should have meaningful alternative text (alt text) at line 1"
50 | );
51 | result = await validate("My awesome ![image]()");
52 | expect(result).toBe(
53 | "- Images should have meaningful alternative text (alt text) at line 1"
54 | );
55 | result = await validate('Check this out: ');
56 | expect(result).toBe(
57 | "- Images should have meaningful alternative text (alt text) at line 1"
58 | );
59 | result = await validate('');
60 | expect(result).toBe(
61 | "- Images should have meaningful alternative text (alt text) at line 1"
62 | );
63 | result = await validate('');
64 | expect(result).toBe(
65 | "- Please provide an alternative text for the image. at line 1"
66 | );
67 | result = await validate("");
68 | expect(result).toBe(
69 | "- Please provide an alternative text for the image. at line 1"
70 | );
71 | result = await validate(
72 | ''
73 | );
74 | expect(result).toBe(
75 | "- Images should have meaningful alternative text (alt text) at line 1"
76 | );
77 | result = await validate(
78 | ''
79 | );
80 | expect(result).toBe(
81 | "- Images should have meaningful alternative text (alt text) at line 1"
82 | );
83 | result = await validate(
84 | ''
85 | );
86 | expect(result).toBe(
87 | "- Images should have meaningful alternative text (alt text) at line 1"
88 | );
89 | result = await validate(
90 | ''
91 | );
92 | result = await validate('');
93 | expect(result).toBe(
94 | "- Images should have meaningful alternative text (alt text) at line 1"
95 | );
96 | expect(result).toBe(
97 | "- Images should have meaningful alternative text (alt text) at line 1"
98 | );
99 | });
100 |
101 |
102 | test("no-generic-link-text: should return errors", async () => {
103 | const config = `
104 | no-default-alt-text: true,
105 | no-alt-text: true,
106 | no-empty-alt-text: true,
107 | no-generic-link-text: true,`
108 |
109 | // default configuration does not check for improper links
110 | const result = await validate("[Learn more](https://docs.github.com)", config);
111 | expect(result).toBe("- Avoid using generic link text like `Learn more` or `Click here` at line 1");
112 | });
113 |
114 |
115 | test("no-alt-text: should not return errors", async () => {
116 | let result = await validate("```![]()```");
117 | expect(result).toBe("");
118 | });
119 |
120 | test("no-generic-link-text: should not return errors", async () => {
121 | // default configuration does not check for improper links
122 | const result = await validate("[Learn more](https://docs.github.com)");
123 | expect(result).toBe("");
124 | });
125 |
126 | test("no-default-alt-text: should not return errors", async () => {
127 | let result = await validate("");
128 | expect(result).toBe("");
129 | result = await validate(
130 | "![Screen shot of Submit button with updated color contrast.]()"
131 | );
132 | expect(result).toBe("");
133 | result = await validate("![Image of a cat]()");
134 | expect(result).toBe("");
135 | result = await validate("![Screenshot of the new GitHub home page]()");
136 | expect(result).toBe("");
137 | result = await validate(
138 | '
'
139 | );
140 | expect(result).toBe("");
141 | result = await validate(
142 | ''
143 | );
144 | expect(result).toBe("");
145 | result = await validate('');
146 | expect(result).toBe("");
147 | result = await validate('');
148 | expect(result).toBe("");
149 | result = await validate(
150 | '``````'
151 | );
152 | expect(result).toBe("");
153 | result = await validate("```![Image]()```");
154 | expect(result).toBe("");
155 | });
156 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Accessibility-alt-text-bot
2 |
3 | This action reminds users to add a meaningful alternative text to their images.
4 | Alternative text helps users who rely on tools like screen readers, and lowers accessibility barriers.
5 |
6 | The action can check:
7 |
8 | - Issue comments
9 | - Issue descriptions
10 | - Pull Request comments
11 | - Pull Request descriptions
12 | - Discussion comments
13 | - Discussion descriptions
14 |
15 | To learn how to write good alternative text, read [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images).
16 |
17 | ## Why you may need this action
18 |
19 | Images on GitHub default to using the filename as alt text.
20 | This action flags when the alt text has not been updated from the default:
21 |
22 | Katie Foster 🤔 ️️️️♿️ |
120 | Kendall Gassner 💻 ️️️️♿️ 📖 🚇 |
121 | Kate Higa 💻 ️️️️♿️ 📖 🚇 |
122 | HonkingGoose 📖 |
123 | JoshuaKGoldberg 💻 |
124 |