eslint-plugin-primer-react 5.2.1-rc.1fbdfd0 → 5.2.1-rc.61b0e36

package/CHANGELOG.md

@@ -4,8 +4,6 @@
 
 ### Patch Changes
 
-- [#195](https://github.com/primer/eslint-plugin-primer-react/pull/195) [`ccc2e99`](https://github.com/primer/eslint-plugin-primer-react/commit/ccc2e995a3f46bb4842468188b91c0bd641da390) Thanks [@khiga8](https://github.com/khiga8)! - Clean up docs for link lint rule
-
 - [#193](https://github.com/primer/eslint-plugin-primer-react/pull/193) [`5fc19f6`](https://github.com/primer/eslint-plugin-primer-react/commit/5fc19f63a4916add7b3c335ac661119c50af17af) Thanks [@khiga8](https://github.com/khiga8)! - Update link lint rule to skip Link with className
 
 ## 5.2.0

package/README.md

@@ -33,8 +33,7 @@ ESLint rules for Primer React
 
 - [direct-slot-children](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/direct-slot-children.md)
 - [no-system-props](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/no-system-props.md)
-- [new-css-color-vars](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/new-css-color-vars.md)
-- [no-deprecated-props](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/no-deprecated-props.md)
 - [a11y-tooltip-interactive-trigger](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/a11y-tooltip-interactive-trigger.md)
 - [a11y-explicit-heading](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/a11y-explicit-heading.md)
-- [a11y-link-in-text-block](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/a11y-link-in-text-block.md)
+- [new-css-color-vars](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/new-css-color-vars.md)
+- [no-deprecated-props](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/no-deprecated-props.md)

package/docs/rules/a11y-link-in-text-block.md

@@ -1,25 +1,22 @@
-# EXPERIMENTAL: Require `inline` prop on `<Link>` in text block
+## Require `inline` prop on `<Link>` component inside a text block
 
-This is an experimental rule. If you suspect any false positives reported by this rule, please file an issue so we can make this rule better.
+The `Link` component should have the `inline` prop when it is used inside of a text block.
 
 ## Rule Details
 
-The `Link` component should have the `inline` prop when it is used within a text block and has no styles (aside from color) to distinguish itself from surrounding plain text.
+This rule enforces setting `inline` on the `<Link>` component when a `<Link>` is detected inside of a text block without distiguishable styling.
 
-Related: [WCAG 1.4.1 Use of Color issues](https://www.w3.org/WAI/WCAG21/Understanding/use-of-color.html)
+The lint rule will essentially flag any `<Link>` without the `inline` property (equal to `true`) detected with string nodes on either side.
 
-The lint rule will flag any `<Link>` without the `inline` property (equal to `true`) detected with string nodes on either side.
+This rule will not catch all instances of link in text block due to the limitations of static analysis, so be sure to also have in-browser checks in place such as the [link-in-text-block Axe rule](https://dequeuniversity.com/rules/axe/4.9/link-in-text-block) for additional coverage.
 
-There are certain edge cases that the linter skips to avoid false positives including:
+The edge cases that the linter skips to avoid false positives will include:
 
-- `<Link className="...">` because there may be distinguishing styles applied.
 - `<Link sx={{fontWeight:...}}>` or `<Link sx={{fontFamily:...}}>` because these technically may provide sufficient distinguishing styling.
 - `<Link>` where the only adjacent text is a period, since that can't really be considered a text block.
 - `<Link>` where the children is a JSX component, rather than a string literal, because then it might be an icon link rather than a text link.
 - `<Link>` that are nested inside of headings as these have often been breadcrumbs.
 
-This rule will not catch all instances of link in text block due to the limitations of static analysis, so be sure to also have in-browser checks in place such as the [link-in-text-block Axe rule](https://dequeuniversity.com/rules/axe/4.9/link-in-text-block) for additional coverage.
-
 👎 Examples of **incorrect** code for this rule
 
 ```jsx
@@ -96,18 +93,8 @@ function ExampleComponent() {
 }
 ```
 
-This rule will skip `Link`s with a `className`.
-
-```jsx
-function ExampleComponent() {
-  return (
-   Learn more at <Link className={styles.someDistinguishingStyle}>GitHub</Link>
-  )
-}
-```
-
 ## Options
 
 - `skipImportCheck` (default: `false`)
 
-By default, the `a11y-link-in-text-block` rule will only check for `<Link>` components imported directly from `@primer/react`. You can disable this behavior by setting `skipImportCheck` to `true`.
+By default, the `a11y-explicit-heading` rule will only check for `<Heading>` components imported directly from `@primer/react`. You can disable this behavior by setting `skipImportCheck` to `true`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-primer-react",
-  "version": "5.2.1-rc.1fbdfd0",
+  "version": "5.2.1-rc.61b0e36",
   "description": "ESLint rules for Primer React",
   "main": "src/index.js",
   "scripts": {

package/src/rules/a11y-link-in-text-block.js

@@ -4,9 +4,6 @@ const {getJSXOpeningElementAttribute} = require('../utils/get-jsx-opening-elemen
 
 module.exports = {
   meta: {
-    docs: {
-      url: require('../url')(module),
-    },
     type: 'problem',
     schema: [
       {
@@ -18,8 +15,7 @@ module.exports = {
       },
     ],
     messages: {
-      linkInTextBlock:
-        'Links should have the inline prop if it appear in a text block and only uses color to distinguish itself from surrounding text.',
+      linkInTextBlock: '<Link>s that are used within a text block should have the inline prop.',
     },
   },
   create(context) {