` elements. | |
| [noPositiveTabindex](/linter/rules/no-positive-tabindex) | Prevent the usage of positive integers on `tabindex` attribute. | |
+| [noSvgWithoutTitle](/linter/rules/no-svg-without-title) | Enforces the usage of the `title` element for the `svg` element. | |
| [useAriaPropsForRole](/linter/rules/use-aria-props-for-role) | Enforce that elements with ARIA roles must have all required ARIA attributes for that role. | |
| [useButtonType](/linter/rules/use-button-type) | Enforces the usage and validity of the attribute `type` for the element `button` | |
| [useHtmlLang](/linter/rules/use-html-lang) | Enforce that `html` element has `lang` attribute. | |
@@ -49,6 +50,7 @@ Below the list of rules supported by Biome, divided by group. Here's a legend of
- [noDistractingElements](/linter/rules/no-distracting-elements) (Severity: [error](/reference/diagnostics#error))
- [noHeaderScope](/linter/rules/no-header-scope) (Severity: [error](/reference/diagnostics#error))
- [noPositiveTabindex](/linter/rules/no-positive-tabindex) (Severity: [error](/reference/diagnostics#error))
+- [noSvgWithoutTitle](/linter/rules/no-svg-without-title) (Severity: [error](/reference/diagnostics#error))
- [useAriaPropsForRole](/linter/rules/use-aria-props-for-role) (Severity: [error](/reference/diagnostics#error))
- [useButtonType](/linter/rules/use-button-type) (Severity: [error](/reference/diagnostics#error))
- [useHtmlLang](/linter/rules/use-html-lang) (Severity: [error](/reference/diagnostics#error))
diff --git a/src/content/docs/linter/rules/no-svg-without-title.mdx b/src/content/docs/linter/rules/no-svg-without-title.mdx
index 9e50c5b3b..2a93f4657 100644
--- a/src/content/docs/linter/rules/no-svg-without-title.mdx
+++ b/src/content/docs/linter/rules/no-svg-without-title.mdx
@@ -137,6 +137,148 @@ To make svg accessible, the following methods are available:
- [Source Code](https://github.com/biomejs/biome/blob/main/crates/biome_js_analyze/src/lint/a11y/no_svg_without_title.rs)
- [Test Cases](https://github.com/biomejs/biome/blob/main/crates/biome_js_analyze/tests/specs/a11y/noSvgWithoutTitle)
+
+
+:::note
+This rule has been implemented but not released yet. It will be available in the next release.
+:::
+## Summary
+- Diagnostic Category: [`lint/a11y/noSvgWithoutTitle`](/reference/diagnostics#diagnostic-category)
+- This rule is **recommended**, which means is enabled by default.
+- This rule doesn't have a fix.
+- The default severity of this rule is [**error**](/reference/diagnostics#error).
+## How to configure
+```json title="biome.json"
+{
+ "linter": {
+ "rules": {
+ "a11y": {
+ "noSvgWithoutTitle": "error"
+ }
+ }
+ }
+}
+
+```
+## Description
+Enforces the usage of the `title` element for the `svg` element.
+
+It is not possible to specify the `alt` attribute for the `svg` as for the `img`.
+To make svg accessible, the following methods are available:
+
+- provide the `title` element as the first child to `svg`
+- provide `role="img"` and `aria-label` or `aria-labelledby` to `svg`
+
+## Examples
+
+### Invalid
+
+```html
+
+```
+
+
ℹFor accessibility purposes, SVGs should have an alternative text, provided via title element. If the svg element has role="img", you should add the aria-label or aria-labelledby attribute.
ℹFor accessibility purposes, SVGs should have an alternative text, provided via title element. If the svg element has role="img", you should add the aria-label or aria-labelledby attribute.
ℹFor accessibility purposes, SVGs should have an alternative text, provided via title element. If the svg element has role="img", you should add the aria-label or aria-labelledby attribute.
ℹFor accessibility purposes, SVGs should have an alternative text, provided via title element. If the svg element has role="img", you should add the aria-label or aria-labelledby attribute.
### Valid
@@ -63,12 +88,21 @@ interface I {
function f(a: number | string): void {}
```
+```ts
+function f({ a }: Record<"a", string | boolean>): void;
+```
+
```ts
interface I {
a(x?: number): void;
}
```
+```ts
+export function fizzbuzz([fizz, buzz]: [number, number] | [string, string]): void;
+export default function fizzbuzz([fizz, buzz]: [string | number, string | number]): void {}
+```
+
Different return types cannot be merged:
```ts
@@ -86,6 +120,82 @@ function f(x: T): void;
function f(x: unknown): void {}
```
+Different rest signatures cannot be merged:
+(cf https://github.com/microsoft/TypeScript/issues/5077)
+
+```ts
+function foo(...x: string[]): void;
+function foo(...x: number[]): void;
+function foo(...x: any[]): void {}
+```
+
+## Options
+
+### `ignoreDifferentlyNamedParameters`
+
+If set to `true`, overloads with differently named parameters will be ignored,
+even if said parameters would be of otherwise mergeable types.
+
+Parameter declarations that lack specified "names" (such as array spread and destructuring literals)
+will be ignored for this check.
+
+Default: `false`
+
+```json title='biome.json'
+{
+ "linter": {
+ "rules": {
+ "style": {
+ "useUnifiedTypeSignatures": {
+ "options": {
+ "ignoreDifferentlyNamedParameters": true
+ }
+ }
+ }
+ }
+ }
+}
+
+```
+
+```ts
+function bake(numApples: number): void;
+function bake(cakeType: string): void;
+```
+
+### `ignoreDifferentJsDoc`
+
+If set to `true`, overloads with different JSDoc comments from one another will be ignored.
+Ones with identical comments will be merged as normal.
+
+Default: `false`
+
+```json title='biome.json'
+{
+ "linter": {
+ "rules": {
+ "style": {
+ "useUnifiedTypeSignatures": {
+ "options": {
+ "ignoreDifferentJsDoc": true
+ }
+ }
+ }
+ }
+ }
+}
+
+```
+
+```ts
+/** Print foo + 1 */
+function doThing(foo: number): void;
+/** Print foo concatenated with 3 */
+function doThing(foo: string): void;
+/** @deprecated - don't use this, it crashes the program */
+function doThing(foo: boolean): void;
+```
+
## Related links
- [Disable a rule](/linter/#disable-a-rule)
diff --git a/src/pages/metadata/rules.json.js b/src/pages/metadata/rules.json.js
index e902f523c..c48e1744f 100644
--- a/src/pages/metadata/rules.json.js
+++ b/src/pages/metadata/rules.json.js
@@ -684,6 +684,15 @@ export function GET() {
],
"docs": " Prevent the usage of positive integers on `tabindex` attribute.\n\n Avoid positive `tabindex` attribute values to synchronize the flow of the page with keyboard tab order.\n\n ## Accessibility guidelines\n\n [WCAG 2.4.3](https://www.w3.org/WAI/WCAG21/Understanding/focus-order)\n\n ## Examples\n\n ### Invalid\n\n ```html,expect_diagnostic\n \n ```\n\n ```html,expect_diagnostic\n \n ```\n\n ### Valid\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n"
},
+ "noSvgWithoutTitle": {
+ "deprecated": false,
+ "version": "next",
+ "name": "noSvgWithoutTitle",
+ "link": "https://biomejs.dev/linter/rules/no-svg-without-title",
+ "recommended": true,
+ "fixKind": "none",
+ "docs": " Enforces the usage of the `title` element for the `svg` element.\n\n It is not possible to specify the `alt` attribute for the `svg` as for the `img`.\n To make svg accessible, the following methods are available:\n - provide the `title` element as the first child to `svg`\n - provide `role=\"img\"` and `aria-label` or `aria-labelledby` to `svg`\n\n ## Examples\n\n ### Invalid\n\n ```html,expect_diagnostic\n \n ```\n\n ```html,expect_diagnostic\n \n ```\n\n ```html,expect_diagnostic\n \n ```\n\n ```html,expect_diagnostic\n \n ```\n\n ### Valid\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n ```html\n \n ```\n\n\n\n ## Accessibility guidelines\n [Document Structure – SVG 1.1 (Second Edition)](https://www.w3.org/TR/SVG11/struct.html#DescriptionAndTitleElements)\n [ARIA: img role - Accessibility | MDN](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/img_role)\n [Accessible SVGs | CSS-Tricks - CSS-Tricks](https://css-tricks.com/accessible-svgs/)\n [Contextually Marking up accessible images and SVGs | scottohara.me](https://www.scottohara.me/blog/2019/05/22/contextual-images-svgs-and-a11y.html)\n [Accessible SVGs](https://www.unimelb.edu.au/accessibility/techniques/accessible-svgs)\n\n"
+ },
"useAriaPropsForRole": {
"deprecated": false,
"version": "next",
@@ -6971,7 +6980,7 @@ export function GET() {
}
}
],
- "docs": " Disallow overload signatures that can be unified into a single signature.\n\n Overload signatures that can be merged into a single signature are redundant and should be avoided.\n This rule helps simplify function signatures by combining overloads by making parameters optional\n and/or using type unions.\n\n ## Examples\n\n ### Invalid\n\n ```ts,expect_diagnostic\n function f(a: number): void;\n function f(a: string): void;\n ```\n\n ```ts,expect_diagnostic\n interface I {\n a(): void;\n a(x: number): void;\n }\n ```\n\n ### Valid\n\n ```ts\n function f(a: number | string): void {}\n ```\n\n ```ts\n interface I {\n a(x?: number): void;\n }\n ```\n\n Different return types cannot be merged:\n ```ts\n interface I {\n f(): void;\n f(x: number): number;\n }\n ```\n\n Different type parameters cannot be merged:\n ```ts\n function f(x: T): void;\n function f(x: T): void;\n function f(x: unknown): void {}\n ```\n\n"
+ "docs": " Disallow overload signatures that can be unified into a single signature.\n\n Overload signatures that can be merged into a single signature are redundant and should be avoided.\n This rule helps simplify function signatures by combining overloads by making parameters optional\n and/or using type unions.\n\n ## Examples\n\n ### Invalid\n\n ```ts,expect_diagnostic\n function f(a: number): void;\n function f(a: string): void;\n ```\n\n ```ts,expect_diagnostic\n function f({ a }: Record<\"a\", string>): void;\n function f({ a }: Record<\"a\", boolean>): void;\n function f(obj: any): void {};\n ```\n\n ```ts,expect_diagnostic\n type T = {\n a(): void;\n a(x: number): void;\n }\n ```\n\n ```ts,expect_diagnostic\n interface I {\n (): void;\n (x: number): void;\n }\n ```\n\n ```ts,expect_diagnostic\n export function fizzbuzz([fizz, buzz]: [number, number]): void;\n export function fizzbuzz([fizz, buzz]: [string, string]): void;\n export default function fizzbuzz([fizz, buzz]: [string | number, string | number]): void {}\n ```\n\n ### Valid\n\n ```ts\n function f(a: number | string): void {}\n ```\n\n ```ts\n function f({ a }: Record<\"a\", string | boolean>): void;\n ```\n\n ```ts\n interface I {\n a(x?: number): void;\n }\n ```\n\n ```ts\n export function fizzbuzz([fizz, buzz]: [number, number] | [string, string]): void;\n export default function fizzbuzz([fizz, buzz]: [string | number, string | number]): void {}\n ```\n\n Different return types cannot be merged:\n ```ts\n interface I {\n f(): void;\n f(x: number): number;\n }\n ```\n\n Different type parameters cannot be merged:\n ```ts\n function f(x: T): void;\n function f(x: T): void;\n function f(x: unknown): void {}\n ```\n\n Different rest signatures cannot be merged:\n (cf https://github.com/microsoft/TypeScript/issues/5077)\n ```ts\n function foo(...x: string[]): void;\n function foo(...x: number[]): void;\n function foo(...x: any[]): void {}\n ```\n\n ## Options\n\n ### `ignoreDifferentlyNamedParameters`\n\n If set to `true`, overloads with differently named parameters will be ignored,\n even if said parameters would be of otherwise mergeable types.\n\n Parameter declarations that lack specified \"names\" (such as array spread and destructuring literals)\n will be ignored for this check.\n\n Default: `false`\n\n ```json,options\n {\n \"options\": {\n \"ignoreDifferentlyNamedParameters\": true\n }\n }\n ```\n\n ```ts,use_options\n function bake(numApples: number): void;\n function bake(cakeType: string): void;\n ```\n\n ### `ignoreDifferentJsDoc`\n\n If set to `true`, overloads with different JSDoc comments from one another will be ignored.\n Ones with identical comments will be merged as normal.\n\n Default: `false`\n\n ```json,options\n {\n \"options\": {\n \"ignoreDifferentJsDoc\": true\n }\n }\n ```\n\n ```ts,use_options\n /** Print foo + 1 */\n function doThing(foo: number): void;\n /** Print foo concatenated with 3 */\n function doThing(foo: string): void;\n /** @deprecated - don't use this, it crashes the program */\n function doThing(foo: boolean): void;\n ```\n\n"
}
},
"suspicious": {
@@ -7124,7 +7133,7 @@ export function GET() {
}
}
},
- "numberOrRules": 411
+ "numberOrRules": 412
},
"syntax": {
"languages": {