Skip to content

Adding the neighbor package to the official Vale library.#25

Open
mikeyil wants to merge 2 commits into
vale-cli:masterfrom
mikeyil:patch-1
Open

Adding the neighbor package to the official Vale library.#25
mikeyil wants to merge 2 commits into
vale-cli:masterfrom
mikeyil:patch-1

Conversation

@mikeyil
Copy link
Copy Markdown

@mikeyil mikeyil commented May 23, 2026

This package is a companion to the @a11yfred/neighbor ESLint and Stylelint plugins. It provides prose linting rules focused on accessibility and inclusive language.

Specifically, it flags language patterns that affect readability, comprehension, and inclusion, such as:

  • Ableist terms and suffering framing (SC 3.1.1)
  • Disability metaphors
  • Opaque English idioms and business jargon (SC 3.1.5)
  • Directional layout references (SC 1.3.3)
  • ALL CAPS prose
  • Bare ampersands

This package is a companion to the `@a11yfred/neighbor` ESLint and Stylelint plugins. It provides prose linting rules focused on accessibility and inclusive language.

Specifically, it flags language patterns that affect readability, comprehension, and inclusion, such as:
- Ableist terms and suffering framing (SC 3.1.1)
- Disability metaphors 
- Opaque English idioms and business jargon (SC 3.1.5)
- Directional layout references (SC 1.3.3)
- ALL CAPS prose
- Bare ampersands
@mikeyil mikeyil marked this pull request as draft May 24, 2026 03:12
Updated the description for the 'neighbor' entry to clarify its purpose regarding accessibility and inclusive language.
Copy link
Copy Markdown
Author

@mikeyil mikeyil left a comment

Choose a reason for hiding this comment

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

Hi team! 👋

I’m submitting the neighbor package to the official library. It brings dedicated accessibility and inclusive language linting to Vale, flagging ableist terms, complex idioms, and directional layout references (which fail WCAG).

Rather than a one-off set of rules, this config is automatically generated from the a11yfred/neighbor ecosystem, meaning it shares a heavily researched, actively maintained source of truth with our ESLint and Stylelint plugins.

Checks should be passing! Let me know if you need anything else.

@mikeyil mikeyil marked this pull request as ready for review May 25, 2026 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant