double-great / alt-text Goto Github PK

@katydecorah looks like we need to find a replacement for https://git.io

Git.io is a URL shortening website that GitHub created in 2011 for redirecting to GitHub domains like github.com and github.io. What began as an experiment was only lightly documented and thus not heavily used.

GitHub is not uniquely qualified to run this type of service. There are many URL shortening services available today that have more capabilities than git.io. At GitHub, we want to focus on building great developer tools and cede URL shortening to companies and teams who provide it as a core offering.

For these reasons, we have disallowed new link creation on git.io. We encourage using one of the many URL shortening services that are available, instead of git.io, as it likely will be fully deprecated at some yet to be determined date.

via https://github.blog/changelog/2022-01-11-git-io-no-longer-accepts-new-urls

We'll need to catch empty string and undefined values as right now they'll fail with TypeError: Cannot read property 'toLowerCase' of undefined.

@jsnmrs how should alt-text respond to:

• an empty string altText('') - an empty string is technically correct for decorative images, should we still warn and provide that feedback?
• undefined altText() - should this return the same message regarding missing alt attribute? in thinking how how someone could supply undefined, it's likely there isn't an alt attribute at all 🤔

• what is the purpose of this project?
• examples of good/bad alt text
• links to sources
• how to install, use (🔜 https://github.com/double-great/remark-lint-alt-text)
• examples of usage

separate list for exact (full) matches. List should include:

• image
• graphic
• photo
• photograph
• drawing
• painting
• artwork
• logo
• bullet
• button
• arrow
• more
• spacer
• blank
• chart
• table
• diagram
• graph
• "*" (bullet)
• " " (space)

The standalone test for a single space can't be removed afterwards.

To help documentation semantics

We should consider adding sounds files of a screen reader reading alt text in the documentation. This can help the developer hear the differences between the recommended and discouraged alt text.

To do:

• Learn: What does emoji sound like to a screen reader?

While updating dependencies, I noticed 11 test failures, related to TinyURL returning http://tinyurl.com... instead of https://tinyurl.com.... It also looks like our TinyURL dependency is no longer maintained (archived).

We should find an alternative.

We should allow for each to rule to be configurable where possible, but set the default to recommendations.

add test for:

alt text matches filename

![myimage.png](./images/myimage.png)

![https://raw.githubusercontent.com/strapi/strapi-starter-gatsby-blog/master/medias/skip.png](https://raw.githubusercontent.com/strapi/strapi-starter-gatsby-blog/master/medias/skip.png "screen shot of sample cut and paste webhook url") 

It could be helpful to provide a passing versus warning example for some of the rules, for example:

Alt text should not end with

Warning: Alt text should not end with "<.jpg|.jpeg|.gif|.png|.svg|.webp|image|graphic>"

• ✅ A child holding a photograph.
• 🚫 child.jpg

Since context is important, it could be more approachable to rename "warnings" to "suggestions" in the documentation.

https://github.com/double-great/alt-text#end-in-a-period

Will other punctuation (like ? or !) also make screen readers pause a bit after the last word in the alt text? Or does that only happen for a period?

We should group tests by rule and add labels to better organize and document intent for each test.