Schema URL

Type: object

The configuration that is contained inside the file biome.json

Properties

$schema Schema | null

A field for the JSON schema specification

assist AssistConfiguration | null

Specific configuration for assists

css CssConfiguration | null

Specific configuration for the Css language

extends Extends | null

A list of paths to other JSON files, used to extends the current configuration.

files FilesConfiguration | null

The configuration of the filesystem

formatter FormatterConfiguration | null

The configuration of the formatter

graphql GraphqlConfiguration | null

Specific configuration for the GraphQL language

grit GritConfiguration | null

Specific configuration for the GraphQL language

html HtmlConfiguration | null

Specific configuration for the HTML language

javascript JsConfiguration | null

Specific configuration for the JavaScript language

json JsonConfiguration | null

Specific configuration for the Json language

linter LinterConfiguration | null

The configuration for the linter

overrides Overrides | null

A list of granular patterns that should be applied only to a sub set of files

plugins Plugins | null

List of plugins to load.

root Bool | null

Indicates whether this configuration file is at the root of a Biome project. By default, this is true.

vcs VcsConfiguration | null

The configuration of the VCS integration

Definitions

A11y object

A list of rules that belong to this group

noAccessKey NoAccessKeyConfiguration | null

Enforce that the accessKey attribute is not used on any HTML element. See https://biomejs.dev/linter/rules/no-access-key

noAriaHiddenOnFocusable NoAriaHiddenOnFocusableConfiguration | null

Enforce that aria-hidden="true" is not set on focusable elements. See https://biomejs.dev/linter/rules/no-aria-hidden-on-focusable

noAriaUnsupportedElements NoAriaUnsupportedElementsConfiguration | null

Enforce that elements that do not support ARIA roles, states, and properties do not have those attributes. See https://biomejs.dev/linter/rules/no-aria-unsupported-elements

noAutofocus NoAutofocusConfiguration | null

Enforce that autoFocus prop is not used on elements. See https://biomejs.dev/linter/rules/no-autofocus

noDistractingElements NoDistractingElementsConfiguration | null

Enforces that no distracting elements are used. See https://biomejs.dev/linter/rules/no-distracting-elements

noHeaderScope NoHeaderScopeConfiguration | null

The scope prop should be used only on <th> elements. See https://biomejs.dev/linter/rules/no-header-scope

noInteractiveElementToNoninteractiveRole NoInteractiveElementToNoninteractiveRoleConfiguration | null

Enforce that non-interactive ARIA roles are not assigned to interactive HTML elements. See https://biomejs.dev/linter/rules/no-interactive-element-to-noninteractive-role

noLabelWithoutControl NoLabelWithoutControlConfiguration | null

Enforce that a label element or component has a text label and an associated input. See https://biomejs.dev/linter/rules/no-label-without-control

noNoninteractiveElementInteractions NoNoninteractiveElementInteractionsConfiguration | null

Disallow use event handlers on non-interactive elements. See https://biomejs.dev/linter/rules/no-noninteractive-element-interactions

noNoninteractiveElementToInteractiveRole NoNoninteractiveElementToInteractiveRoleConfiguration | null

Enforce that interactive ARIA roles are not assigned to non-interactive HTML elements. See https://biomejs.dev/linter/rules/no-noninteractive-element-to-interactive-role

noNoninteractiveTabindex NoNoninteractiveTabindexConfiguration | null

Enforce that tabIndex is not assigned to non-interactive HTML elements. See https://biomejs.dev/linter/rules/no-noninteractive-tabindex

noPositiveTabindex NoPositiveTabindexConfiguration | null

Prevent the usage of positive integers on tabIndex property. See https://biomejs.dev/linter/rules/no-positive-tabindex

noRedundantAlt NoRedundantAltConfiguration | null

Enforce img alt prop does not contain the word "image", "picture", or "photo". See https://biomejs.dev/linter/rules/no-redundant-alt

noRedundantRoles NoRedundantRolesConfiguration | null

Enforce explicit role property is not the same as implicit/default role property on an element. See https://biomejs.dev/linter/rules/no-redundant-roles

noStaticElementInteractions NoStaticElementInteractionsConfiguration | null

Enforce that static, visible elements (such as <div>) that have click handlers use the valid role attribute. See https://biomejs.dev/linter/rules/no-static-element-interactions

noSvgWithoutTitle NoSvgWithoutTitleConfiguration | null

Enforces the usage of the title element for the svg element. See https://biomejs.dev/linter/rules/no-svg-without-title

recommended boolean | null

Enables the recommended rules for this group

useAltText UseAltTextConfiguration | null

Enforce that all elements that require alternative text have meaningful information to relay back to the end user. See https://biomejs.dev/linter/rules/use-alt-text

useAnchorContent UseAnchorContentConfiguration | null

Enforce that anchors have content and that the content is accessible to screen readers. See https://biomejs.dev/linter/rules/use-anchor-content

useAriaActivedescendantWithTabindex UseAriaActivedescendantWithTabindexConfiguration | null

Enforce that tabIndex is assigned to non-interactive HTML elements with aria-activedescendant. See https://biomejs.dev/linter/rules/use-aria-activedescendant-with-tabindex

useAriaPropsForRole UseAriaPropsForRoleConfiguration | null

Enforce that elements with ARIA roles must have all required ARIA attributes for that role. See https://biomejs.dev/linter/rules/use-aria-props-for-role

useAriaPropsSupportedByRole UseAriaPropsSupportedByRoleConfiguration | null

Enforce that ARIA properties are valid for the roles that are supported by the element. See https://biomejs.dev/linter/rules/use-aria-props-supported-by-role

useButtonType UseButtonTypeConfiguration | null

Enforces the usage of the attribute type for the element button. See https://biomejs.dev/linter/rules/use-button-type

useFocusableInteractive UseFocusableInteractiveConfiguration | null

Elements with an interactive role and interaction handlers must be focusable. See https://biomejs.dev/linter/rules/use-focusable-interactive

useGenericFontNames UseGenericFontNamesConfiguration | null

Disallow a missing generic family keyword within font families. See https://biomejs.dev/linter/rules/use-generic-font-names

useHeadingContent UseHeadingContentConfiguration | null

Enforce that heading elements (h1, h2, etc.) have content and that the content is accessible to screen readers. Accessible means that it is not hidden using the aria-hidden prop. See https://biomejs.dev/linter/rules/use-heading-content

useHtmlLang UseHtmlLangConfiguration | null

Enforce that html element has lang attribute. See https://biomejs.dev/linter/rules/use-html-lang

useIframeTitle UseIframeTitleConfiguration | null

Enforces the usage of the attribute title for the element iframe. See https://biomejs.dev/linter/rules/use-iframe-title

useKeyWithClickEvents UseKeyWithClickEventsConfiguration | null

Enforce onClick is accompanied by at least one of the following: onKeyUp, onKeyDown, onKeyPress. See https://biomejs.dev/linter/rules/use-key-with-click-events

useKeyWithMouseEvents UseKeyWithMouseEventsConfiguration | null

Enforce onMouseOver / onMouseOut are accompanied by onFocus / onBlur. See https://biomejs.dev/linter/rules/use-key-with-mouse-events

useMediaCaption UseMediaCaptionConfiguration | null

Enforces that audio and video elements must have a track for captions. See https://biomejs.dev/linter/rules/use-media-caption

useSemanticElements UseSemanticElementsConfiguration | null

It detects the use of role attributes in JSX elements and suggests using semantic elements instead. See https://biomejs.dev/linter/rules/use-semantic-elements

useValidAnchor UseValidAnchorConfiguration | null

Enforce that all anchors are valid, and they are navigable elements. See https://biomejs.dev/linter/rules/use-valid-anchor

useValidAriaProps UseValidAriaPropsConfiguration | null

Ensures that ARIA properties aria-* are all valid. See https://biomejs.dev/linter/rules/use-valid-aria-props

useValidAriaRole UseValidAriaRoleConfiguration | null

Elements with ARIA roles must use a valid, non-abstract ARIA role. See https://biomejs.dev/linter/rules/use-valid-aria-role

useValidAriaValues UseValidAriaValuesConfiguration | null

Enforce that ARIA state and property values are valid. See https://biomejs.dev/linter/rules/use-valid-aria-values

useValidAutocomplete UseValidAutocompleteConfiguration | null

Use valid values for the autocomplete attribute on input elements. See https://biomejs.dev/linter/rules/use-valid-autocomplete

useValidLang UseValidLangConfiguration | null

Ensure that the attribute passed to the lang attribute is a correct ISO language and/or country. See https://biomejs.dev/linter/rules/use-valid-lang

Accessibility string
Actions object
recommended boolean | null

It enables the assist actions recommended by Biome. true by default.

source Source | null
ArrowParentheses string
AssistConfiguration object
actions Actions | null

Whether Biome should fail in CLI if the assist were not applied to the code.

enabled Bool | null

Whether Biome should enable assist via LSP and CLI.

includes array | null

A list of glob patterns. Biome will include files/folders that will match these patterns.

AttributePosition string
Bool boolean
BracketSameLine boolean

Put the > of a multi-line HTML or JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).

BracketSpacing boolean
Complexity object

A list of rules that belong to this group

noAdjacentSpacesInRegex NoAdjacentSpacesInRegexConfiguration | null

Disallow unclear usage of consecutive space characters in regular expression literals. See https://biomejs.dev/linter/rules/no-adjacent-spaces-in-regex

noArguments NoArgumentsConfiguration | null

Disallow the use of arguments. See https://biomejs.dev/linter/rules/no-arguments

noBannedTypes NoBannedTypesConfiguration | null

Disallow primitive type aliases and misleading types. See https://biomejs.dev/linter/rules/no-banned-types

noCommaOperator NoCommaOperatorConfiguration | null
noEmptyTypeParameters NoEmptyTypeParametersConfiguration | null

Disallow empty type parameters in type aliases and interfaces. See https://biomejs.dev/linter/rules/no-empty-type-parameters

noExcessiveCognitiveComplexity NoExcessiveCognitiveComplexityConfiguration | null

Disallow functions that exceed a given Cognitive Complexity score. See https://biomejs.dev/linter/rules/no-excessive-cognitive-complexity

noExcessiveLinesPerFunction NoExcessiveLinesPerFunctionConfiguration | null

Restrict the number of lines of code in a function. See https://biomejs.dev/linter/rules/no-excessive-lines-per-function

noExcessiveNestedTestSuites NoExcessiveNestedTestSuitesConfiguration | null

This rule enforces a maximum depth to nested describe() in test files. See https://biomejs.dev/linter/rules/no-excessive-nested-test-suites

noExtraBooleanCast NoExtraBooleanCastConfiguration | null

Disallow unnecessary boolean casts. See https://biomejs.dev/linter/rules/no-extra-boolean-cast

noFlatMapIdentity NoFlatMapIdentityConfiguration | null

Disallow to use unnecessary callback on flatMap. See https://biomejs.dev/linter/rules/no-flat-map-identity

noForEach NoForEachConfiguration | null

Prefer for...of statement instead of Array.forEach. See https://biomejs.dev/linter/rules/no-for-each

noImplicitCoercions NoImplicitCoercionsConfiguration | null

Disallow shorthand type conversions. See https://biomejs.dev/linter/rules/no-implicit-coercions

noImportantStyles NoImportantStylesConfiguration | null

Disallow the use of the !important style. See https://biomejs.dev/linter/rules/no-important-styles

noStaticOnlyClass NoStaticOnlyClassConfiguration | null

This rule reports when a class has no non-static members, such as for a class used exclusively as a static namespace. See https://biomejs.dev/linter/rules/no-static-only-class

noThisInStatic NoThisInStaticConfiguration | null

Disallow this and super in static contexts. See https://biomejs.dev/linter/rules/no-this-in-static

noUselessCatch NoUselessCatchConfiguration | null

Disallow unnecessary catch clauses. See https://biomejs.dev/linter/rules/no-useless-catch

noUselessConstructor NoUselessConstructorConfiguration | null

Disallow unnecessary constructors. See https://biomejs.dev/linter/rules/no-useless-constructor

noUselessContinue NoUselessContinueConfiguration | null

Avoid using unnecessary continue. See https://biomejs.dev/linter/rules/no-useless-continue

noUselessEmptyExport NoUselessEmptyExportConfiguration | null

Disallow empty exports that don't change anything in a module file. See https://biomejs.dev/linter/rules/no-useless-empty-export

noUselessEscapeInRegex NoUselessEscapeInRegexConfiguration | null

Disallow unnecessary escape sequence in regular expression literals. See https://biomejs.dev/linter/rules/no-useless-escape-in-regex

noUselessFragments NoUselessFragmentsConfiguration | null

Disallow unnecessary fragments. See https://biomejs.dev/linter/rules/no-useless-fragments

noUselessLabel NoUselessLabelConfiguration | null

Disallow unnecessary labels. See https://biomejs.dev/linter/rules/no-useless-label

noUselessLoneBlockStatements NoUselessLoneBlockStatementsConfiguration | null

Disallow unnecessary nested block statements. See https://biomejs.dev/linter/rules/no-useless-lone-block-statements

noUselessRename NoUselessRenameConfiguration | null

Disallow renaming import, export, and destructured assignments to the same name. See https://biomejs.dev/linter/rules/no-useless-rename

noUselessStringConcat NoUselessStringConcatConfiguration | null

Disallow unnecessary concatenation of string or template literals. See https://biomejs.dev/linter/rules/no-useless-string-concat

noUselessStringRaw NoUselessStringRawConfiguration | null

Disallow unnecessary String.raw function in template string literals without any escape sequence. See https://biomejs.dev/linter/rules/no-useless-string-raw

noUselessSwitchCase NoUselessSwitchCaseConfiguration | null

Disallow useless case in switch statements. See https://biomejs.dev/linter/rules/no-useless-switch-case

noUselessTernary NoUselessTernaryConfiguration | null

Disallow ternary operators when simpler alternatives exist. See https://biomejs.dev/linter/rules/no-useless-ternary

noUselessThisAlias NoUselessThisAliasConfiguration | null

Disallow useless this aliasing. See https://biomejs.dev/linter/rules/no-useless-this-alias

noUselessTypeConstraint NoUselessTypeConstraintConfiguration | null

Disallow using any or unknown as type constraint. See https://biomejs.dev/linter/rules/no-useless-type-constraint

noUselessUndefinedInitialization NoUselessUndefinedInitializationConfiguration | null

Disallow initializing variables to undefined. See https://biomejs.dev/linter/rules/no-useless-undefined-initialization

noVoid NoVoidConfiguration | null

Disallow the use of void operators, which is not a familiar operator. See https://biomejs.dev/linter/rules/no-void

recommended boolean | null

Enables the recommended rules for this group

useArrowFunction UseArrowFunctionConfiguration | null

Use arrow functions over function expressions. See https://biomejs.dev/linter/rules/use-arrow-function

useDateNow UseDateNowConfiguration | null

Use Date.now() to get the number of milliseconds since the Unix Epoch. See https://biomejs.dev/linter/rules/use-date-now

useFlatMap UseFlatMapConfiguration | null

Promotes the use of .flatMap() when map().flat() are used together. See https://biomejs.dev/linter/rules/use-flat-map

useIndexOf UseIndexOfConfiguration | null

Prefer Array#{indexOf,lastIndexOf}() over Array#{findIndex,findLastIndex}() when looking for the index of an item. See https://biomejs.dev/linter/rules/use-index-of

useLiteralKeys UseLiteralKeysConfiguration | null

Enforce the usage of a literal access to properties over computed property access. See https://biomejs.dev/linter/rules/use-literal-keys

useNumericLiterals UseNumericLiteralsConfiguration | null

Disallow parseInt() and Number.parseInt() in favor of binary, octal, and hexadecimal literals. See https://biomejs.dev/linter/rules/use-numeric-literals

useOptionalChain UseOptionalChainConfiguration | null

Enforce using concise optional chain instead of chained logical expressions. See https://biomejs.dev/linter/rules/use-optional-chain

useRegexLiterals UseRegexLiteralsConfiguration | null

Enforce the use of the regular expression literals instead of the RegExp constructor if possible. See https://biomejs.dev/linter/rules/use-regex-literals

useSimpleNumberKeys UseSimpleNumberKeysConfiguration | null

Disallow number literal object member names which are not base 10 or use underscore as separator. See https://biomejs.dev/linter/rules/use-simple-number-keys

useSimplifiedLogicExpression UseSimplifiedLogicExpressionConfiguration | null

Discard redundant terms from logical expressions. See https://biomejs.dev/linter/rules/use-simplified-logic-expression

useWhile UseWhileConfiguration | null

Enforce the use of while loops instead of for loops when the initializer and update expressions are not needed. See https://biomejs.dev/linter/rules/use-while

ConsistentArrayType string | string
ConsistentTypeDefinition string | string
Convention object
formats Format[]
uniqueItems=true
match Regex | null

Regular expression to enforce

selector object
3 nested properties
kind string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
uniqueItems=true
scope string
Values: "any" "global"
Correctness object

A list of rules that belong to this group

noChildrenProp NoChildrenPropConfiguration | null

Prevent passing of children as props. See https://biomejs.dev/linter/rules/no-children-prop

noConstAssign NoConstAssignConfiguration | null

Prevents from having const variables being re-assigned. See https://biomejs.dev/linter/rules/no-const-assign

noConstantCondition NoConstantConditionConfiguration | null

Disallow constant expressions in conditions. See https://biomejs.dev/linter/rules/no-constant-condition

noConstantMathMinMaxClamp NoConstantMathMinMaxClampConfiguration | null

Disallow the use of Math.min and Math.max to clamp a value where the result itself is constant. See https://biomejs.dev/linter/rules/no-constant-math-min-max-clamp

noConstructorReturn NoConstructorReturnConfiguration | null

Disallow returning a value from a constructor. See https://biomejs.dev/linter/rules/no-constructor-return

noEmptyCharacterClassInRegex NoEmptyCharacterClassInRegexConfiguration | null

Disallow empty character classes in regular expression literals. See https://biomejs.dev/linter/rules/no-empty-character-class-in-regex

noEmptyPattern NoEmptyPatternConfiguration | null

Disallows empty destructuring patterns. See https://biomejs.dev/linter/rules/no-empty-pattern

noGlobalDirnameFilename NoGlobalDirnameFilenameConfiguration | null

Disallow the use of __dirname and __filename in the global scope. See https://biomejs.dev/linter/rules/no-global-dirname-filename

noGlobalObjectCalls NoGlobalObjectCallsConfiguration | null

Disallow calling global object properties as functions. See https://biomejs.dev/linter/rules/no-global-object-calls

noInnerDeclarations NoInnerDeclarationsConfiguration | null

Disallow function and var declarations that are accessible outside their block. See https://biomejs.dev/linter/rules/no-inner-declarations

noInvalidBuiltinInstantiation NoInvalidBuiltinInstantiationConfiguration | null

Ensure that builtins are correctly instantiated. See https://biomejs.dev/linter/rules/no-invalid-builtin-instantiation

noInvalidConstructorSuper NoInvalidConstructorSuperConfiguration | null

Prevents the incorrect use of super() inside classes. It also checks whether a call super() is missing from classes that extends other constructors. See https://biomejs.dev/linter/rules/no-invalid-constructor-super

noInvalidDirectionInLinearGradient NoInvalidDirectionInLinearGradientConfiguration | null

Disallow non-standard direction values for linear gradient functions. See https://biomejs.dev/linter/rules/no-invalid-direction-in-linear-gradient

noInvalidGridAreas NoInvalidGridAreasConfiguration | null

Disallows invalid named grid areas in CSS Grid Layouts. See https://biomejs.dev/linter/rules/no-invalid-grid-areas

noInvalidPositionAtImportRule NoInvalidPositionAtImportRuleConfiguration | null

Disallow the use of @import at-rules in invalid positions. See https://biomejs.dev/linter/rules/no-invalid-position-at-import-rule

noInvalidUseBeforeDeclaration NoInvalidUseBeforeDeclarationConfiguration | null

Disallow the use of variables, function parameters, classes, and enums before their declaration. See https://biomejs.dev/linter/rules/no-invalid-use-before-declaration

noMissingVarFunction NoMissingVarFunctionConfiguration | null

Disallow missing var function for css variables. See https://biomejs.dev/linter/rules/no-missing-var-function

noNestedComponentDefinitions NoNestedComponentDefinitionsConfiguration | null

Disallows defining React components inside other components. See https://biomejs.dev/linter/rules/no-nested-component-definitions

noNodejsModules NoNodejsModulesConfiguration | null

Forbid the use of Node.js builtin modules. See https://biomejs.dev/linter/rules/no-nodejs-modules

noNonoctalDecimalEscape NoNonoctalDecimalEscapeConfiguration | null

Disallow \8 and \9 escape sequences in string literals. See https://biomejs.dev/linter/rules/no-nonoctal-decimal-escape

noPrecisionLoss NoPrecisionLossConfiguration | null

Disallow literal numbers that lose precision. See https://biomejs.dev/linter/rules/no-precision-loss

noPrivateImports NoPrivateImportsConfiguration | null

Restrict imports of private exports. See https://biomejs.dev/linter/rules/no-private-imports

noProcessGlobal NoProcessGlobalConfiguration | null

Disallow the use of process global. See https://biomejs.dev/linter/rules/no-process-global

noQwikUseVisibleTask NoQwikUseVisibleTaskConfiguration | null

Disallow useVisibleTask$() functions in Qwik components. See https://biomejs.dev/linter/rules/no-qwik-use-visible-task

noReactPropAssignments NoReactPropAssignmentsConfiguration | null

Disallow assigning to React component props. See https://biomejs.dev/linter/rules/no-react-prop-assignments

noRenderReturnValue NoRenderReturnValueConfiguration | null

Prevent the usage of the return value of React.render. See https://biomejs.dev/linter/rules/no-render-return-value

noRestrictedElements NoRestrictedElementsConfiguration | null

Disallow the use of configured elements. See https://biomejs.dev/linter/rules/no-restricted-elements

noSelfAssign NoSelfAssignConfiguration | null

Disallow assignments where both sides are exactly the same. See https://biomejs.dev/linter/rules/no-self-assign

noSetterReturn NoSetterReturnConfiguration | null

Disallow returning a value from a setter. See https://biomejs.dev/linter/rules/no-setter-return

noSolidDestructuredProps NoSolidDestructuredPropsConfiguration | null

Disallow destructuring props inside JSX components in Solid projects. See https://biomejs.dev/linter/rules/no-solid-destructured-props

noStringCaseMismatch NoStringCaseMismatchConfiguration | null

Disallow comparison of expressions modifying the string case with non-compliant value. See https://biomejs.dev/linter/rules/no-string-case-mismatch

noSwitchDeclarations NoSwitchDeclarationsConfiguration | null

Disallow lexical declarations in switch clauses. See https://biomejs.dev/linter/rules/no-switch-declarations

noUndeclaredDependencies NoUndeclaredDependenciesConfiguration | null

Disallow the use of dependencies that aren't specified in the package.json. See https://biomejs.dev/linter/rules/no-undeclared-dependencies

noUndeclaredVariables NoUndeclaredVariablesConfiguration | null

Prevents the usage of variables that haven't been declared inside the document. See https://biomejs.dev/linter/rules/no-undeclared-variables

noUnknownFunction NoUnknownFunctionConfiguration | null

Disallow unknown CSS value functions. See https://biomejs.dev/linter/rules/no-unknown-function

noUnknownMediaFeatureName NoUnknownMediaFeatureNameConfiguration | null

Disallow unknown media feature names. See https://biomejs.dev/linter/rules/no-unknown-media-feature-name

noUnknownProperty NoUnknownPropertyConfiguration | null
noUnknownPseudoClass NoUnknownPseudoClassConfiguration | null

Disallow unknown pseudo-class selectors. See https://biomejs.dev/linter/rules/no-unknown-pseudo-class

noUnknownPseudoElement NoUnknownPseudoElementConfiguration | null

Disallow unknown pseudo-element selectors. See https://biomejs.dev/linter/rules/no-unknown-pseudo-element

noUnknownTypeSelector NoUnknownTypeSelectorConfiguration | null

Disallow unknown type selectors. See https://biomejs.dev/linter/rules/no-unknown-type-selector

noUnknownUnit NoUnknownUnitConfiguration | null

Disallow unknown CSS units. See https://biomejs.dev/linter/rules/no-unknown-unit

noUnmatchableAnbSelector NoUnmatchableAnbSelectorConfiguration | null

Disallow unmatchable An+B selectors. See https://biomejs.dev/linter/rules/no-unmatchable-anb-selector

noUnreachable NoUnreachableConfiguration | null

Disallow unreachable code. See https://biomejs.dev/linter/rules/no-unreachable

noUnreachableSuper NoUnreachableSuperConfiguration | null

Ensures the super() constructor is called exactly once on every code path in a class constructor before this is accessed if the class has a superclass. See https://biomejs.dev/linter/rules/no-unreachable-super

noUnsafeFinally NoUnsafeFinallyConfiguration | null

Disallow control flow statements in finally blocks. See https://biomejs.dev/linter/rules/no-unsafe-finally

noUnsafeOptionalChaining NoUnsafeOptionalChainingConfiguration | null

Disallow the use of optional chaining in contexts where the undefined value is not allowed. See https://biomejs.dev/linter/rules/no-unsafe-optional-chaining

noUnusedFunctionParameters NoUnusedFunctionParametersConfiguration | null

Disallow unused function parameters. See https://biomejs.dev/linter/rules/no-unused-function-parameters

noUnusedImports NoUnusedImportsConfiguration | null
noUnusedLabels NoUnusedLabelsConfiguration | null
noUnusedPrivateClassMembers NoUnusedPrivateClassMembersConfiguration | null

Disallow unused private class members. See https://biomejs.dev/linter/rules/no-unused-private-class-members

noUnusedVariables NoUnusedVariablesConfiguration | null
noVoidElementsWithChildren NoVoidElementsWithChildrenConfiguration | null

This rules prevents void elements (AKA self-closing elements) from having children. See https://biomejs.dev/linter/rules/no-void-elements-with-children

noVoidTypeReturn NoVoidTypeReturnConfiguration | null

Disallow returning a value from a function with the return type 'void'. See https://biomejs.dev/linter/rules/no-void-type-return

recommended boolean | null

Enables the recommended rules for this group

useExhaustiveDependencies UseExhaustiveDependenciesConfiguration | null

Enforce correct dependency usage within React hooks. See https://biomejs.dev/linter/rules/use-exhaustive-dependencies

useGraphqlNamedOperations UseGraphqlNamedOperationsConfiguration | null

Enforce specifying the name of GraphQL operations. See https://biomejs.dev/linter/rules/use-graphql-named-operations

useHookAtTopLevel UseHookAtTopLevelConfiguration | null

Enforce that all React hooks are being called from the Top Level component functions. See https://biomejs.dev/linter/rules/use-hook-at-top-level

useImageSize UseImageSizeConfiguration | null

Enforces that <img> elements have both width and height attributes. See https://biomejs.dev/linter/rules/use-image-size

useImportExtensions UseImportExtensionsConfiguration | null

Enforce file extensions for relative imports. See https://biomejs.dev/linter/rules/use-import-extensions

useIsNan UseIsNanConfiguration | null

Require calls to isNaN() when checking for NaN. See https://biomejs.dev/linter/rules/use-is-nan

useJsonImportAttributes UseJsonImportAttributesConfiguration | null

Enforces the use of with { type: "json" } for JSON module imports. See https://biomejs.dev/linter/rules/use-json-import-attributes

useJsxKeyInIterable UseJsxKeyInIterableConfiguration | null

Disallow missing key props in iterators/collection literals. See https://biomejs.dev/linter/rules/use-jsx-key-in-iterable

useParseIntRadix UseParseIntRadixConfiguration | null

Enforce the consistent use of the radix argument when using parseInt(). See https://biomejs.dev/linter/rules/use-parse-int-radix

useQwikClasslist UseQwikClasslistConfiguration | null

Prefer using the class prop as a classlist over the classnames helper. See https://biomejs.dev/linter/rules/use-qwik-classlist

useSingleJsDocAsterisk UseSingleJsDocAsteriskConfiguration | null

Enforce JSDoc comment lines to start with a single asterisk, except for the first one. See https://biomejs.dev/linter/rules/use-single-js-doc-asterisk

useUniqueElementIds UseUniqueElementIdsConfiguration | null

Prevent the usage of static string literal id attribute on elements. See https://biomejs.dev/linter/rules/use-unique-element-ids

useValidForDirection UseValidForDirectionConfiguration | null

Enforce "for" loop update clause moving the counter in the right direction. See https://biomejs.dev/linter/rules/use-valid-for-direction

useValidTypeof UseValidTypeofConfiguration | null

This rule checks that the result of a typeof expression is compared to a valid value. See https://biomejs.dev/linter/rules/use-valid-typeof

useYield UseYieldConfiguration | null

Require generator functions to contain yield. See https://biomejs.dev/linter/rules/use-yield

CssAssistConfiguration object

Options that changes how the CSS assist behaves

enabled Bool | null

Control the assist for CSS files.

CssConfiguration object

Options applied to CSS files

assist CssAssistConfiguration | null

CSS assist options

Default: null
formatter CssFormatterConfiguration | null

CSS formatter options

Default: null
globals array | null

CSS globals

uniqueItems=true
linter CssLinterConfiguration | null

CSS linter options

Default: null
parser CssParserConfiguration | null

CSS parsing options

Default: null
CssFormatterConfiguration object

Options that changes how the CSS formatter behaves

enabled Bool | null

Control the formatter for CSS (and its super languages) files.

indentStyle IndentStyle | null

The indent style applied to CSS (and its super languages) files.

indentWidth IndentWidth | null

The size of the indentation applied to CSS (and its super languages) files. Default to 2.

lineEnding LineEnding | null

The type of line ending applied to CSS (and its super languages) files. auto uses CRLF on Windows and LF on other platforms.

lineWidth LineWidth | null

What's the max width of a line applied to CSS (and its super languages) files. Defaults to 80.

quoteStyle QuoteStyle | null

The type of quotes used in CSS code. Defaults to double.

CssLinterConfiguration object

Options that changes how the CSS linter behaves

enabled Bool | null

Control the linter for CSS files.

CssParserConfiguration object

Options that changes how the CSS parser behaves

allowWrongLineComments Bool | null

Allow comments to appear on incorrect lines in .css files

cssModules Bool | null

Enables parsing of CSS Modules specific features.

tailwindDirectives Bool | null

Enables parsing of Tailwind CSS 4.0 directives and functions.

Default: null
CustomRestrictedElements Record<string, string>

Elements to restrict. Each key is the element name, and the value is the message to show when the element is used.

CustomRestrictedType string | CustomRestrictedTypeOptions
CustomRestrictedTypeOptions object
message string
Default: ""
use string | null
Default: null
DeclarationStyle string | string
DependencyAvailability boolean | string[]
Expand string | string | string
Extends string[] | string
FilenameCase string | string | string | string | string

Supported cases for file names.

FilenameCases FilenameCase[]
FilesConfiguration object

The configuration of the filesystem

experimentalScannerIgnores array | null

Deprecated: Please use force-ignore syntax in files.includes instead: https://biomejs.dev/reference/configuration/#filesincludes

Set of file and folder names that should be unconditionally ignored by Biome's scanner.

ignoreUnknown Bool | null

Tells Biome to not emit diagnostics when handling files that it doesn't know

includes array | null

A list of glob patterns. Biome will handle only those files/folders that will match these patterns.

maxSize MaxSize | null

The maximum allowed size for source code files in bytes. Files above this limit will be ignored for performance reasons. Defaults to 1 MiB

FixKind string | string | string

Used to identify the kind of code action emitted by a rule

Format string

Supported cases.

Formats Format[]
FormatterConfiguration object

Generic options applied to all files

attributePosition AttributePosition | null

The attribute position style in HTML-ish languages. Defaults to auto.

bracketSameLine BracketSameLine | null

Put the > of a multi-line HTML or JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).

bracketSpacing BracketSpacing | null

Whether to insert spaces around brackets in object literals. Defaults to true.

enabled Bool | null
expand Expand | null

Whether to expand arrays and objects on multiple lines. When set to auto, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to always, these literals are formatted on multiple lines, regardless of length of the list. When set to never, these literals are formatted on a single line if it fits in the line. When formatting package.json, Biome will use always unless configured otherwise. Defaults to "auto".

formatWithErrors Bool | null

Whether formatting should be allowed to proceed if a given file has syntax errors

includes array | null

A list of glob patterns. The formatter will include files/folders that will match these patterns.

indentStyle IndentStyle | null

The indent style.

indentWidth IndentWidth | null

The size of the indentation, 2 by default

lineEnding LineEnding | null

The type of line ending.

lineWidth LineWidth | null

What's the max width of a line. Defaults to 80.

useEditorconfig Bool | null

Use any .editorconfig files to configure the formatter. Configuration in biome.json will override .editorconfig configuration.

Default: true.

Glob string
GraphqlAssistConfiguration object

Options that changes how the GraphQL linter behaves

enabled Bool | null

Control the formatter for GraphQL files.

Default: null
GraphqlConfiguration object

Options applied to GraphQL files

Assist options

GraphQL formatter options

GraphqlFormatterConfiguration object

Options that changes how the GraphQL formatter behaves

bracketSpacing BracketSpacing | null

Whether to insert spaces around brackets in object literals. Defaults to true.

Default: null
enabled Bool | null

Control the formatter for GraphQL files.

Default: null
indentStyle IndentStyle | null

The indent style applied to GraphQL files.

Default: null
indentWidth IndentWidth | null

The size of the indentation applied to GraphQL files. Default to 2.

Default: null
lineEnding LineEnding | null

The type of line ending applied to GraphQL files. auto uses CRLF on Windows and LF on other platforms.

Default: null
lineWidth LineWidth | null

What's the max width of a line applied to GraphQL files. Defaults to 80.

Default: null
quoteStyle QuoteStyle | null

The type of quotes used in GraphQL code. Defaults to double.

Default: null
GraphqlLinterConfiguration object

Options that change how the GraphQL linter behaves.

enabled Bool | null

Control the formatter for GraphQL files.

Default: null
GritAssistConfiguration object
enabled Bool | null

Control the assist functionality for Grit files.

GritConfiguration object

Options applied to GritQL files

assist GritAssistConfiguration | null

Assist options

formatter GritFormatterConfiguration | null

Formatting options

linter GritLinterConfiguration | null

Formatting options

GritFormatterConfiguration object
enabled Bool | null

Control the formatter for Grit files.

indentStyle IndentStyle | null

The indent style applied to Grit files.

indentWidth IndentWidth | null

The size of the indentation applied to Grit files. Default to 2.

lineEnding LineEnding | null

The type of line ending applied to Grit files.

lineWidth LineWidth | null

What's the max width of a line applied to Grit files. Defaults to 80.

GritLinterConfiguration object
enabled Bool | null

Control the linter for Grit files.

GroupMatcher ImportMatcher | SourceMatcher
GroupPlainConfiguration string | string | string | string | string
Hook object
closureIndex integer | null

The "position" of the closure function, starting from zero.

For example, for React's useEffect() hook, the closure index is 0.

Default: null
format=uint8min=0max=255
dependenciesIndex integer | null

The "position" of the array of dependencies, starting from zero.

For example, for React's useEffect() hook, the dependencies index is 1.

Default: null
format=uint8min=0max=255
name string

The name of the hook.

Default: ""
stableResult StableHookResult | null

Whether the result of the hook is stable.

Set to true to mark the identity of the hook's return value as stable, or use a number/an array of numbers to mark the "positions" in the return array as stable.

For example, for React's useRef() hook the value would be true, while for useState() it would be [1].

Default: null
HtmlAssistConfiguration object

Options that changes how the HTML assist behaves

enabled Bool | null

Control the assist for HTML (and its super languages) files.

HtmlConfiguration object

Options applied to HTML files

assist HtmlAssistConfiguration | null
experimentalFullSupportEnabled Bool | null

Enables full support for HTML, Vue, Svelte and Astro files.

formatter HtmlFormatterConfiguration | null

HTML formatter options

linter HtmlLinterConfiguration | null

HTML linter options

parser HtmlParserConfiguration | null

HTML parsing options

HtmlFormatterConfiguration object

Options that changes how the HTML formatter behaves

attributePosition AttributePosition | null

The attribute position style in HTML elements. Defaults to auto.

bracketSameLine BracketSameLine | null

Whether to hug the closing bracket of multiline HTML tags to the end of the last line, rather than being alone on the following line. Defaults to false.

enabled Bool | null

Control the formatter for HTML (and its super languages) files.

indentScriptAndStyle IndentScriptAndStyle | null

Whether to indent the <script> and <style> tags for HTML (and its super languages). Defaults to false.

indentStyle IndentStyle | null

The indent style applied to HTML (and its super languages) files.

indentWidth IndentWidth | null

The size of the indentation applied to HTML (and its super languages) files. Default to 2.

lineEnding LineEnding | null

The type of line ending applied to HTML (and its super languages) files. auto uses CRLF on Windows and LF on other platforms.

lineWidth LineWidth | null

What's the max width of a line applied to HTML (and its super languages) files. Defaults to 80.

selfCloseVoidElements SelfCloseVoidElements | null

Whether void elements should be self-closed. Defaults to never.

whitespaceSensitivity WhitespaceSensitivity | null

Whether to account for whitespace sensitivity when formatting HTML (and its super languages). Defaults to "css".

HtmlLinterConfiguration object

Options that changes how the HTML linter behaves

enabled Bool | null

Control the linter for HTML (and its super languages) files.

HtmlParserConfiguration object

Options that changes how the HTML parser behaves

interpolation Bool | null

Enables the parsing of double text expressions such as {{ expression }} inside .html files

ImportGroup null | GroupMatcher | GroupMatcher[]
ImportGroups ImportGroup[]
ImportMatcher object
source SourcesMatcher | null
type boolean | null
ImportSourceGlob string
IndentScriptAndStyle boolean

Whether to indent the content of <script> and <style> tags for HTML-ish templating languages (Vue, Svelte, etc.).

When true, the content of <script> and <style> tags will be indented one level.

IndentStyle string | string
IndentWidth integer
JsAssistConfiguration object

Assist options specific to the JavaScript assist

enabled Bool | null

Control the assist for JavaScript (and its super languages) files.

JsConfiguration object

A set of options applied to the JavaScript files

assist JsAssistConfiguration | null

Assist options

formatter JsFormatterConfiguration | null

Formatting options

globals array | null

A list of global bindings that should be ignored by the analyzers

If defined here, they should not emit diagnostics.

uniqueItems=true
jsxRuntime JsxRuntime | null

Indicates the type of runtime or transformation used for interpreting JSX.

linter JsLinterConfiguration | null

Linter options

parser JsParserConfiguration | null

Parsing options

JsFormatterConfiguration object

Formatting options specific to the JavaScript files

arrowParentheses ArrowParentheses | null

Whether to add non-necessary parentheses to arrow functions. Defaults to "always".

attributePosition AttributePosition | null

The attribute position style in JSX elements. Defaults to auto.

bracketSameLine BracketSameLine | null

Whether to hug the closing bracket of multiline HTML/JSX tags to the end of the last line, rather than being alone on the following line. Defaults to false.

bracketSpacing BracketSpacing | null

Whether to insert spaces around brackets in object literals. Defaults to true.

enabled Bool | null

Control the formatter for JavaScript (and its super languages) files.

expand Expand | null

Whether to expand arrays and objects on multiple lines. When set to auto, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to always, these literals are formatted on multiple lines, regardless of length of the list. When set to never, these literals are formatted on a single line if it fits in the line. When formatting package.json, Biome will use always unless configured otherwise. Defaults to "auto".

indentStyle IndentStyle | null

The indent style applied to JavaScript (and its super languages) files.

indentWidth IndentWidth | null

The size of the indentation applied to JavaScript (and its super languages) files. Default to 2.

jsxQuoteStyle QuoteStyle | null

The type of quotes used in JSX. Defaults to double.

lineEnding LineEnding | null

The type of line ending applied to JavaScript (and its super languages) files. auto uses CRLF on Windows and LF on other platforms.

lineWidth LineWidth | null

What's the max width of a line applied to JavaScript (and its super languages) files. Defaults to 80.

operatorLinebreak OperatorLinebreak | null

When breaking binary expressions into multiple lines, whether to break them before or after the binary operator. Defaults to "after".

quoteProperties QuoteProperties | null

When properties in objects are quoted. Defaults to asNeeded.

quoteStyle QuoteStyle | null

The type of quotes used in JavaScript code. Defaults to double.

semicolons Semicolons | null

Whether the formatter prints semicolons for all statements or only in for statements where it is necessary because of ASI.

trailingCommas JsTrailingCommas | null

Print trailing commas wherever possible in multi-line comma-separated syntactic structures. Defaults to "all".

JsLinterConfiguration object

Linter options specific to the JavaScript linter

enabled Bool | null

Control the linter for JavaScript (and its super languages) files.

JsParserConfiguration object

Options that changes how the JavaScript parser behaves

gritMetavariables Bool | null

Enables parsing of Grit metavariables. Defaults to false.

jsxEverywhere Bool | null

When enabled, files like .js/.mjs/.cjs may contain JSX syntax.

Defaults to true.

unsafeParameterDecoratorsEnabled Bool | null

It enables the experimental and unsafe parsing of parameter decorators

These decorators belong to an old proposal, and they are subject to change.

JsTrailingCommas string

Print trailing commas wherever possible in multi-line comma-separated syntactic structures for JavaScript/TypeScript files.

JsonAssistConfiguration object

Assist options specific to the JSON linter

enabled Bool | null

Control the assist for JSON (and its super languages) files.

JsonConfiguration object

Options applied to JSON files

assist JsonAssistConfiguration | null

Assist options

formatter JsonFormatterConfiguration | null

Formatting options

linter JsonLinterConfiguration | null

Linting options

parser JsonParserConfiguration | null

Parsing options

JsonFormatterConfiguration object
bracketSpacing BracketSpacing | null

Whether to insert spaces around brackets in object literals. Defaults to true.

enabled Bool | null

Control the formatter for JSON (and its super languages) files.

expand Expand | null

Whether to expand arrays and objects on multiple lines. When set to auto, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to always, these literals are formatted on multiple lines, regardless of length of the list. When set to never, these literals are formatted on a single line if it fits in the line. When formatting package.json, Biome will use always unless configured otherwise. Defaults to "auto".

indentStyle IndentStyle | null

The indent style applied to JSON (and its super languages) files.

indentWidth IndentWidth | null

The size of the indentation applied to JSON (and its super languages) files. Default to 2.

lineEnding LineEnding | null

The type of line ending applied to JSON (and its super languages) files. auto uses CRLF on Windows and LF on other platforms.

lineWidth LineWidth | null

What's the max width of a line applied to JSON (and its super languages) files. Defaults to 80.

trailingCommas JsonTrailingCommas | null

Print trailing commas wherever possible in multi-line comma-separated syntactic structures. Defaults to "none".

JsonLinterConfiguration object

Linter options specific to the JSON linter

enabled Bool | null

Control the linter for JSON (and its super languages) files.

JsonParserConfiguration object

Options that changes how the JSON parser behaves

allowComments Bool | null

Allow parsing comments in .json files

allowTrailingCommas Bool | null

Allow parsing trailing commas in .json files

JsonTrailingCommas string

Print trailing commas wherever possible in multi-line comma-separated syntactic structures for JSON files.

JsxRuntime string | string

Indicates the type of runtime or transformation used for interpreting JSX.

Kind string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
LineEnding string | string | string | string
LineWidth integer

Validated value for the line_width formatter options

The allowed range of values is 1..=320

LinterConfiguration object
domains RuleDomains | null

An object where the keys are the names of the domains, and the values are all, recommended, or none.

enabled Bool | null

if false, it disables the feature and the linter won't be executed. true by default

includes array | null

A list of glob patterns. The analyzer will handle only those files/folders that will match these patterns.

rules Rules | null

List of rules

MaxSize integer
Modifiers RestrictedModifier[]
NegatablePredefinedSourceMatcher string
NoAccessKeyConfiguration RulePlainConfiguration | RuleWithNoAccessKeyOptions
NoAccessKeyOptions object
NoAccumulatingSpreadConfiguration RulePlainConfiguration | RuleWithNoAccumulatingSpreadOptions
NoAccumulatingSpreadOptions object
NoAdjacentSpacesInRegexConfiguration RulePlainConfiguration | RuleWithNoAdjacentSpacesInRegexOptions
NoAdjacentSpacesInRegexOptions object
NoAlertConfiguration RulePlainConfiguration | RuleWithNoAlertOptions
NoAlertOptions object
NoAmbiguousAnchorTextConfiguration RulePlainConfiguration | RuleWithNoAmbiguousAnchorTextOptions
NoAmbiguousAnchorTextOptions object
words array | null

It allows users to modify the strings that can be checked for in the anchor text. Useful for specifying other words in other languages

Default: null
NoApproximativeNumericConstantConfiguration RulePlainConfiguration | RuleWithNoApproximativeNumericConstantOptions
NoApproximativeNumericConstantOptions object
NoArgumentsConfiguration RulePlainConfiguration | RuleWithNoArgumentsOptions
NoArgumentsOptions object
NoAriaHiddenOnFocusableConfiguration RulePlainConfiguration | RuleWithNoAriaHiddenOnFocusableOptions
NoAriaHiddenOnFocusableOptions object
NoAriaUnsupportedElementsConfiguration RulePlainConfiguration | RuleWithNoAriaUnsupportedElementsOptions
NoAriaUnsupportedElementsOptions object
NoArrayIndexKeyConfiguration RulePlainConfiguration | RuleWithNoArrayIndexKeyOptions
NoArrayIndexKeyOptions object
NoAssignInExpressionsConfiguration RulePlainConfiguration | RuleWithNoAssignInExpressionsOptions
NoAssignInExpressionsOptions object
NoAsyncPromiseExecutorConfiguration RulePlainConfiguration | RuleWithNoAsyncPromiseExecutorOptions
NoAsyncPromiseExecutorOptions object
NoAutofocusConfiguration RulePlainConfiguration | RuleWithNoAutofocusOptions
NoAutofocusOptions object
NoAwaitInLoopsConfiguration RulePlainConfiguration | RuleWithNoAwaitInLoopsOptions
NoAwaitInLoopsOptions object
NoBannedTypesConfiguration RulePlainConfiguration | RuleWithNoBannedTypesOptions
NoBannedTypesOptions object
NoBarrelFileConfiguration RulePlainConfiguration | RuleWithNoBarrelFileOptions
NoBarrelFileOptions object
NoBeforeInteractiveScriptOutsideDocumentConfiguration RulePlainConfiguration | RuleWithNoBeforeInteractiveScriptOutsideDocumentOptions
NoBeforeInteractiveScriptOutsideDocumentOptions object
NoBiomeFirstExceptionConfiguration RulePlainConfiguration | RuleWithNoBiomeFirstExceptionOptions
NoBiomeFirstExceptionOptions object
NoBitwiseOperatorsConfiguration RulePlainConfiguration | RuleWithNoBitwiseOperatorsOptions
NoBitwiseOperatorsOptions object
allow array | null

Allows a list of bitwise operators to be used as exceptions.

NoBlankTargetConfiguration RulePlainConfiguration | RuleWithNoBlankTargetOptions
NoBlankTargetOptions object
allowDomains string[]

List of domains where target="_blank" is allowed without rel="noopener".

allowNoReferrer boolean | null

Whether noreferrer is allowed in addition to noopener.

NoCatchAssignConfiguration RulePlainConfiguration | RuleWithNoCatchAssignOptions
NoCatchAssignOptions object
NoChildrenPropConfiguration RulePlainConfiguration | RuleWithNoChildrenPropOptions
NoChildrenPropOptions object
NoClassAssignConfiguration RulePlainConfiguration | RuleWithNoClassAssignOptions
NoClassAssignOptions object
NoCommaOperatorConfiguration RulePlainConfiguration | RuleWithNoCommaOperatorOptions
NoCommaOperatorOptions object
NoCommentTextConfiguration RulePlainConfiguration | RuleWithNoCommentTextOptions
NoCommentTextOptions object
NoCommonJsConfiguration RulePlainConfiguration | RuleWithNoCommonJsOptions
NoCommonJsOptions object
NoCompareNegZeroConfiguration RulePlainConfiguration | RuleWithNoCompareNegZeroOptions
NoCompareNegZeroOptions object
NoConfusingLabelsConfiguration RulePlainConfiguration | RuleWithNoConfusingLabelsOptions
NoConfusingLabelsOptions object
allowedLabels array | null

A list of (non-confusing) labels that should be allowed

NoConfusingVoidTypeConfiguration RulePlainConfiguration | RuleWithNoConfusingVoidTypeOptions
NoConfusingVoidTypeOptions object
NoConsoleConfiguration RulePlainConfiguration | RuleWithNoConsoleOptions
NoConsoleOptions object
allow array | null

Allowed calls on the console object.

NoConstAssignConfiguration RulePlainConfiguration | RuleWithNoConstAssignOptions
NoConstAssignOptions object
NoConstEnumConfiguration RulePlainConfiguration | RuleWithNoConstEnumOptions
NoConstEnumOptions object
NoConstantBinaryExpressionsConfiguration RulePlainConfiguration | RuleWithNoConstantBinaryExpressionsOptions
NoConstantBinaryExpressionsOptions object
NoConstantConditionConfiguration RulePlainConfiguration | RuleWithNoConstantConditionOptions
NoConstantConditionOptions object
NoConstantMathMinMaxClampConfiguration RulePlainConfiguration | RuleWithNoConstantMathMinMaxClampOptions
NoConstantMathMinMaxClampOptions object
NoConstructorReturnConfiguration RulePlainConfiguration | RuleWithNoConstructorReturnOptions
NoConstructorReturnOptions object
NoContinueConfiguration RulePlainConfiguration | RuleWithNoContinueOptions
NoContinueOptions object
NoControlCharactersInRegexConfiguration RulePlainConfiguration | RuleWithNoControlCharactersInRegexOptions
NoControlCharactersInRegexOptions object
NoDangerouslySetInnerHtmlConfiguration RulePlainConfiguration | RuleWithNoDangerouslySetInnerHtmlOptions
NoDangerouslySetInnerHtmlOptions object
NoDangerouslySetInnerHtmlWithChildrenConfiguration RulePlainConfiguration | RuleWithNoDangerouslySetInnerHtmlWithChildrenOptions
NoDangerouslySetInnerHtmlWithChildrenOptions object
NoDebuggerConfiguration RulePlainConfiguration | RuleWithNoDebuggerOptions
NoDebuggerOptions object
NoDefaultExportConfiguration RulePlainConfiguration | RuleWithNoDefaultExportOptions
NoDefaultExportOptions object
NoDeleteConfiguration RulePlainConfiguration | RuleWithNoDeleteOptions
NoDeleteOptions object
NoDeprecatedImportsConfiguration RulePlainConfiguration | RuleWithNoDeprecatedImportsOptions
NoDeprecatedImportsOptions object
NoDescendingSpecificityConfiguration RulePlainConfiguration | RuleWithNoDescendingSpecificityOptions
NoDescendingSpecificityOptions object
NoDistractingElementsConfiguration RulePlainConfiguration | RuleWithNoDistractingElementsOptions
NoDistractingElementsOptions object
NoDocumentCookieConfiguration RulePlainConfiguration | RuleWithNoDocumentCookieOptions
NoDocumentCookieOptions object
NoDocumentImportInPageConfiguration RulePlainConfiguration | RuleWithNoDocumentImportInPageOptions
NoDocumentImportInPageOptions object
NoDoneCallbackConfiguration RulePlainConfiguration | RuleWithNoDoneCallbackOptions
NoDoneCallbackOptions object
NoDoubleEqualsConfiguration RulePlainConfiguration | RuleWithNoDoubleEqualsOptions
NoDoubleEqualsOptions object
ignoreNull boolean | null

If true, an exception is made when comparing with null, as it's often relied on to check both for null or undefined.

If false, no such exception will be made.

NoDuplicateAtImportRulesConfiguration RulePlainConfiguration | RuleWithNoDuplicateAtImportRulesOptions
NoDuplicateAtImportRulesOptions object
NoDuplicateCaseConfiguration RulePlainConfiguration | RuleWithNoDuplicateCaseOptions
NoDuplicateCaseOptions object
NoDuplicateClassMembersConfiguration RulePlainConfiguration | RuleWithNoDuplicateClassMembersOptions
NoDuplicateClassMembersOptions object
NoDuplicateCustomPropertiesConfiguration RulePlainConfiguration | RuleWithNoDuplicateCustomPropertiesOptions
NoDuplicateCustomPropertiesOptions object
NoDuplicateDependenciesConfiguration RulePlainConfiguration | RuleWithNoDuplicateDependenciesOptions
NoDuplicateDependenciesOptions object
NoDuplicateElseIfConfiguration RulePlainConfiguration | RuleWithNoDuplicateElseIfOptions
NoDuplicateElseIfOptions object
NoDuplicateFieldsConfiguration RulePlainConfiguration | RuleWithNoDuplicateFieldsOptions
NoDuplicateFieldsOptions object
NoDuplicateFontNamesConfiguration RulePlainConfiguration | RuleWithNoDuplicateFontNamesOptions
NoDuplicateFontNamesOptions object
NoDuplicateJsxPropsConfiguration RulePlainConfiguration | RuleWithNoDuplicateJsxPropsOptions
NoDuplicateJsxPropsOptions object
NoDuplicateObjectKeysConfiguration RulePlainConfiguration | RuleWithNoDuplicateObjectKeysOptions
NoDuplicateObjectKeysOptions object
NoDuplicateParametersConfiguration RulePlainConfiguration | RuleWithNoDuplicateParametersOptions
NoDuplicateParametersOptions object
NoDuplicatePropertiesConfiguration RulePlainConfiguration | RuleWithNoDuplicatePropertiesOptions
NoDuplicatePropertiesOptions object
NoDuplicateSelectorsKeyframeBlockConfiguration RulePlainConfiguration | RuleWithNoDuplicateSelectorsKeyframeBlockOptions
NoDuplicateSelectorsKeyframeBlockOptions object
NoDuplicateTestHooksConfiguration RulePlainConfiguration | RuleWithNoDuplicateTestHooksOptions
NoDuplicateTestHooksOptions object
NoDuplicatedSpreadPropsConfiguration RulePlainConfiguration | RuleWithNoDuplicatedSpreadPropsOptions
NoDuplicatedSpreadPropsOptions object
NoDynamicNamespaceImportAccessConfiguration RulePlainConfiguration | RuleWithNoDynamicNamespaceImportAccessOptions
NoDynamicNamespaceImportAccessOptions object
NoEmptyBlockConfiguration RulePlainConfiguration | RuleWithNoEmptyBlockOptions
NoEmptyBlockOptions object
NoEmptyBlockStatementsConfiguration RulePlainConfiguration | RuleWithNoEmptyBlockStatementsOptions
NoEmptyBlockStatementsOptions object
NoEmptyCharacterClassInRegexConfiguration RulePlainConfiguration | RuleWithNoEmptyCharacterClassInRegexOptions
NoEmptyCharacterClassInRegexOptions object
NoEmptyInterfaceConfiguration RulePlainConfiguration | RuleWithNoEmptyInterfaceOptions
NoEmptyInterfaceOptions object
NoEmptyPatternConfiguration RulePlainConfiguration | RuleWithNoEmptyPatternOptions
NoEmptyPatternOptions object
NoEmptySourceConfiguration RulePlainConfiguration | RuleWithNoEmptySourceOptions
NoEmptySourceOptions object
allowComments boolean | null

Whether comments are considered meaningful

NoEmptyTypeParametersConfiguration RulePlainConfiguration | RuleWithNoEmptyTypeParametersOptions
NoEmptyTypeParametersOptions object
NoEnumConfiguration RulePlainConfiguration | RuleWithNoEnumOptions
NoEnumOptions object
NoEqualsToNullConfiguration RulePlainConfiguration | RuleWithNoEqualsToNullOptions
NoEqualsToNullOptions object
NoEvolvingTypesConfiguration RulePlainConfiguration | RuleWithNoEvolvingTypesOptions
NoEvolvingTypesOptions object
NoExcessiveCognitiveComplexityConfiguration RulePlainConfiguration | RuleWithNoExcessiveCognitiveComplexityOptions
NoExcessiveCognitiveComplexityOptions object
maxAllowedComplexity integer | null

The maximum complexity score that we allow. Anything higher is considered excessive.

format=uint8min=1max=255
NoExcessiveLinesPerFunctionConfiguration RulePlainConfiguration | RuleWithNoExcessiveLinesPerFunctionOptions
NoExcessiveLinesPerFunctionOptions object
maxLines integer | null

The maximum number of lines allowed in a function body.

format=uint16min=1max=65535
skipBlankLines boolean | null

When this options is set to true, blank lines in the function body are not counted towards the maximum line limit.

skipIifes boolean | null

When this option is set to true, Immediately Invoked Function Expressions (IIFEs) are not checked for the maximum line limit.

NoExcessiveNestedTestSuitesConfiguration RulePlainConfiguration | RuleWithNoExcessiveNestedTestSuitesOptions
NoExcessiveNestedTestSuitesOptions object
NoExplicitAnyConfiguration RulePlainConfiguration | RuleWithNoExplicitAnyOptions
NoExplicitAnyOptions object
NoExportedImportsConfiguration RulePlainConfiguration | RuleWithNoExportedImportsOptions
NoExportedImportsOptions object
NoExportsInTestConfiguration RulePlainConfiguration | RuleWithNoExportsInTestOptions
NoExportsInTestOptions object
NoExtraBooleanCastConfiguration RulePlainConfiguration | RuleWithNoExtraBooleanCastOptions
NoExtraBooleanCastOptions object
NoExtraNonNullAssertionConfiguration RulePlainConfiguration | RuleWithNoExtraNonNullAssertionOptions
NoExtraNonNullAssertionOptions object
NoFallthroughSwitchClauseConfiguration RulePlainConfiguration | RuleWithNoFallthroughSwitchClauseOptions
NoFallthroughSwitchClauseOptions object
NoFlatMapIdentityConfiguration RulePlainConfiguration | RuleWithNoFlatMapIdentityOptions
NoFlatMapIdentityOptions object
NoFloatingPromisesConfiguration RulePlainConfiguration | RuleWithNoFloatingPromisesOptions
NoFloatingPromisesOptions object
NoFocusedTestsConfiguration RulePlainConfiguration | RuleWithNoFocusedTestsOptions
NoFocusedTestsOptions object
NoForEachConfiguration RulePlainConfiguration | RuleWithNoForEachOptions
NoForEachOptions object
allowedIdentifiers array | null

A list of variable names allowed for forEach calls.

NoForInConfiguration RulePlainConfiguration | RuleWithNoForInOptions
NoForInOptions object
NoFunctionAssignConfiguration RulePlainConfiguration | RuleWithNoFunctionAssignOptions
NoFunctionAssignOptions object
NoGlobalAssignConfiguration RulePlainConfiguration | RuleWithNoGlobalAssignOptions
NoGlobalAssignOptions object
NoGlobalDirnameFilenameConfiguration RulePlainConfiguration | RuleWithNoGlobalDirnameFilenameOptions
NoGlobalDirnameFilenameOptions object
NoGlobalEvalConfiguration RulePlainConfiguration | RuleWithNoGlobalEvalOptions
NoGlobalEvalOptions object
NoGlobalIsFiniteConfiguration RulePlainConfiguration | RuleWithNoGlobalIsFiniteOptions
NoGlobalIsFiniteOptions object
NoGlobalIsNanConfiguration RulePlainConfiguration | RuleWithNoGlobalIsNanOptions
NoGlobalIsNanOptions object
NoGlobalObjectCallsConfiguration RulePlainConfiguration | RuleWithNoGlobalObjectCallsOptions
NoGlobalObjectCallsOptions object
NoHeadElementConfiguration RulePlainConfiguration | RuleWithNoHeadElementOptions
NoHeadElementOptions object
NoHeadImportInDocumentConfiguration RulePlainConfiguration | RuleWithNoHeadImportInDocumentOptions
NoHeadImportInDocumentOptions object
NoHeaderScopeConfiguration RulePlainConfiguration | RuleWithNoHeaderScopeOptions
NoHeaderScopeOptions object
NoImgElementConfiguration RulePlainConfiguration | RuleWithNoImgElementOptions
NoImgElementOptions object
NoImplicitAnyLetConfiguration RulePlainConfiguration | RuleWithNoImplicitAnyLetOptions
NoImplicitAnyLetOptions object
NoImplicitBooleanConfiguration RulePlainConfiguration | RuleWithNoImplicitBooleanOptions
NoImplicitBooleanOptions object
NoImplicitCoercionsConfiguration RulePlainConfiguration | RuleWithNoImplicitCoercionsOptions
NoImplicitCoercionsOptions object
NoImportAssignConfiguration RulePlainConfiguration | RuleWithNoImportAssignOptions
NoImportAssignOptions object
NoImportCyclesConfiguration RulePlainConfiguration | RuleWithNoImportCyclesOptions
NoImportCyclesOptions object
ignoreTypes boolean | null

Ignores type-only imports when finding an import cycle. A type-only import (import type) will be removed by the compiler, so it cuts an import cycle at runtime. Note that named type imports (import { type Foo }) aren't considered as type-only because it's not removed by the compiler if the verbatimModuleSyntax option is enabled. Enabled by default.

NoImportantInKeyframeConfiguration RulePlainConfiguration | RuleWithNoImportantInKeyframeOptions
NoImportantInKeyframeOptions object
NoImportantStylesConfiguration RulePlainConfiguration | RuleWithNoImportantStylesOptions
NoImportantStylesOptions object
NoIncrementDecrementConfiguration RulePlainConfiguration | RuleWithNoIncrementDecrementOptions
NoIncrementDecrementOptions object
allowForLoopAfterthoughts boolean | null

Allows unary operators ++ and -- in the afterthought (final expression) of a for loop.

NoInferrableTypesConfiguration RulePlainConfiguration | RuleWithNoInferrableTypesOptions
NoInferrableTypesOptions object
NoInnerDeclarationsConfiguration RulePlainConfiguration | RuleWithNoInnerDeclarationsOptions
NoInnerDeclarationsOptions object
NoInteractiveElementToNoninteractiveRoleConfiguration RulePlainConfiguration | RuleWithNoInteractiveElementToNoninteractiveRoleOptions
NoInteractiveElementToNoninteractiveRoleOptions object
NoInvalidBuiltinInstantiationConfiguration RulePlainConfiguration | RuleWithNoInvalidBuiltinInstantiationOptions
NoInvalidBuiltinInstantiationOptions object
NoInvalidConstructorSuperConfiguration RulePlainConfiguration | RuleWithNoInvalidConstructorSuperOptions
NoInvalidConstructorSuperOptions object
NoInvalidDirectionInLinearGradientConfiguration RulePlainConfiguration | RuleWithNoInvalidDirectionInLinearGradientOptions
NoInvalidDirectionInLinearGradientOptions object
NoInvalidGridAreasConfiguration RulePlainConfiguration | RuleWithNoInvalidGridAreasOptions
NoInvalidGridAreasOptions object
NoInvalidPositionAtImportRuleConfiguration RulePlainConfiguration | RuleWithNoInvalidPositionAtImportRuleOptions
NoInvalidPositionAtImportRuleOptions object
NoInvalidUseBeforeDeclarationConfiguration RulePlainConfiguration | RuleWithNoInvalidUseBeforeDeclarationOptions
NoInvalidUseBeforeDeclarationOptions object
NoIrregularWhitespaceConfiguration RulePlainConfiguration | RuleWithNoIrregularWhitespaceOptions
NoIrregularWhitespaceOptions object
NoJsxLiteralsConfiguration RulePlainConfiguration | RuleWithNoJsxLiteralsOptions
NoJsxLiteralsOptions object
allowedStrings array | null

An array of strings that won't trigger the rule. Whitespaces are taken into consideration

ignoreProps boolean | null

When enabled, strings inside props are always ignored

noStrings boolean | null

When enabled, also flag string literals inside JSX expressions and attributes

NoJsxPropsBindConfiguration RulePlainConfiguration | RuleWithNoJsxPropsBindOptions
NoJsxPropsBindOptions object
NoLabelVarConfiguration RulePlainConfiguration | RuleWithNoLabelVarOptions
NoLabelVarOptions object
NoLabelWithoutControlConfiguration RulePlainConfiguration | RuleWithNoLabelWithoutControlOptions
NoLabelWithoutControlOptions object
inputComponents array | null

Array of component names that should be considered the same as an input element.

labelAttributes array | null

Array of attributes that should be treated as the label accessible text content.

labelComponents array | null

Array of component names that should be considered the same as a label element.

NoLeakedRenderConfiguration RulePlainConfiguration | RuleWithNoLeakedRenderOptions
NoLeakedRenderOptions object
NoMagicNumbersConfiguration RulePlainConfiguration | RuleWithNoMagicNumbersOptions
NoMagicNumbersOptions object
NoMisleadingCharacterClassConfiguration RulePlainConfiguration | RuleWithNoMisleadingCharacterClassOptions
NoMisleadingCharacterClassOptions object
NoMisleadingInstantiatorConfiguration RulePlainConfiguration | RuleWithNoMisleadingInstantiatorOptions
NoMisleadingInstantiatorOptions object
NoMisplacedAssertionConfiguration RulePlainConfiguration | RuleWithNoMisplacedAssertionOptions
NoMisplacedAssertionOptions object
NoMisrefactoredShorthandAssignConfiguration RulePlainConfiguration | RuleWithNoMisrefactoredShorthandAssignOptions
NoMisrefactoredShorthandAssignOptions object
NoMissingVarFunctionConfiguration RulePlainConfiguration | RuleWithNoMissingVarFunctionOptions
NoMissingVarFunctionOptions object
NoMisusedPromisesConfiguration RulePlainConfiguration | RuleWithNoMisusedPromisesOptions
NoMisusedPromisesOptions object
NoMultiAssignConfiguration RulePlainConfiguration | RuleWithNoMultiAssignOptions
NoMultiAssignOptions object
NoMultiStrConfiguration RulePlainConfiguration | RuleWithNoMultiStrOptions
NoMultiStrOptions object
NoNamespaceConfiguration RulePlainConfiguration | RuleWithNoNamespaceOptions
NoNamespaceImportConfiguration RulePlainConfiguration | RuleWithNoNamespaceImportOptions
NoNamespaceImportOptions object
NoNamespaceOptions object
NoNegationElseConfiguration RulePlainConfiguration | RuleWithNoNegationElseOptions
NoNegationElseOptions object
NoNestedComponentDefinitionsConfiguration RulePlainConfiguration | RuleWithNoNestedComponentDefinitionsOptions
NoNestedComponentDefinitionsOptions object
NoNestedTernaryConfiguration RulePlainConfiguration | RuleWithNoNestedTernaryOptions
NoNestedTernaryOptions object
NoNextAsyncClientComponentConfiguration RulePlainConfiguration | RuleWithNoNextAsyncClientComponentOptions
NoNextAsyncClientComponentOptions object
NoNodejsModulesConfiguration RulePlainConfiguration | RuleWithNoNodejsModulesOptions
NoNodejsModulesOptions object
NoNonNullAssertedOptionalChainConfiguration RulePlainConfiguration | RuleWithNoNonNullAssertedOptionalChainOptions
NoNonNullAssertedOptionalChainOptions object
NoNonNullAssertionConfiguration RulePlainConfiguration | RuleWithNoNonNullAssertionOptions
NoNonNullAssertionOptions object
NoNoninteractiveElementInteractionsConfiguration RulePlainConfiguration | RuleWithNoNoninteractiveElementInteractionsOptions
NoNoninteractiveElementInteractionsOptions object
NoNoninteractiveElementToInteractiveRoleConfiguration RulePlainConfiguration | RuleWithNoNoninteractiveElementToInteractiveRoleOptions
NoNoninteractiveElementToInteractiveRoleOptions object
NoNoninteractiveTabindexConfiguration RulePlainConfiguration | RuleWithNoNoninteractiveTabindexOptions
NoNoninteractiveTabindexOptions object
NoNonoctalDecimalEscapeConfiguration RulePlainConfiguration | RuleWithNoNonoctalDecimalEscapeOptions
NoNonoctalDecimalEscapeOptions object
NoOctalEscapeConfiguration RulePlainConfiguration | RuleWithNoOctalEscapeOptions
NoOctalEscapeOptions object
NoParameterAssignConfiguration RulePlainConfiguration | RuleWithNoParameterAssignOptions
NoParameterAssignOptions object
propertyAssignment PropertyAssignmentMode | null

Whether to report an error when a dependency is listed in the dependencies array but isn't used. Defaults to allow.

NoParameterPropertiesConfiguration RulePlainConfiguration | RuleWithNoParameterPropertiesOptions
NoParameterPropertiesOptions object
NoParametersOnlyUsedInRecursionConfiguration RulePlainConfiguration | RuleWithNoParametersOnlyUsedInRecursionOptions
NoParametersOnlyUsedInRecursionOptions object
NoPositiveTabindexConfiguration RulePlainConfiguration | RuleWithNoPositiveTabindexOptions
NoPositiveTabindexOptions object
NoPrecisionLossConfiguration RulePlainConfiguration | RuleWithNoPrecisionLossOptions
NoPrecisionLossOptions object
NoPrivateImportsConfiguration RulePlainConfiguration | RuleWithNoPrivateImportsOptions
NoPrivateImportsOptions object
defaultVisibility Visibility | null

The default visibility to assume for symbols without visibility tag.

Default: public.

NoProcessEnvConfiguration RulePlainConfiguration | RuleWithNoProcessEnvOptions
NoProcessEnvOptions object
NoProcessGlobalConfiguration RulePlainConfiguration | RuleWithNoProcessGlobalOptions
NoProcessGlobalOptions object
NoProtoConfiguration RulePlainConfiguration | RuleWithNoProtoOptions
NoProtoOptions object
NoPrototypeBuiltinsConfiguration RulePlainConfiguration | RuleWithNoPrototypeBuiltinsOptions
NoPrototypeBuiltinsOptions object
NoQuickfixBiomeConfiguration RulePlainConfiguration | RuleWithNoQuickfixBiomeOptions
NoQuickfixBiomeOptions object
additionalPaths string[]

A list of additional JSON files that should be checked.

Default:
[]
NoQwikUseVisibleTaskConfiguration RulePlainConfiguration | RuleWithNoQwikUseVisibleTaskOptions
NoQwikUseVisibleTaskOptions object
NoReExportAllConfiguration RulePlainConfiguration | RuleWithNoReExportAllOptions
NoReExportAllOptions object
NoReactForwardRefConfiguration RulePlainConfiguration | RuleWithNoReactForwardRefOptions
NoReactForwardRefOptions object
NoReactPropAssignmentsConfiguration RulePlainConfiguration | RuleWithNoReactPropAssignmentsOptions
NoReactPropAssignmentsOptions object
NoReactSpecificPropsConfiguration RulePlainConfiguration | RuleWithNoReactSpecificPropsOptions
NoReactSpecificPropsOptions object
NoRedeclareConfiguration RulePlainConfiguration | RuleWithNoRedeclareOptions
NoRedeclareOptions object
NoRedundantAltConfiguration RulePlainConfiguration | RuleWithNoRedundantAltOptions
NoRedundantAltOptions object
NoRedundantRolesConfiguration RulePlainConfiguration | RuleWithNoRedundantRolesOptions
NoRedundantRolesOptions object
NoRedundantUseStrictConfiguration RulePlainConfiguration | RuleWithNoRedundantUseStrictOptions
NoRedundantUseStrictOptions object
NoRenderReturnValueConfiguration RulePlainConfiguration | RuleWithNoRenderReturnValueOptions
NoRenderReturnValueOptions object
NoRestrictedElementsConfiguration RulePlainConfiguration | RuleWithNoRestrictedElementsOptions
NoRestrictedElementsOptions object
elements CustomRestrictedElements | null

Elements to restrict. Each key is the element name, and the value is the message to show when the element is used.

NoRestrictedGlobalsConfiguration RulePlainConfiguration | RuleWithNoRestrictedGlobalsOptions
NoRestrictedGlobalsOptions object
deniedGlobals Record<string, string>

A list of names that should trigger the rule

NoRestrictedImportsConfiguration RulePlainConfiguration | RuleWithNoRestrictedImportsOptions
NoRestrictedImportsOptions object
paths Record<string, string | PathOptions>

A list of import paths that should trigger the rule.

patterns array | null

gitignore-style patterns that should trigger the rule.

NoRestrictedTypesConfiguration RulePlainConfiguration | RuleWithNoRestrictedTypesOptions
NoRestrictedTypesOptions object
types Record<string, string | CustomRestrictedTypeOptions>
NoReturnAssignConfiguration RulePlainConfiguration | RuleWithNoReturnAssignOptions
NoReturnAssignOptions object
NoScriptUrlConfiguration RulePlainConfiguration | RuleWithNoScriptUrlOptions
NoScriptUrlOptions object
NoSecretsConfiguration RulePlainConfiguration | RuleWithNoSecretsOptions
NoSecretsOptions object
entropyThreshold integer | null

Set entropy threshold (default is 41).

format=uint16min=0max=65535
NoSelfAssignConfiguration RulePlainConfiguration | RuleWithNoSelfAssignOptions
NoSelfAssignOptions object
NoSelfCompareConfiguration RulePlainConfiguration | RuleWithNoSelfCompareOptions
NoSelfCompareOptions object
NoSetterReturnConfiguration RulePlainConfiguration | RuleWithNoSetterReturnOptions
NoSetterReturnOptions object
NoShadowConfiguration RulePlainConfiguration | RuleWithNoShadowOptions
NoShadowOptions object
NoShadowRestrictedNamesConfiguration RulePlainConfiguration | RuleWithNoShadowRestrictedNamesOptions
NoShadowRestrictedNamesOptions object
NoShorthandPropertyOverridesConfiguration RulePlainConfiguration | RuleWithNoShorthandPropertyOverridesOptions
NoShorthandPropertyOverridesOptions object
NoShoutyConstantsConfiguration RulePlainConfiguration | RuleWithNoShoutyConstantsOptions
NoShoutyConstantsOptions object
NoSkippedTestsConfiguration RulePlainConfiguration | RuleWithNoSkippedTestsOptions
NoSkippedTestsOptions object
NoSolidDestructuredPropsConfiguration RulePlainConfiguration | RuleWithNoSolidDestructuredPropsOptions
NoSolidDestructuredPropsOptions object
NoSparseArrayConfiguration RulePlainConfiguration | RuleWithNoSparseArrayOptions
NoSparseArrayOptions object
NoStaticElementInteractionsConfiguration RulePlainConfiguration | RuleWithNoStaticElementInteractionsOptions
NoStaticElementInteractionsOptions object
NoStaticOnlyClassConfiguration RulePlainConfiguration | RuleWithNoStaticOnlyClassOptions
NoStaticOnlyClassOptions object
NoStringCaseMismatchConfiguration RulePlainConfiguration | RuleWithNoStringCaseMismatchOptions
NoStringCaseMismatchOptions object
NoSubstrConfiguration RulePlainConfiguration | RuleWithNoSubstrOptions
NoSubstrOptions object
NoSuspiciousSemicolonInJsxConfiguration RulePlainConfiguration | RuleWithNoSuspiciousSemicolonInJsxOptions
NoSuspiciousSemicolonInJsxOptions object
NoSvgWithoutTitleConfiguration RulePlainConfiguration | RuleWithNoSvgWithoutTitleOptions
NoSvgWithoutTitleOptions object
NoSwitchDeclarationsConfiguration RulePlainConfiguration | RuleWithNoSwitchDeclarationsOptions
NoSwitchDeclarationsOptions object
NoSyncScriptsConfiguration RulePlainConfiguration | RuleWithNoSyncScriptsOptions
NoSyncScriptsOptions object
NoTemplateCurlyInStringConfiguration RulePlainConfiguration | RuleWithNoTemplateCurlyInStringOptions
NoTemplateCurlyInStringOptions object
NoTernaryConfiguration RulePlainConfiguration | RuleWithNoTernaryOptions
NoTernaryOptions object
NoThenPropertyConfiguration RulePlainConfiguration | RuleWithNoThenPropertyOptions
NoThenPropertyOptions object
NoThisInStaticConfiguration RulePlainConfiguration | RuleWithNoThisInStaticOptions
NoThisInStaticOptions object
NoTsIgnoreConfiguration RulePlainConfiguration | RuleWithNoTsIgnoreOptions
NoTsIgnoreOptions object
NoUnassignedVariablesConfiguration RulePlainConfiguration | RuleWithNoUnassignedVariablesOptions
NoUnassignedVariablesOptions object
NoUndeclaredDependenciesConfiguration RulePlainConfiguration | RuleWithNoUndeclaredDependenciesOptions
NoUndeclaredDependenciesOptions object
devDependencies DependencyAvailability | null

If set to false, then the rule will show an error when devDependencies are imported. Defaults to true.

optionalDependencies DependencyAvailability | null

If set to false, then the rule will show an error when optionalDependencies are imported. Defaults to true.

peerDependencies DependencyAvailability | null

If set to false, then the rule will show an error when peerDependencies are imported. Defaults to true.

NoUndeclaredEnvVarsConfiguration RulePlainConfiguration | RuleWithNoUndeclaredEnvVarsOptions
NoUndeclaredEnvVarsOptions object
allowedEnvVars array | null

Environment variables that should always be allowed. Use this to specify environment variables that are always available in your environment, even when not declared in turbo.json. Supports regular expressions, e.g. ["MY_ENV_.*"].

NoUndeclaredVariablesConfiguration RulePlainConfiguration | RuleWithNoUndeclaredVariablesOptions
NoUndeclaredVariablesOptions object
checkTypes boolean | null

Check undeclared types.

NoUnknownAtRulesConfiguration RulePlainConfiguration | RuleWithNoUnknownAtRulesOptions
NoUnknownAtRulesOptions object
ignore string[]

A list of unknown at-rule names to ignore (case-insensitive).

NoUnknownAttributeConfiguration RulePlainConfiguration | RuleWithNoUnknownAttributeOptions
NoUnknownAttributeOptions object
ignore array | null
NoUnknownFunctionConfiguration RulePlainConfiguration | RuleWithNoUnknownFunctionOptions
NoUnknownFunctionOptions object
NoUnknownMediaFeatureNameConfiguration RulePlainConfiguration | RuleWithNoUnknownMediaFeatureNameOptions
NoUnknownMediaFeatureNameOptions object
NoUnknownPropertyConfiguration RulePlainConfiguration | RuleWithNoUnknownPropertyOptions
NoUnknownPropertyOptions object
NoUnknownPseudoClassConfiguration RulePlainConfiguration | RuleWithNoUnknownPseudoClassOptions
NoUnknownPseudoClassOptions object
NoUnknownPseudoElementConfiguration RulePlainConfiguration | RuleWithNoUnknownPseudoElementOptions
NoUnknownPseudoElementOptions object
NoUnknownTypeSelectorConfiguration RulePlainConfiguration | RuleWithNoUnknownTypeSelectorOptions
NoUnknownTypeSelectorOptions object
NoUnknownUnitConfiguration RulePlainConfiguration | RuleWithNoUnknownUnitOptions
NoUnknownUnitOptions object
NoUnmatchableAnbSelectorConfiguration RulePlainConfiguration | RuleWithNoUnmatchableAnbSelectorOptions
NoUnmatchableAnbSelectorOptions object
NoUnnecessaryConditionsConfiguration RulePlainConfiguration | RuleWithNoUnnecessaryConditionsOptions
NoUnnecessaryConditionsOptions object
NoUnreachableConfiguration RulePlainConfiguration | RuleWithNoUnreachableOptions
NoUnreachableOptions object
NoUnreachableSuperConfiguration RulePlainConfiguration | RuleWithNoUnreachableSuperOptions
NoUnreachableSuperOptions object
NoUnresolvedImportsConfiguration RulePlainConfiguration | RuleWithNoUnresolvedImportsOptions
NoUnresolvedImportsOptions object
NoUnsafeDeclarationMergingConfiguration RulePlainConfiguration | RuleWithNoUnsafeDeclarationMergingOptions
NoUnsafeDeclarationMergingOptions object
NoUnsafeFinallyConfiguration RulePlainConfiguration | RuleWithNoUnsafeFinallyOptions
NoUnsafeFinallyOptions object
NoUnsafeNegationConfiguration RulePlainConfiguration | RuleWithNoUnsafeNegationOptions
NoUnsafeNegationOptions object
NoUnsafeOptionalChainingConfiguration RulePlainConfiguration | RuleWithNoUnsafeOptionalChainingOptions
NoUnsafeOptionalChainingOptions object
NoUnusedExpressionsConfiguration RulePlainConfiguration | RuleWithNoUnusedExpressionsOptions
NoUnusedExpressionsOptions object
NoUnusedFunctionParametersConfiguration RulePlainConfiguration | RuleWithNoUnusedFunctionParametersOptions
NoUnusedFunctionParametersOptions object
ignoreRestSiblings boolean | null

Whether to ignore unused variables from an object destructuring with a spread.

NoUnusedImportsConfiguration RulePlainConfiguration | RuleWithNoUnusedImportsOptions
NoUnusedImportsOptions object
NoUnusedLabelsConfiguration RulePlainConfiguration | RuleWithNoUnusedLabelsOptions
NoUnusedLabelsOptions object
NoUnusedPrivateClassMembersConfiguration RulePlainConfiguration | RuleWithNoUnusedPrivateClassMembersOptions
NoUnusedPrivateClassMembersOptions object
NoUnusedTemplateLiteralConfiguration RulePlainConfiguration | RuleWithNoUnusedTemplateLiteralOptions
NoUnusedTemplateLiteralOptions object
NoUnusedVariablesConfiguration RulePlainConfiguration | RuleWithNoUnusedVariablesOptions
NoUnusedVariablesOptions object
ignoreRestSiblings boolean | null

Whether to ignore unused variables from an object destructuring with a spread.

NoUnwantedPolyfillioConfiguration RulePlainConfiguration | RuleWithNoUnwantedPolyfillioOptions
NoUnwantedPolyfillioOptions object
NoUselessCatchBindingConfiguration RulePlainConfiguration | RuleWithNoUselessCatchBindingOptions
NoUselessCatchBindingOptions object

Options for the noUselessCatchBinding rule. Currently empty; reserved for future extensions (e.g. allowlist of names).

NoUselessCatchConfiguration RulePlainConfiguration | RuleWithNoUselessCatchOptions
NoUselessCatchOptions object
NoUselessConstructorConfiguration RulePlainConfiguration | RuleWithNoUselessConstructorOptions
NoUselessConstructorOptions object
NoUselessContinueConfiguration RulePlainConfiguration | RuleWithNoUselessContinueOptions
NoUselessContinueOptions object
NoUselessElseConfiguration RulePlainConfiguration | RuleWithNoUselessElseOptions
NoUselessElseOptions object
NoUselessEmptyExportConfiguration RulePlainConfiguration | RuleWithNoUselessEmptyExportOptions
NoUselessEmptyExportOptions object
NoUselessEscapeInRegexConfiguration RulePlainConfiguration | RuleWithNoUselessEscapeInRegexOptions
NoUselessEscapeInRegexOptions object
NoUselessEscapeInStringConfiguration RulePlainConfiguration | RuleWithNoUselessEscapeInStringOptions
NoUselessEscapeInStringOptions object
NoUselessFragmentsConfiguration RulePlainConfiguration | RuleWithNoUselessFragmentsOptions
NoUselessFragmentsOptions object
NoUselessLabelConfiguration RulePlainConfiguration | RuleWithNoUselessLabelOptions
NoUselessLabelOptions object
NoUselessLoneBlockStatementsConfiguration RulePlainConfiguration | RuleWithNoUselessLoneBlockStatementsOptions
NoUselessLoneBlockStatementsOptions object
NoUselessRegexBackrefsConfiguration RulePlainConfiguration | RuleWithNoUselessRegexBackrefsOptions
NoUselessRegexBackrefsOptions object
NoUselessRenameConfiguration RulePlainConfiguration | RuleWithNoUselessRenameOptions
NoUselessRenameOptions object
NoUselessStringConcatConfiguration RulePlainConfiguration | RuleWithNoUselessStringConcatOptions
NoUselessStringConcatOptions object
NoUselessStringRawConfiguration RulePlainConfiguration | RuleWithNoUselessStringRawOptions
NoUselessStringRawOptions object
NoUselessSwitchCaseConfiguration RulePlainConfiguration | RuleWithNoUselessSwitchCaseOptions
NoUselessSwitchCaseOptions object
NoUselessTernaryConfiguration RulePlainConfiguration | RuleWithNoUselessTernaryOptions
NoUselessTernaryOptions object
NoUselessThisAliasConfiguration RulePlainConfiguration | RuleWithNoUselessThisAliasOptions
NoUselessThisAliasOptions object
NoUselessTypeConstraintConfiguration RulePlainConfiguration | RuleWithNoUselessTypeConstraintOptions
NoUselessTypeConstraintOptions object
NoUselessUndefinedConfiguration RulePlainConfiguration | RuleWithNoUselessUndefinedOptions
NoUselessUndefinedInitializationConfiguration RulePlainConfiguration | RuleWithNoUselessUndefinedInitializationOptions
NoUselessUndefinedInitializationOptions object
NoUselessUndefinedOptions object
NoValueAtRuleConfiguration RulePlainConfiguration | RuleWithNoValueAtRuleOptions
NoValueAtRuleOptions object
NoVarConfiguration RulePlainConfiguration | RuleWithNoVarOptions
NoVarOptions object
NoVoidConfiguration RulePlainConfiguration | RuleWithNoVoidOptions
NoVoidElementsWithChildrenConfiguration RulePlainConfiguration | RuleWithNoVoidElementsWithChildrenOptions
NoVoidElementsWithChildrenOptions object
NoVoidOptions object
NoVoidTypeReturnConfiguration RulePlainConfiguration | RuleWithNoVoidTypeReturnOptions
NoVoidTypeReturnOptions object
NoVueDataObjectDeclarationConfiguration RulePlainConfiguration | RuleWithNoVueDataObjectDeclarationOptions
NoVueDataObjectDeclarationOptions object
NoVueDuplicateKeysConfiguration RulePlainConfiguration | RuleWithNoVueDuplicateKeysOptions
NoVueDuplicateKeysOptions object
NoVueReservedKeysConfiguration RulePlainConfiguration | RuleWithNoVueReservedKeysOptions
NoVueReservedKeysOptions object
NoVueReservedPropsConfiguration RulePlainConfiguration | RuleWithNoVueReservedPropsOptions
NoVueReservedPropsOptions object
NoVueSetupPropsReactivityLossConfiguration RulePlainConfiguration | RuleWithNoVueSetupPropsReactivityLossOptions
NoVueSetupPropsReactivityLossOptions object
NoVueVIfWithVForConfiguration RulePlainConfiguration | RuleWithNoVueVIfWithVForOptions
NoVueVIfWithVForOptions object
NoWithConfiguration RulePlainConfiguration | RuleWithNoWithOptions
NoWithOptions object
NoYodaExpressionConfiguration RulePlainConfiguration | RuleWithNoYodaExpressionOptions
NoYodaExpressionOptions object
NormalizedGlob string

Normalized Biome glob pattern that strips ./ from the pattern.

Nursery object

A list of rules that belong to this group

noAmbiguousAnchorText NoAmbiguousAnchorTextConfiguration | null

Disallow ambiguous anchor descriptions. See https://biomejs.dev/linter/rules/no-ambiguous-anchor-text

noBeforeInteractiveScriptOutsideDocument NoBeforeInteractiveScriptOutsideDocumentConfiguration | null

Prevent usage of next/script's beforeInteractive strategy outside of pages/_document.js in a Next.js project. See https://biomejs.dev/linter/rules/no-before-interactive-script-outside-document

noContinue NoContinueConfiguration | null

Disallow continue statements. See https://biomejs.dev/linter/rules/no-continue

noDeprecatedImports NoDeprecatedImportsConfiguration | null

Restrict imports of deprecated exports. See https://biomejs.dev/linter/rules/no-deprecated-imports

noDuplicateDependencies NoDuplicateDependenciesConfiguration | null

Prevent the listing of duplicate dependencies. The rule supports the following dependency groups: "bundledDependencies", "bundleDependencies", "dependencies", "devDependencies", "overrides", "optionalDependencies", and "peerDependencies". See https://biomejs.dev/linter/rules/no-duplicate-dependencies

noDuplicatedSpreadProps NoDuplicatedSpreadPropsConfiguration | null

Disallow JSX prop spreading the same identifier multiple times. See https://biomejs.dev/linter/rules/no-duplicated-spread-props

noEmptySource NoEmptySourceConfiguration | null
noEqualsToNull NoEqualsToNullConfiguration | null

Require the use of === or !== for comparison with null. See https://biomejs.dev/linter/rules/no-equals-to-null

noFloatingPromises NoFloatingPromisesConfiguration | null

Require Promise-like statements to be handled appropriately. See https://biomejs.dev/linter/rules/no-floating-promises

noForIn NoForInConfiguration | null

Disallow iterating using a for-in loop. See https://biomejs.dev/linter/rules/no-for-in

noImportCycles NoImportCyclesConfiguration | null
noIncrementDecrement NoIncrementDecrementConfiguration | null

Disallows the usage of the unary operators ++ and --. See https://biomejs.dev/linter/rules/no-increment-decrement

noJsxLiterals NoJsxLiteralsConfiguration | null

Disallow string literals inside JSX elements. See https://biomejs.dev/linter/rules/no-jsx-literals

noJsxPropsBind NoJsxPropsBindConfiguration | null

Disallow .bind(), arrow functions, or function expressions in JSX props. See https://biomejs.dev/linter/rules/no-jsx-props-bind

noLeakedRender NoLeakedRenderConfiguration | null

Prevent problematic leaked values from being rendered. See https://biomejs.dev/linter/rules/no-leaked-render

noMisusedPromises NoMisusedPromisesConfiguration | null

Disallow Promises to be used in places where they are almost certainly a mistake. See https://biomejs.dev/linter/rules/no-misused-promises

noMultiAssign NoMultiAssignConfiguration | null

Disallow use of chained assignment expressions. See https://biomejs.dev/linter/rules/no-multi-assign

noMultiStr NoMultiStrConfiguration | null

Disallow creating multiline strings by escaping newlines. See https://biomejs.dev/linter/rules/no-multi-str

noNextAsyncClientComponent NoNextAsyncClientComponentConfiguration | null

Prevent client components from being async functions. See https://biomejs.dev/linter/rules/no-next-async-client-component

noParametersOnlyUsedInRecursion NoParametersOnlyUsedInRecursionConfiguration | null

Disallow function parameters that are only used in recursive calls. See https://biomejs.dev/linter/rules/no-parameters-only-used-in-recursion

noProto NoProtoConfiguration | null

Disallow the use of the deprecated proto object property. See https://biomejs.dev/linter/rules/no-proto

noReactForwardRef NoReactForwardRefConfiguration | null

Replaces usages of forwardRef with passing ref as a prop. See https://biomejs.dev/linter/rules/no-react-forward-ref

noReturnAssign NoReturnAssignConfiguration | null

Disallow assignments in return statements. See https://biomejs.dev/linter/rules/no-return-assign

noScriptUrl NoScriptUrlConfiguration | null

Disallow javascript: URLs in HTML. See https://biomejs.dev/linter/rules/no-script-url

noShadow NoShadowConfiguration | null

Disallow variable declarations from shadowing variables declared in the outer scope. See https://biomejs.dev/linter/rules/no-shadow

noSyncScripts NoSyncScriptsConfiguration | null

Prevent the usage of synchronous scripts. See https://biomejs.dev/linter/rules/no-sync-scripts

noTernary NoTernaryConfiguration | null

Disallow ternary operators. See https://biomejs.dev/linter/rules/no-ternary

noUndeclaredEnvVars NoUndeclaredEnvVarsConfiguration | null

Disallow the use of undeclared environment variables. See https://biomejs.dev/linter/rules/no-undeclared-env-vars

noUnknownAttribute NoUnknownAttributeConfiguration | null

Disallow unknown DOM properties. See https://biomejs.dev/linter/rules/no-unknown-attribute

noUnnecessaryConditions NoUnnecessaryConditionsConfiguration | null

Disallow unnecessary type-based conditions that can be statically determined as redundant. See https://biomejs.dev/linter/rules/no-unnecessary-conditions

noUnresolvedImports NoUnresolvedImportsConfiguration | null

Warn when importing non-existing exports. See https://biomejs.dev/linter/rules/no-unresolved-imports

noUnusedExpressions NoUnusedExpressionsConfiguration | null

Disallow expression statements that are neither a function call nor an assignment. See https://biomejs.dev/linter/rules/no-unused-expressions

noUselessCatchBinding NoUselessCatchBindingConfiguration | null
noUselessUndefined NoUselessUndefinedConfiguration | null

Disallow the use of useless undefined. See https://biomejs.dev/linter/rules/no-useless-undefined

noVueDataObjectDeclaration NoVueDataObjectDeclarationConfiguration | null

Enforce that Vue component data options are declared as functions. See https://biomejs.dev/linter/rules/no-vue-data-object-declaration

noVueDuplicateKeys NoVueDuplicateKeysConfiguration | null

Disallow duplicate keys in Vue component data, methods, computed properties, and other options. See https://biomejs.dev/linter/rules/no-vue-duplicate-keys

noVueReservedKeys NoVueReservedKeysConfiguration | null

Disallow reserved keys in Vue component data and computed properties. See https://biomejs.dev/linter/rules/no-vue-reserved-keys

noVueReservedProps NoVueReservedPropsConfiguration | null

Disallow reserved names to be used as props. See https://biomejs.dev/linter/rules/no-vue-reserved-props

noVueSetupPropsReactivityLoss NoVueSetupPropsReactivityLossConfiguration | null

Disallow destructuring of props passed to setup in Vue projects. See https://biomejs.dev/linter/rules/no-vue-setup-props-reactivity-loss

noVueVIfWithVFor NoVueVIfWithVForConfiguration | null

Disallow using v-if and v-for directives on the same element. See https://biomejs.dev/linter/rules/no-vue-v-if-with-v-for

recommended boolean | null

Enables the recommended rules for this group

useArraySortCompare UseArraySortCompareConfiguration | null

Require Array#sort and Array#toSorted calls to always provide a compareFunction. See https://biomejs.dev/linter/rules/use-array-sort-compare

useAwaitThenable UseAwaitThenableConfiguration | null

Enforce that await is only used on Promise values. See https://biomejs.dev/linter/rules/use-await-thenable

useConsistentArrowReturn UseConsistentArrowReturnConfiguration | null

Enforce consistent arrow function bodies. See https://biomejs.dev/linter/rules/use-consistent-arrow-return

useConsistentGraphqlDescriptions UseConsistentGraphqlDescriptionsConfiguration | null

Require all descriptions to follow the same style (either block or inline) to maintain consistency and improve readability across the schema. See https://biomejs.dev/linter/rules/use-consistent-graphql-descriptions

useDeprecatedDate UseDeprecatedDateConfiguration | null

Require the @deprecated directive to specify a deletion date. See https://biomejs.dev/linter/rules/use-deprecated-date

useDestructuring UseDestructuringConfiguration | null

Require destructuring from arrays and/or objects. See https://biomejs.dev/linter/rules/use-destructuring

useExhaustiveSwitchCases UseExhaustiveSwitchCasesConfiguration | null

Require switch-case statements to be exhaustive. See https://biomejs.dev/linter/rules/use-exhaustive-switch-cases

useExplicitType UseExplicitTypeConfiguration | null

Enforce types in functions, methods, variables, and parameters. See https://biomejs.dev/linter/rules/use-explicit-type

useFind UseFindConfiguration | null

Enforce the use of Array.prototype.find() over Array.prototype.filter() followed by [0] when looking for a single result. See https://biomejs.dev/linter/rules/use-find

useMaxParams UseMaxParamsConfiguration | null

Enforce a maximum number of parameters in function definitions. See https://biomejs.dev/linter/rules/use-max-params

useQwikMethodUsage UseQwikMethodUsageConfiguration | null

Disallow use* hooks outside of component$ or other use* hooks in Qwik applications. See https://biomejs.dev/linter/rules/use-qwik-method-usage

useQwikValidLexicalScope UseQwikValidLexicalScopeConfiguration | null

Disallow unserializable expressions in Qwik dollar ($) scopes. See https://biomejs.dev/linter/rules/use-qwik-valid-lexical-scope

useRegexpExec UseRegexpExecConfiguration | null

Enforce RegExp#exec over String#match if no global flag is provided. See https://biomejs.dev/linter/rules/use-regexp-exec

useRequiredScripts UseRequiredScriptsConfiguration | null

Enforce the presence of required scripts in package.json. See https://biomejs.dev/linter/rules/use-required-scripts

useSortedClasses UseSortedClassesConfiguration | null

Enforce the sorting of CSS utility classes. See https://biomejs.dev/linter/rules/use-sorted-classes

useSpread UseSpreadConfiguration | null

Enforce the use of the spread operator over .apply(). See https://biomejs.dev/linter/rules/use-spread

useUniqueArgumentNames UseUniqueArgumentNamesConfiguration | null

Require all argument names for fields & directives to be unique. See https://biomejs.dev/linter/rules/use-unique-argument-names

useUniqueFieldDefinitionNames UseUniqueFieldDefinitionNamesConfiguration | null

Require all fields of a type to be unique. See https://biomejs.dev/linter/rules/use-unique-field-definition-names

useUniqueGraphqlOperationName UseUniqueGraphqlOperationNameConfiguration | null

Enforce unique operation names across a GraphQL document. See https://biomejs.dev/linter/rules/use-unique-graphql-operation-name

useUniqueInputFieldNames UseUniqueInputFieldNamesConfiguration | null

Require fields within an input object to be unique. See https://biomejs.dev/linter/rules/use-unique-input-field-names

useUniqueVariableNames UseUniqueVariableNamesConfiguration | null

Require all variable definitions to be unique. See https://biomejs.dev/linter/rules/use-unique-variable-names

useVueConsistentDefinePropsDeclaration UseVueConsistentDefinePropsDeclarationConfiguration | null

Enforce consistent defineProps declaration style. See https://biomejs.dev/linter/rules/use-vue-consistent-define-props-declaration

useVueConsistentVBindStyle UseVueConsistentVBindStyleConfiguration | null

Enforce a consistent style for v-bind in Vue templates. See https://biomejs.dev/linter/rules/use-vue-consistent-v-bind-style

useVueConsistentVOnStyle UseVueConsistentVOnStyleConfiguration | null

Enforce a consistent style for v-on in Vue templates. See https://biomejs.dev/linter/rules/use-vue-consistent-v-on-style

useVueDefineMacrosOrder UseVueDefineMacrosOrderConfiguration | null

Enforce specific order of Vue compiler macros. See https://biomejs.dev/linter/rules/use-vue-define-macros-order

useVueHyphenatedAttributes UseVueHyphenatedAttributesConfiguration | null

Enforce hyphenated (kebab-case) attribute names in Vue templates. See https://biomejs.dev/linter/rules/use-vue-hyphenated-attributes

useVueMultiWordComponentNames UseVueMultiWordComponentNamesConfiguration | null

Enforce multi-word component names in Vue components. See https://biomejs.dev/linter/rules/use-vue-multi-word-component-names

useVueVForKey UseVueVForKeyConfiguration | null

Enforce that elements using v-for also specify a unique key. See https://biomejs.dev/linter/rules/use-vue-v-for-key

useVueValidTemplateRoot UseVueValidTemplateRootConfiguration | null

Enforce valid Vue <template> root usage. See https://biomejs.dev/linter/rules/use-vue-valid-template-root

useVueValidVBind UseVueValidVBindConfiguration | null

Forbids v-bind directives with missing arguments or invalid modifiers. See https://biomejs.dev/linter/rules/use-vue-valid-v-bind

useVueValidVCloak UseVueValidVCloakConfiguration | null

Enforce valid v-cloak Vue directives. See https://biomejs.dev/linter/rules/use-vue-valid-v-cloak

useVueValidVElse UseVueValidVElseConfiguration | null

Enforce valid usage of v-else. See https://biomejs.dev/linter/rules/use-vue-valid-v-else

useVueValidVElseIf UseVueValidVElseIfConfiguration | null

Enforce valid v-else-if directives. See https://biomejs.dev/linter/rules/use-vue-valid-v-else-if

useVueValidVHtml UseVueValidVHtmlConfiguration | null

Enforce valid v-html directives. See https://biomejs.dev/linter/rules/use-vue-valid-v-html

useVueValidVIf UseVueValidVIfConfiguration | null

Enforces valid v-if usage for Vue templates. See https://biomejs.dev/linter/rules/use-vue-valid-v-if

useVueValidVOn UseVueValidVOnConfiguration | null

Enforce valid v-on directives with proper arguments, modifiers, and handlers. See https://biomejs.dev/linter/rules/use-vue-valid-v-on

useVueValidVOnce UseVueValidVOnceConfiguration | null

Enforce valid v-once Vue directives. See https://biomejs.dev/linter/rules/use-vue-valid-v-once

useVueValidVPre UseVueValidVPreConfiguration | null

Enforce valid v-pre Vue directives. See https://biomejs.dev/linter/rules/use-vue-valid-v-pre

useVueValidVText UseVueValidVTextConfiguration | null

Enforce valid v-text Vue directives. See https://biomejs.dev/linter/rules/use-vue-valid-v-text

useVueVapor UseVueVaporConfiguration | null

Enforce opting in to Vue Vapor mode in <script setup> blocks. See https://biomejs.dev/linter/rules/use-vue-vapor

ObjectPropertySyntax string | string
OperatorLinebreak string | string
OrganizeImportsConfiguration RuleAssistPlainConfiguration | RuleAssistWithOrganizeImportsOptions
OrganizeImportsOptions object
groups ImportGroups | null
identifierOrder SortOrder | null
OverrideAssistConfiguration object
actions Actions | null

List of actions

enabled Bool | null

if false, it disables the feature and the assist won't be executed. true by default

OverrideFilesConfiguration object
maxSize MaxSize | null

File size limit in bytes

OverrideFormatterConfiguration object
attributePosition AttributePosition | null

The attribute position style.

bracketSameLine BracketSameLine | null

Put the > of a multi-line HTML or JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).

bracketSpacing BracketSpacing | null

Whether to insert spaces around brackets in object literals. Defaults to true.

enabled Bool | null
expand Expand | null

Whether to expand arrays and objects on multiple lines. When set to auto, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to always, these literals are formatted on multiple lines, regardless of length of the list. When set to never, these literals are formatted on a single line if it fits in the line. When formatting package.json, Biome will use always unless configured otherwise. Defaults to "auto".

formatWithErrors Bool | null

Stores whether formatting should be allowed to proceed if a given file has syntax errors

indentSize IndentWidth | null

The size of the indentation, 2 by default (deprecated, use indent-width)

indentStyle IndentStyle | null

The indent style.

indentWidth IndentWidth | null

The size of the indentation, 2 by default

lineEnding LineEnding | null

The type of line ending.

lineWidth LineWidth | null

What's the max width of a line. Defaults to 80.

OverrideGlobs Glob[]
OverrideLinterConfiguration object
domains RuleDomains | null

List of rules

enabled Bool | null

if false, it disables the feature and the linter won't be executed. true by default

rules Rules | null

List of rules

OverridePattern object

Specific configuration for the Json language

css CssConfiguration | null

Specific configuration for the CSS language

Specific configuration for the filesystem

Specific configuration for the Json language

graphql GraphqlConfiguration | null

Specific configuration for the Graphql language

grit GritConfiguration | null

Specific configuration for the GritQL language

html HtmlConfiguration | null

Specific configuration for the GritQL language

includes OverrideGlobs | null

A list of glob patterns. Biome will include files/folders that will match these patterns.

javascript JsConfiguration | null

Specific configuration for the JavaScript language

json JsonConfiguration | null

Specific configuration for the Json language

Specific configuration for the Json language

plugins Plugins | null

Specific configuration for additional plugins

Overrides OverridePattern[]
PathOptions object
allowImportNames string[]

Names of the exported members that allowed to be not be used.

importNames string[]

Names of the exported members that should not be used.

message string

The message to display when this module is imported.

Paths string | PathOptions
PatternOptions object
group SourcesMatcher | null

An array of gitignore-style patterns.

importNamePattern Regex | null

A regex pattern for import names to forbid within the matched modules.

invertImportNamePattern boolean

If true, the matched patterns in the importNamePattern will be allowed. Defaults to false.

Default: false
message string | null

A custom message for diagnostics related to this pattern.

Patterns PatternOptions
Performance object

A list of rules that belong to this group

noAccumulatingSpread NoAccumulatingSpreadConfiguration | null

Disallow the use of spread (...) syntax on accumulators. See https://biomejs.dev/linter/rules/no-accumulating-spread

noAwaitInLoops NoAwaitInLoopsConfiguration | null

Disallow await inside loops. See https://biomejs.dev/linter/rules/no-await-in-loops

noBarrelFile NoBarrelFileConfiguration | null

Disallow the use of barrel file. See https://biomejs.dev/linter/rules/no-barrel-file

noDelete NoDeleteConfiguration | null

Disallow the use of the delete operator. See https://biomejs.dev/linter/rules/no-delete

noDynamicNamespaceImportAccess NoDynamicNamespaceImportAccessConfiguration | null

Disallow accessing namespace imports dynamically. See https://biomejs.dev/linter/rules/no-dynamic-namespace-import-access

noImgElement NoImgElementConfiguration | null

Prevent usage of <img> element in a Next.js project. See https://biomejs.dev/linter/rules/no-img-element

noNamespaceImport NoNamespaceImportConfiguration | null

Disallow the use of namespace imports. See https://biomejs.dev/linter/rules/no-namespace-import

noUnwantedPolyfillio NoUnwantedPolyfillioConfiguration | null

Prevent duplicate polyfills from Polyfill.io. See https://biomejs.dev/linter/rules/no-unwanted-polyfillio

recommended boolean | null

Enables the recommended rules for this group

useGoogleFontPreconnect UseGoogleFontPreconnectConfiguration | null

Ensure the preconnect attribute is used when using Google Fonts. See https://biomejs.dev/linter/rules/use-google-font-preconnect

useSolidForComponent UseSolidForComponentConfiguration | null

Enforce using Solid's <For /> component for mapping an array to JSX elements. See https://biomejs.dev/linter/rules/use-solid-for-component

useTopLevelRegex UseTopLevelRegexConfiguration | null

Require regex literals to be declared at the top level. See https://biomejs.dev/linter/rules/use-top-level-regex

PluginConfiguration string
Plugins PluginConfiguration[]
PropertyAssignmentMode string | string

Specifies whether property assignments on function parameters are allowed or denied.

QuoteProperties string
QuoteStyle string
Regex string
RestrictedModifier string
RuleAssistPlainConfiguration string
RuleAssistWithOrganizeImportsOptions object
level string required
Values: "off" "on"
options object required
2 nested properties
groups ImportGroups | null
identifierOrder SortOrder | null
RuleAssistWithUseSortedAttributesOptions object
level string required
Values: "off" "on"
options object required
1 nested properties
sortOrder SortOrder | null
RuleAssistWithUseSortedKeysOptions object
level string required
Values: "off" "on"
options object required
1 nested properties
sortOrder SortOrder | null
RuleAssistWithUseSortedPropertiesOptions object
level string required
Values: "off" "on"
options object required
RuleDomain string | string | string | string | string | string | string | string | string

Rule domains

RuleDomainValue string | string | string
RuleDomains Record<string, string | string | string>
RulePlainConfiguration string | string | string | string | string
RuleWithNoAccessKeyOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoAccumulatingSpreadOptions object
level string | string | string | string | string required
options object
RuleWithNoAdjacentSpacesInRegexOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoAlertOptions object
level string | string | string | string | string required
options object
RuleWithNoAmbiguousAnchorTextOptions object
level string | string | string | string | string required
options object
1 nested properties
words array | null

It allows users to modify the strings that can be checked for in the anchor text. Useful for specifying other words in other languages

Default: null
RuleWithNoApproximativeNumericConstantOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoArgumentsOptions object
level string | string | string | string | string required
options object
RuleWithNoAriaHiddenOnFocusableOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoAriaUnsupportedElementsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoArrayIndexKeyOptions object
level string | string | string | string | string required
options object
RuleWithNoAssignInExpressionsOptions object
level string | string | string | string | string required
options object
RuleWithNoAsyncPromiseExecutorOptions object
level string | string | string | string | string required
options object
RuleWithNoAutofocusOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoAwaitInLoopsOptions object
level string | string | string | string | string required
options object
RuleWithNoBannedTypesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoBarrelFileOptions object
level string | string | string | string | string required
options object
RuleWithNoBeforeInteractiveScriptOutsideDocumentOptions object
level string | string | string | string | string required
options object
RuleWithNoBiomeFirstExceptionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoBitwiseOperatorsOptions object
level string | string | string | string | string required
options object
1 nested properties
allow array | null

Allows a list of bitwise operators to be used as exceptions.

RuleWithNoBlankTargetOptions object
level string | string | string | string | string required
fix FixKind | null
options object
2 nested properties
allowDomains string[]

List of domains where target="_blank" is allowed without rel="noopener".

allowNoReferrer boolean | null

Whether noreferrer is allowed in addition to noopener.

RuleWithNoCatchAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoChildrenPropOptions object
level string | string | string | string | string required
options object
RuleWithNoClassAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoCommaOperatorOptions object
level string | string | string | string | string required
options object
RuleWithNoCommentTextOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoCommonJsOptions object
level string | string | string | string | string required
options object
RuleWithNoCompareNegZeroOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoConfusingLabelsOptions object
level string | string | string | string | string required
options object
1 nested properties
allowedLabels array | null

A list of (non-confusing) labels that should be allowed

RuleWithNoConfusingVoidTypeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoConsoleOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
allow array | null

Allowed calls on the console object.

RuleWithNoConstAssignOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoConstEnumOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoConstantBinaryExpressionsOptions object
level string | string | string | string | string required
options object
RuleWithNoConstantConditionOptions object
level string | string | string | string | string required
options object
RuleWithNoConstantMathMinMaxClampOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoConstructorReturnOptions object
level string | string | string | string | string required
options object
RuleWithNoContinueOptions object
level string | string | string | string | string required
options object
RuleWithNoControlCharactersInRegexOptions object
level string | string | string | string | string required
options object
RuleWithNoDangerouslySetInnerHtmlOptions object
level string | string | string | string | string required
options object
RuleWithNoDangerouslySetInnerHtmlWithChildrenOptions object
level string | string | string | string | string required
options object
RuleWithNoDebuggerOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoDefaultExportOptions object
level string | string | string | string | string required
options object
RuleWithNoDeleteOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoDeprecatedImportsOptions object
level string | string | string | string | string required
options object
RuleWithNoDescendingSpecificityOptions object
level string | string | string | string | string required
options object
RuleWithNoDistractingElementsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoDocumentCookieOptions object
level string | string | string | string | string required
options object
RuleWithNoDocumentImportInPageOptions object
level string | string | string | string | string required
options object
RuleWithNoDoneCallbackOptions object
level string | string | string | string | string required
options object
RuleWithNoDoubleEqualsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
ignoreNull boolean | null

If true, an exception is made when comparing with null, as it's often relied on to check both for null or undefined.

If false, no such exception will be made.

RuleWithNoDuplicateAtImportRulesOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateCaseOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateClassMembersOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateCustomPropertiesOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateDependenciesOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateElseIfOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateFieldsOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateFontNamesOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateJsxPropsOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateObjectKeysOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateParametersOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicatePropertiesOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateSelectorsKeyframeBlockOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicateTestHooksOptions object
level string | string | string | string | string required
options object
RuleWithNoDuplicatedSpreadPropsOptions object
level string | string | string | string | string required
options object
RuleWithNoDynamicNamespaceImportAccessOptions object
level string | string | string | string | string required
options object
RuleWithNoEmptyBlockOptions object
level string | string | string | string | string required
options object
RuleWithNoEmptyBlockStatementsOptions object
level string | string | string | string | string required
options object
RuleWithNoEmptyCharacterClassInRegexOptions object
level string | string | string | string | string required
options object
RuleWithNoEmptyInterfaceOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoEmptyPatternOptions object
level string | string | string | string | string required
options object
RuleWithNoEmptySourceOptions object
level string | string | string | string | string required
options object
1 nested properties
allowComments boolean | null

Whether comments are considered meaningful

RuleWithNoEmptyTypeParametersOptions object
level string | string | string | string | string required
options object
RuleWithNoEnumOptions object
level string | string | string | string | string required
options object
RuleWithNoEqualsToNullOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoEvolvingTypesOptions object
level string | string | string | string | string required
options object
RuleWithNoExcessiveCognitiveComplexityOptions object
level string | string | string | string | string required
options object
1 nested properties
maxAllowedComplexity integer | null

The maximum complexity score that we allow. Anything higher is considered excessive.

format=uint8min=1max=255
RuleWithNoExcessiveLinesPerFunctionOptions object
level string | string | string | string | string required
options object
3 nested properties
maxLines integer | null

The maximum number of lines allowed in a function body.

format=uint16min=1max=65535
skipBlankLines boolean | null

When this options is set to true, blank lines in the function body are not counted towards the maximum line limit.

skipIifes boolean | null

When this option is set to true, Immediately Invoked Function Expressions (IIFEs) are not checked for the maximum line limit.

RuleWithNoExcessiveNestedTestSuitesOptions object
level string | string | string | string | string required
options object
RuleWithNoExplicitAnyOptions object
level string | string | string | string | string required
options object
RuleWithNoExportedImportsOptions object
level string | string | string | string | string required
options object
RuleWithNoExportsInTestOptions object
level string | string | string | string | string required
options object
RuleWithNoExtraBooleanCastOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoExtraNonNullAssertionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoFallthroughSwitchClauseOptions object
level string | string | string | string | string required
options object
RuleWithNoFlatMapIdentityOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoFloatingPromisesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoFocusedTestsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoForEachOptions object
level string | string | string | string | string required
options object
1 nested properties
allowedIdentifiers array | null

A list of variable names allowed for forEach calls.

RuleWithNoForInOptions object
level string | string | string | string | string required
options object
RuleWithNoFunctionAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoGlobalAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoGlobalDirnameFilenameOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoGlobalEvalOptions object
level string | string | string | string | string required
options object
RuleWithNoGlobalIsFiniteOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoGlobalIsNanOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoGlobalObjectCallsOptions object
level string | string | string | string | string required
options object
RuleWithNoHeadElementOptions object
level string | string | string | string | string required
options object
RuleWithNoHeadImportInDocumentOptions object
level string | string | string | string | string required
options object
RuleWithNoHeaderScopeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoImgElementOptions object
level string | string | string | string | string required
options object
RuleWithNoImplicitAnyLetOptions object
level string | string | string | string | string required
options object
RuleWithNoImplicitBooleanOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoImplicitCoercionsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoImportAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoImportCyclesOptions object
level string | string | string | string | string required
options object
1 nested properties
ignoreTypes boolean | null

Ignores type-only imports when finding an import cycle. A type-only import (import type) will be removed by the compiler, so it cuts an import cycle at runtime. Note that named type imports (import { type Foo }) aren't considered as type-only because it's not removed by the compiler if the verbatimModuleSyntax option is enabled. Enabled by default.

RuleWithNoImportantInKeyframeOptions object
level string | string | string | string | string required
options object
RuleWithNoImportantStylesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoIncrementDecrementOptions object
level string | string | string | string | string required
options object
1 nested properties
allowForLoopAfterthoughts boolean | null

Allows unary operators ++ and -- in the afterthought (final expression) of a for loop.

RuleWithNoInferrableTypesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoInnerDeclarationsOptions object
level string | string | string | string | string required
options object
RuleWithNoInteractiveElementToNoninteractiveRoleOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoInvalidBuiltinInstantiationOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoInvalidConstructorSuperOptions object
level string | string | string | string | string required
options object
RuleWithNoInvalidDirectionInLinearGradientOptions object
level string | string | string | string | string required
options object
RuleWithNoInvalidGridAreasOptions object
level string | string | string | string | string required
options object
RuleWithNoInvalidPositionAtImportRuleOptions object
level string | string | string | string | string required
options object
RuleWithNoInvalidUseBeforeDeclarationOptions object
level string | string | string | string | string required
options object
RuleWithNoIrregularWhitespaceOptions object
level string | string | string | string | string required
options object
RuleWithNoJsxLiteralsOptions object
level string | string | string | string | string required
options object
3 nested properties
allowedStrings array | null

An array of strings that won't trigger the rule. Whitespaces are taken into consideration

ignoreProps boolean | null

When enabled, strings inside props are always ignored

noStrings boolean | null

When enabled, also flag string literals inside JSX expressions and attributes

RuleWithNoJsxPropsBindOptions object
level string | string | string | string | string required
options object
RuleWithNoLabelVarOptions object
level string | string | string | string | string required
options object
RuleWithNoLabelWithoutControlOptions object
level string | string | string | string | string required
options object
3 nested properties
inputComponents array | null

Array of component names that should be considered the same as an input element.

labelAttributes array | null

Array of attributes that should be treated as the label accessible text content.

labelComponents array | null

Array of component names that should be considered the same as a label element.

RuleWithNoLeakedRenderOptions object
level string | string | string | string | string required
options object
RuleWithNoMagicNumbersOptions object
level string | string | string | string | string required
options object
RuleWithNoMisleadingCharacterClassOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoMisleadingInstantiatorOptions object
level string | string | string | string | string required
options object
RuleWithNoMisplacedAssertionOptions object
level string | string | string | string | string required
options object
RuleWithNoMisrefactoredShorthandAssignOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoMissingVarFunctionOptions object
level string | string | string | string | string required
options object
RuleWithNoMisusedPromisesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoMultiAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoMultiStrOptions object
level string | string | string | string | string required
options object
RuleWithNoNamespaceImportOptions object
level string | string | string | string | string required
options object
RuleWithNoNamespaceOptions object
level string | string | string | string | string required
options object
RuleWithNoNegationElseOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoNestedComponentDefinitionsOptions object
level string | string | string | string | string required
options object
RuleWithNoNestedTernaryOptions object
level string | string | string | string | string required
options object
RuleWithNoNextAsyncClientComponentOptions object
level string | string | string | string | string required
options object
RuleWithNoNodejsModulesOptions object
level string | string | string | string | string required
options object
RuleWithNoNonNullAssertedOptionalChainOptions object
level string | string | string | string | string required
options object
RuleWithNoNonNullAssertionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoNoninteractiveElementInteractionsOptions object
level string | string | string | string | string required
options object
RuleWithNoNoninteractiveElementToInteractiveRoleOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoNoninteractiveTabindexOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoNonoctalDecimalEscapeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoOctalEscapeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoParameterAssignOptions object
level string | string | string | string | string required
options object
1 nested properties
propertyAssignment PropertyAssignmentMode | null

Whether to report an error when a dependency is listed in the dependencies array but isn't used. Defaults to allow.

RuleWithNoParameterPropertiesOptions object
level string | string | string | string | string required
options object
RuleWithNoParametersOnlyUsedInRecursionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoPositiveTabindexOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoPrecisionLossOptions object
level string | string | string | string | string required
options object
RuleWithNoPrivateImportsOptions object
level string | string | string | string | string required
options object
1 nested properties
defaultVisibility Visibility | null

The default visibility to assume for symbols without visibility tag.

Default: public.

RuleWithNoProcessEnvOptions object
level string | string | string | string | string required
options object
RuleWithNoProcessGlobalOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoProtoOptions object
level string | string | string | string | string required
options object
RuleWithNoPrototypeBuiltinsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoQuickfixBiomeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
additionalPaths string[]

A list of additional JSON files that should be checked.

Default:
[]
RuleWithNoQwikUseVisibleTaskOptions object
level string | string | string | string | string required
options object
RuleWithNoReExportAllOptions object
level string | string | string | string | string required
options object
RuleWithNoReactForwardRefOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoReactPropAssignmentsOptions object
level string | string | string | string | string required
options object
RuleWithNoReactSpecificPropsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoRedeclareOptions object
level string | string | string | string | string required
options object
RuleWithNoRedundantAltOptions object
level string | string | string | string | string required
options object
RuleWithNoRedundantRolesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoRedundantUseStrictOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoRenderReturnValueOptions object
level string | string | string | string | string required
options object
RuleWithNoRestrictedElementsOptions object
level string | string | string | string | string required
options object
1 nested properties
elements CustomRestrictedElements | null

Elements to restrict. Each key is the element name, and the value is the message to show when the element is used.

RuleWithNoRestrictedGlobalsOptions object
level string | string | string | string | string required
options object
1 nested properties
deniedGlobals Record<string, string>

A list of names that should trigger the rule

RuleWithNoRestrictedImportsOptions object
level string | string | string | string | string required
options object
2 nested properties
paths Record<string, string | PathOptions>

A list of import paths that should trigger the rule.

patterns array | null

gitignore-style patterns that should trigger the rule.

RuleWithNoRestrictedTypesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
types Record<string, string | CustomRestrictedTypeOptions>
RuleWithNoReturnAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoScriptUrlOptions object
level string | string | string | string | string required
options object
RuleWithNoSecretsOptions object
level string | string | string | string | string required
options object
1 nested properties
entropyThreshold integer | null

Set entropy threshold (default is 41).

format=uint16min=0max=65535
RuleWithNoSelfAssignOptions object
level string | string | string | string | string required
options object
RuleWithNoSelfCompareOptions object
level string | string | string | string | string required
options object
RuleWithNoSetterReturnOptions object
level string | string | string | string | string required
options object
RuleWithNoShadowOptions object
level string | string | string | string | string required
options object
RuleWithNoShadowRestrictedNamesOptions object
level string | string | string | string | string required
options object
RuleWithNoShorthandPropertyOverridesOptions object
level string | string | string | string | string required
options object
RuleWithNoShoutyConstantsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoSkippedTestsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoSolidDestructuredPropsOptions object
level string | string | string | string | string required
options object
RuleWithNoSparseArrayOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoStaticElementInteractionsOptions object
level string | string | string | string | string required
options object
RuleWithNoStaticOnlyClassOptions object
level string | string | string | string | string required
options object
RuleWithNoStringCaseMismatchOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoSubstrOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoSuspiciousSemicolonInJsxOptions object
level string | string | string | string | string required
options object
RuleWithNoSvgWithoutTitleOptions object
level string | string | string | string | string required
options object
RuleWithNoSwitchDeclarationsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoSyncScriptsOptions object
level string | string | string | string | string required
options object
RuleWithNoTemplateCurlyInStringOptions object
level string | string | string | string | string required
options object
RuleWithNoTernaryOptions object
level string | string | string | string | string required
options object
RuleWithNoThenPropertyOptions object
level string | string | string | string | string required
options object
RuleWithNoThisInStaticOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoTsIgnoreOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUnassignedVariablesOptions object
level string | string | string | string | string required
options object
RuleWithNoUndeclaredDependenciesOptions object
level string | string | string | string | string required
options object
3 nested properties
devDependencies DependencyAvailability | null

If set to false, then the rule will show an error when devDependencies are imported. Defaults to true.

optionalDependencies DependencyAvailability | null

If set to false, then the rule will show an error when optionalDependencies are imported. Defaults to true.

peerDependencies DependencyAvailability | null

If set to false, then the rule will show an error when peerDependencies are imported. Defaults to true.

RuleWithNoUndeclaredEnvVarsOptions object
level string | string | string | string | string required
options object
1 nested properties
allowedEnvVars array | null

Environment variables that should always be allowed. Use this to specify environment variables that are always available in your environment, even when not declared in turbo.json. Supports regular expressions, e.g. ["MY_ENV_.*"].

RuleWithNoUndeclaredVariablesOptions object
level string | string | string | string | string required
options object
1 nested properties
checkTypes boolean | null

Check undeclared types.

RuleWithNoUnknownAtRulesOptions object
level string | string | string | string | string required
options object
1 nested properties
ignore string[]

A list of unknown at-rule names to ignore (case-insensitive).

RuleWithNoUnknownAttributeOptions object
level string | string | string | string | string required
options object
1 nested properties
ignore array | null
RuleWithNoUnknownFunctionOptions object
level string | string | string | string | string required
options object
RuleWithNoUnknownMediaFeatureNameOptions object
level string | string | string | string | string required
options object
RuleWithNoUnknownPropertyOptions object
level string | string | string | string | string required
options object
RuleWithNoUnknownPseudoClassOptions object
level string | string | string | string | string required
options object
RuleWithNoUnknownPseudoElementOptions object
level string | string | string | string | string required
options object
RuleWithNoUnknownTypeSelectorOptions object
level string | string | string | string | string required
options object
RuleWithNoUnknownUnitOptions object
level string | string | string | string | string required
options object
RuleWithNoUnmatchableAnbSelectorOptions object
level string | string | string | string | string required
options object
RuleWithNoUnnecessaryConditionsOptions object
level string | string | string | string | string required
options object
RuleWithNoUnreachableOptions object
level string | string | string | string | string required
options object
RuleWithNoUnreachableSuperOptions object
level string | string | string | string | string required
options object
RuleWithNoUnresolvedImportsOptions object
level string | string | string | string | string required
options object
RuleWithNoUnsafeDeclarationMergingOptions object
level string | string | string | string | string required
options object
RuleWithNoUnsafeFinallyOptions object
level string | string | string | string | string required
options object
RuleWithNoUnsafeNegationOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUnsafeOptionalChainingOptions object
level string | string | string | string | string required
options object
RuleWithNoUnusedExpressionsOptions object
level string | string | string | string | string required
options object
RuleWithNoUnusedFunctionParametersOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
ignoreRestSiblings boolean | null

Whether to ignore unused variables from an object destructuring with a spread.

RuleWithNoUnusedImportsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUnusedLabelsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUnusedPrivateClassMembersOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUnusedTemplateLiteralOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUnusedVariablesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
ignoreRestSiblings boolean | null

Whether to ignore unused variables from an object destructuring with a spread.

RuleWithNoUnwantedPolyfillioOptions object
level string | string | string | string | string required
options object
RuleWithNoUselessCatchBindingOptions object
level string | string | string | string | string required
fix FixKind | null
options object

Options for the noUselessCatchBinding rule. Currently empty; reserved for future extensions (e.g. allowlist of names).

RuleWithNoUselessCatchOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessConstructorOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessContinueOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessElseOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessEmptyExportOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessEscapeInRegexOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessEscapeInStringOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessFragmentsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessLabelOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessLoneBlockStatementsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessRegexBackrefsOptions object
level string | string | string | string | string required
options object
RuleWithNoUselessRenameOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessStringConcatOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessStringRawOptions object
level string | string | string | string | string required
options object
RuleWithNoUselessSwitchCaseOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessTernaryOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessThisAliasOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessTypeConstraintOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessUndefinedInitializationOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoUselessUndefinedOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoValueAtRuleOptions object
level string | string | string | string | string required
options object
RuleWithNoVarOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoVoidElementsWithChildrenOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoVoidOptions object
level string | string | string | string | string required
options object
RuleWithNoVoidTypeReturnOptions object
level string | string | string | string | string required
options object
RuleWithNoVueDataObjectDeclarationOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithNoVueDuplicateKeysOptions object
level string | string | string | string | string required
options object
RuleWithNoVueReservedKeysOptions object
level string | string | string | string | string required
options object
RuleWithNoVueReservedPropsOptions object
level string | string | string | string | string required
options object
RuleWithNoVueSetupPropsReactivityLossOptions object
level string | string | string | string | string required
options object
RuleWithNoVueVIfWithVForOptions object
level string | string | string | string | string required
options object
RuleWithNoWithOptions object
level string | string | string | string | string required
options object
RuleWithNoYodaExpressionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseAdjacentOverloadSignaturesOptions object
level string | string | string | string | string required
options object
RuleWithUseAltTextOptions object
level string | string | string | string | string required
options object
RuleWithUseAnchorContentOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseAriaActivedescendantWithTabindexOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseAriaPropsForRoleOptions object
level string | string | string | string | string required
options object
RuleWithUseAriaPropsSupportedByRoleOptions object
level string | string | string | string | string required
options object
RuleWithUseArrayLiteralsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseArraySortCompareOptions object
level string | string | string | string | string required
options object
RuleWithUseArrowFunctionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseAsConstAssertionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseAtIndexOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseAwaitOptions object
level string | string | string | string | string required
options object
RuleWithUseAwaitThenableOptions object
level string | string | string | string | string required
options object
RuleWithUseBiomeIgnoreFolderOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseBlockStatementsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseButtonTypeOptions object
level string | string | string | string | string required
options object
RuleWithUseCollapsedElseIfOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseCollapsedIfOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseComponentExportOnlyModulesOptions object
level string | string | string | string | string required
options object
2 nested properties
allowConstantExport boolean | null

Allows the export of constants. This option is for environments that support it, such as Vite

Default: null
allowExportNames array | null

A list of names that can be additionally exported from the module This option is for exports that do not hinder React Fast Refresh, such as meta in Remix

RuleWithUseConsistentArrayTypeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
syntax ConsistentArrayType | null
RuleWithUseConsistentArrowReturnOptions object
level string | string | string | string | string required
fix FixKind | null
options object

Options for the useConsistentArrowReturn rule.

2 nested properties
requireForObjectLiteral boolean | null

Determines whether the rule enforces a consistent style when the return value is an object literal.

This option is only applicable when used in conjunction with the asNeeded option.

The style to enforce for arrow function return statements.

RuleWithUseConsistentBuiltinInstantiationOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseConsistentCurlyBracesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseConsistentGraphqlDescriptionsOptions object
level string | string | string | string | string required
options object
1 nested properties

The description style to enforce. Defaults to "block"

Default: null
RuleWithUseConsistentMemberAccessibilityOptions object
level string | string | string | string | string required
options object
1 nested properties
accessibility Accessibility | null

The kind of accessibility you want to enforce. Default to "noPublic"

RuleWithUseConsistentObjectDefinitionsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
syntax ObjectPropertySyntax | null

The preferred syntax to enforce.

RuleWithUseConsistentTypeDefinitionsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
RuleWithUseConstOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseDateNowOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseDefaultParameterLastOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseDefaultSwitchClauseLastOptions object
level string | string | string | string | string required
options object
RuleWithUseDefaultSwitchClauseOptions object
level string | string | string | string | string required
options object
RuleWithUseDeprecatedDateOptions object
level string | string | string | string | string required
options object
1 nested properties
argumentName string | null
RuleWithUseDeprecatedReasonOptions object
level string | string | string | string | string required
options object
RuleWithUseDestructuringOptions object
level string | string | string | string | string required
options object
RuleWithUseEnumInitializersOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseErrorMessageOptions object
level string | string | string | string | string required
options object
RuleWithUseExhaustiveDependenciesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
3 nested properties
hooks array | null

List of hooks of which the dependencies should be validated.

reportMissingDependenciesArray boolean | null

Whether to report an error when a hook has no dependencies array.

reportUnnecessaryDependencies boolean | null

Whether to report an error when a dependency is listed in the dependencies array but isn't used. Defaults to true.

RuleWithUseExhaustiveSwitchCasesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseExplicitLengthCheckOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseExplicitTypeOptions object
level string | string | string | string | string required
options object
RuleWithUseExponentiationOperatorOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseExportTypeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseExportsLastOptions object
level string | string | string | string | string required
options object
RuleWithUseFilenamingConventionOptions object
level string | string | string | string | string required
options object
4 nested properties
filenameCases FilenameCases | null

Allowed cases for file names.

match Regex | null

Regular expression to enforce

requireAscii boolean | null

If false, then non-ASCII characters are allowed.

strictCase boolean | null

If false, then consecutive uppercase are allowed in camel and pascal cases. This does not affect other [Case].

RuleWithUseFindOptions object
level string | string | string | string | string required
options object
RuleWithUseFlatMapOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseFocusableInteractiveOptions object
level string | string | string | string | string required
options object
RuleWithUseForOfOptions object
level string | string | string | string | string required
options object
RuleWithUseFragmentSyntaxOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseGenericFontNamesOptions object
level string | string | string | string | string required
options object
RuleWithUseGetterReturnOptions object
level string | string | string | string | string required
options object
RuleWithUseGoogleFontDisplayOptions object
level string | string | string | string | string required
options object
RuleWithUseGoogleFontPreconnectOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseGraphqlNamedOperationsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseGraphqlNamingConventionOptions object
level string | string | string | string | string required
options object
RuleWithUseGroupedAccessorPairsOptions object
level string | string | string | string | string required
options object
RuleWithUseGuardForInOptions object
level string | string | string | string | string required
options object
RuleWithUseHeadingContentOptions object
level string | string | string | string | string required
options object
RuleWithUseHookAtTopLevelOptions object
level string | string | string | string | string required
options object
RuleWithUseHtmlLangOptions object
level string | string | string | string | string required
options object
RuleWithUseIframeTitleOptions object
level string | string | string | string | string required
options object
RuleWithUseImageSizeOptions object
level string | string | string | string | string required
options null
RuleWithUseImportExtensionsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
forceJsExtensions boolean | null

If true, the suggested extension is always .js regardless of what extension the source file has in your project.

RuleWithUseImportTypeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
style UseImportTypeStyle | null

The style to apply when import types. Default to "auto"

RuleWithUseIndexOfOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseIsArrayOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseIsNanOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseIterableCallbackReturnOptions object
level string | string | string | string | string required
options object
RuleWithUseJsonImportAttributesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseJsxKeyInIterableOptions object
level string | string | string | string | string required
options object
1 nested properties
checkShorthandFragments boolean | null

Set to true to check shorthand fragments (<></>)

RuleWithUseKeyWithClickEventsOptions object
level string | string | string | string | string required
options object
RuleWithUseKeyWithMouseEventsOptions object
level string | string | string | string | string required
options object
RuleWithUseLiteralEnumMembersOptions object
level string | string | string | string | string required
options object
RuleWithUseLiteralKeysOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseMaxParamsOptions object
level string | string | string | string | string required
options object
1 nested properties
max integer | null

Maximum number of parameters allowed (default: 4)

format=uint8min=0max=255
RuleWithUseMediaCaptionOptions object
level string | string | string | string | string required
options object
RuleWithUseNamespaceKeywordOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseNamingConventionOptions object
level string | string | string | string | string required
fix FixKind | null
options object

Rule's options.

3 nested properties
conventions array | null

Custom conventions.

requireAscii boolean | null

If false, then non-ASCII characters are allowed.

strictCase boolean | null

If false, then consecutive uppercase are allowed in camel and pascal cases. This does not affect other [Case].

RuleWithUseNodeAssertStrictOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseNodejsImportProtocolOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseNumberNamespaceOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseNumberToFixedDigitsArgumentOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseNumericLiteralsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseNumericSeparatorsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseObjectSpreadOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseOptionalChainOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseParseIntRadixOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseQwikClasslistOptions object
level string | string | string | string | string required
options object
RuleWithUseQwikMethodUsageOptions object
level string | string | string | string | string required
options object
RuleWithUseQwikValidLexicalScopeOptions object
level string | string | string | string | string required
options object
RuleWithUseReactFunctionComponentsOptions object
level string | string | string | string | string required
options object
RuleWithUseReadonlyClassPropertiesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
checkAllProperties boolean | null

When true, the keywords public, protected, and private are analyzed by the rule.

RuleWithUseRegexLiteralsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseRegexpExecOptions object
level string | string | string | string | string required
options object
RuleWithUseRequiredScriptsOptions object
level string | string | string | string | string required
options object
1 nested properties
requiredScripts string[]

List of script names that must be present in package.json

Default:
[]
RuleWithUseSelfClosingElementsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
ignoreHtmlElements boolean | null
RuleWithUseSemanticElementsOptions object
level string | string | string | string | string required
options object
RuleWithUseShorthandAssignOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseShorthandFunctionTypeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseSimpleNumberKeysOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseSimplifiedLogicExpressionOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseSingleJsDocAsteriskOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseSingleVarDeclaratorOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseSolidForComponentOptions object
level string | string | string | string | string required
options object
RuleWithUseSortedClassesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
2 nested properties
attributes array | null

Additional attributes that will be sorted.

functions array | null

Names of the functions or tagged templates that will be sorted.

RuleWithUseSpreadOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseStaticResponseMethodsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseStrictModeOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseSymbolDescriptionOptions object
level string | string | string | string | string required
options object
RuleWithUseTemplateOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseThrowNewErrorOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseThrowOnlyErrorOptions object
level string | string | string | string | string required
options object
RuleWithUseTopLevelRegexOptions object
level string | string | string | string | string required
options object
RuleWithUseTrimStartEndOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseUnifiedTypeSignaturesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseUniqueArgumentNamesOptions object
level string | string | string | string | string required
options object
RuleWithUseUniqueElementIdsOptions object
level string | string | string | string | string required
options object
1 nested properties
excludedComponents array | null

Component names that accept an id prop that does not translate to a DOM element id.

uniqueItems=true
RuleWithUseUniqueFieldDefinitionNamesOptions object
level string | string | string | string | string required
options object
RuleWithUseUniqueGraphqlOperationNameOptions object
level string | string | string | string | string required
options object
RuleWithUseUniqueInputFieldNamesOptions object
level string | string | string | string | string required
options object
RuleWithUseUniqueVariableNamesOptions object
level string | string | string | string | string required
options object
RuleWithUseValidAnchorOptions object
level string | string | string | string | string required
options object
RuleWithUseValidAriaPropsOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseValidAriaRoleOptions object
level string | string | string | string | string required
fix FixKind | null
options object
2 nested properties
allowInvalidRoles array | null

It allows specifying a list of roles that might be invalid otherwise

ignoreNonDom boolean | null

Use this option to ignore non-DOM elements, such as custom components

RuleWithUseValidAriaValuesOptions object
level string | string | string | string | string required
options object
RuleWithUseValidAutocompleteOptions object
level string | string | string | string | string required
options object
1 nested properties
inputComponents array | null

input like custom components that should be checked.

RuleWithUseValidForDirectionOptions object
level string | string | string | string | string required
options object
RuleWithUseValidLangOptions object
level string | string | string | string | string required
options object
RuleWithUseValidTypeofOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseVueConsistentDefinePropsDeclarationOptions object
level string | string | string | string | string required
options object
1 nested properties
style DeclarationStyle | null
RuleWithUseVueConsistentVBindStyleOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
style VueDirectiveStyle | null

Preferred style for v-bind usage: "shorthand" or "longhand". If omitted, shorthand is preferred.

RuleWithUseVueConsistentVOnStyleOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
style VueDirectiveStyle2 | null

Preferred style for v-on usage: "shorthand" or "longhand". If omitted, shorthand is preferred.

RuleWithUseVueDefineMacrosOrderOptions object
level string | string | string | string | string required
fix FixKind | null
options object
1 nested properties
order array | null

The order of the Vue define macros.

RuleWithUseVueHyphenatedAttributesOptions object
level string | string | string | string | string required
fix FixKind | null
options object
2 nested properties
ignore array | null

List of attribute names to ignore when checking for hyphenated attributes.

Default: null
uniqueItems=true
ignoreTags array | null

List of HTML tags to ignore when checking for hyphenated attributes.

Default: null
uniqueItems=true
RuleWithUseVueMultiWordComponentNamesOptions object
level string | string | string | string | string required
options object
1 nested properties
ignores string[]

Component names to ignore (allowed to be single-word).

RuleWithUseVueVForKeyOptions object
level string | string | string | string | string required
options object
RuleWithUseVueValidTemplateRootOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseVueValidVBindOptions object
level string | string | string | string | string required
options object
RuleWithUseVueValidVCloakOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseVueValidVElseIfOptions object
level string | string | string | string | string required
options object
RuleWithUseVueValidVElseOptions object
level string | string | string | string | string required
options object
RuleWithUseVueValidVHtmlOptions object
level string | string | string | string | string required
options object
RuleWithUseVueValidVIfOptions object
level string | string | string | string | string required
options object
RuleWithUseVueValidVOnOptions object
level string | string | string | string | string required
options object
1 nested properties
modifiers array | null

Additional modifiers that should be considered valid

Default: null
RuleWithUseVueValidVOnceOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseVueValidVPreOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseVueValidVTextOptions object
level string | string | string | string | string required
options object
RuleWithUseVueVaporOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseWhileOptions object
level string | string | string | string | string required
fix FixKind | null
options object
RuleWithUseYieldOptions object
level string | string | string | string | string required
options object
Rules object
a11y SeverityOrA11y | null
complexity SeverityOrComplexity | null
correctness SeverityOrCorrectness | null
nursery SeverityOrNursery | null
performance SeverityOrPerformance | null
recommended boolean | null

It enables the lint rules recommended by Biome. true by default.

security SeverityOrSecurity | null
style SeverityOrStyle | null
suspicious SeverityOrSuspicious | null
Schema string
Scope string
Security object

A list of rules that belong to this group

noBlankTarget NoBlankTargetConfiguration | null

Disallow target="_blank" attribute without rel="noopener". See https://biomejs.dev/linter/rules/no-blank-target

noDangerouslySetInnerHtml NoDangerouslySetInnerHtmlConfiguration | null

Prevent the usage of dangerous JSX props. See https://biomejs.dev/linter/rules/no-dangerously-set-inner-html

noDangerouslySetInnerHtmlWithChildren NoDangerouslySetInnerHtmlWithChildrenConfiguration | null

Report when a DOM element or a component uses both children and dangerouslySetInnerHTML prop. See https://biomejs.dev/linter/rules/no-dangerously-set-inner-html-with-children

noGlobalEval NoGlobalEvalConfiguration | null

Disallow the use of global eval(). See https://biomejs.dev/linter/rules/no-global-eval

noSecrets NoSecretsConfiguration | null

Disallow usage of sensitive data such as API keys and tokens. See https://biomejs.dev/linter/rules/no-secrets

recommended boolean | null

Enables the recommended rules for this group

Selector object
kind string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
uniqueItems=true
scope string
Values: "any" "global"
SelfCloseVoidElements string | string

Controls whether void-elements should be self closed

Semicolons string
SeverityOrA11y GroupPlainConfiguration | A11y
SeverityOrComplexity GroupPlainConfiguration | Complexity
SeverityOrCorrectness GroupPlainConfiguration | Correctness
SeverityOrNursery GroupPlainConfiguration | Nursery
SeverityOrPerformance GroupPlainConfiguration | Performance
SeverityOrSecurity GroupPlainConfiguration | Security
SeverityOrStyle GroupPlainConfiguration | Style
SeverityOrSuspicious GroupPlainConfiguration | Suspicious
SortOrder string
Source object

A list of rules that belong to this group

organizeImports OrganizeImportsConfiguration | null

Provides a code action to sort the imports and exports in the file using a built-in or custom order. See https://biomejs.dev/assist/actions/organize-imports

recommended boolean | null

Enables the recommended rules for this group

useSortedAttributes UseSortedAttributesConfiguration | null

Enforce attribute sorting in JSX elements. See https://biomejs.dev/assist/actions/use-sorted-attributes

useSortedKeys UseSortedKeysConfiguration | null

Sort the keys of a JSON object in natural order. See https://biomejs.dev/assist/actions/use-sorted-keys

useSortedProperties UseSortedPropertiesConfiguration | null

Enforce ordering of CSS properties and nested rules. See https://biomejs.dev/assist/actions/use-sorted-properties

SourceMatcher NegatablePredefinedSourceMatcher | ImportSourceGlob
SourcesMatcher SourceMatcher | SourceMatcher[]
StableHookResult boolean | integer[] | string[]
Style object

A list of rules that belong to this group

noCommonJs NoCommonJsConfiguration | null

Disallow use of CommonJs module system in favor of ESM style imports. See https://biomejs.dev/linter/rules/no-common-js

noDefaultExport NoDefaultExportConfiguration | null
noDescendingSpecificity NoDescendingSpecificityConfiguration | null

Disallow a lower specificity selector from coming after a higher specificity selector. See https://biomejs.dev/linter/rules/no-descending-specificity

noDoneCallback NoDoneCallbackConfiguration | null

Disallow using a callback in asynchronous tests and hooks. See https://biomejs.dev/linter/rules/no-done-callback

noEnum NoEnumConfiguration | null

Disallow TypeScript enum. See https://biomejs.dev/linter/rules/no-enum

noExportedImports NoExportedImportsConfiguration | null

Disallow exporting an imported variable. See https://biomejs.dev/linter/rules/no-exported-imports

noHeadElement NoHeadElementConfiguration | null

Prevent usage of <head> element in a Next.js project. See https://biomejs.dev/linter/rules/no-head-element

noImplicitBoolean NoImplicitBooleanConfiguration | null

Disallow implicit true values on JSX boolean attributes. See https://biomejs.dev/linter/rules/no-implicit-boolean

noInferrableTypes NoInferrableTypesConfiguration | null

Disallow type annotations for variables, parameters, and class properties initialized with a literal expression. See https://biomejs.dev/linter/rules/no-inferrable-types

noMagicNumbers NoMagicNumbersConfiguration | null

Reports usage of "magic numbers" — numbers used directly instead of being assigned to named constants. See https://biomejs.dev/linter/rules/no-magic-numbers

noNamespace NoNamespaceConfiguration | null

Disallow the use of TypeScript's namespaces. See https://biomejs.dev/linter/rules/no-namespace

noNegationElse NoNegationElseConfiguration | null

Disallow negation in the condition of an if statement if it has an else clause. See https://biomejs.dev/linter/rules/no-negation-else

noNestedTernary NoNestedTernaryConfiguration | null

Disallow nested ternary expressions. See https://biomejs.dev/linter/rules/no-nested-ternary

noNonNullAssertion NoNonNullAssertionConfiguration | null

Disallow non-null assertions using the ! postfix operator. See https://biomejs.dev/linter/rules/no-non-null-assertion

noParameterAssign NoParameterAssignConfiguration | null

Disallow reassigning function parameters. See https://biomejs.dev/linter/rules/no-parameter-assign

noParameterProperties NoParameterPropertiesConfiguration | null

Disallow the use of parameter properties in class constructors. See https://biomejs.dev/linter/rules/no-parameter-properties

noProcessEnv NoProcessEnvConfiguration | null

Disallow the use of process.env. See https://biomejs.dev/linter/rules/no-process-env

noRestrictedGlobals NoRestrictedGlobalsConfiguration | null

This rule allows you to specify global variable names that you don’t want to use in your application. See https://biomejs.dev/linter/rules/no-restricted-globals

noRestrictedImports NoRestrictedImportsConfiguration | null

Disallow specified modules when loaded by import or require. See https://biomejs.dev/linter/rules/no-restricted-imports

noRestrictedTypes NoRestrictedTypesConfiguration | null
noShoutyConstants NoShoutyConstantsConfiguration | null

Disallow the use of constants which its value is the upper-case version of its name. See https://biomejs.dev/linter/rules/no-shouty-constants

noSubstr NoSubstrConfiguration | null

Enforce the use of String.slice() over String.substr() and String.substring(). See https://biomejs.dev/linter/rules/no-substr

noUnusedTemplateLiteral NoUnusedTemplateLiteralConfiguration | null

Disallow template literals if interpolation and special-character handling are not needed. See https://biomejs.dev/linter/rules/no-unused-template-literal

noUselessElse NoUselessElseConfiguration | null

Disallow else block when the if block breaks early. See https://biomejs.dev/linter/rules/no-useless-else

noValueAtRule NoValueAtRuleConfiguration | null

Disallow use of @value rule in css modules. See https://biomejs.dev/linter/rules/no-value-at-rule

noYodaExpression NoYodaExpressionConfiguration | null

Disallow the use of yoda expressions. See https://biomejs.dev/linter/rules/no-yoda-expression

recommended boolean | null

Enables the recommended rules for this group

useArrayLiterals UseArrayLiteralsConfiguration | null

Disallow Array constructors. See https://biomejs.dev/linter/rules/use-array-literals

useAsConstAssertion UseAsConstAssertionConfiguration | null

Enforce the use of as const over literal type and type annotation. See https://biomejs.dev/linter/rules/use-as-const-assertion

useAtIndex UseAtIndexConfiguration | null

Use at() instead of integer index access. See https://biomejs.dev/linter/rules/use-at-index

useBlockStatements UseBlockStatementsConfiguration | null

Requires following curly brace conventions. See https://biomejs.dev/linter/rules/use-block-statements

useCollapsedElseIf UseCollapsedElseIfConfiguration | null

Enforce using else if instead of nested if in else clauses. See https://biomejs.dev/linter/rules/use-collapsed-else-if

useCollapsedIf UseCollapsedIfConfiguration | null

Enforce using single if instead of nested if clauses. See https://biomejs.dev/linter/rules/use-collapsed-if

useComponentExportOnlyModules UseComponentExportOnlyModulesConfiguration | null

Enforce declaring components only within modules that export React Components exclusively. See https://biomejs.dev/linter/rules/use-component-export-only-modules

useConsistentArrayType UseConsistentArrayTypeConfiguration | null

Require consistently using either T[] or Array<T>. See https://biomejs.dev/linter/rules/use-consistent-array-type

useConsistentBuiltinInstantiation UseConsistentBuiltinInstantiationConfiguration | null

Enforce the use of new for all builtins, except String, Number and Boolean. See https://biomejs.dev/linter/rules/use-consistent-builtin-instantiation

useConsistentCurlyBraces UseConsistentCurlyBracesConfiguration | null

This rule enforces consistent use of curly braces inside JSX attributes and JSX children. See https://biomejs.dev/linter/rules/use-consistent-curly-braces

useConsistentMemberAccessibility UseConsistentMemberAccessibilityConfiguration | null

Require consistent accessibility modifiers on class properties and methods. See https://biomejs.dev/linter/rules/use-consistent-member-accessibility

useConsistentObjectDefinitions UseConsistentObjectDefinitionsConfiguration | null

Require the consistent declaration of object literals. Defaults to explicit definitions. See https://biomejs.dev/linter/rules/use-consistent-object-definitions

useConsistentTypeDefinitions UseConsistentTypeDefinitionsConfiguration | null

Enforce type definitions to consistently use either interface or type. See https://biomejs.dev/linter/rules/use-consistent-type-definitions

useConst UseConstConfiguration | null

Require const declarations for variables that are only assigned once. See https://biomejs.dev/linter/rules/use-const

useDefaultParameterLast UseDefaultParameterLastConfiguration | null

Enforce default function parameters and optional function parameters to be last. See https://biomejs.dev/linter/rules/use-default-parameter-last

useDefaultSwitchClause UseDefaultSwitchClauseConfiguration | null

Require the default clause in switch statements. See https://biomejs.dev/linter/rules/use-default-switch-clause

useDeprecatedReason UseDeprecatedReasonConfiguration | null

Require specifying the reason argument when using @deprecated directive. See https://biomejs.dev/linter/rules/use-deprecated-reason

useEnumInitializers UseEnumInitializersConfiguration | null

Require that each enum member value be explicitly initialized. See https://biomejs.dev/linter/rules/use-enum-initializers

useExplicitLengthCheck UseExplicitLengthCheckConfiguration | null

Enforce explicitly comparing the length, size, byteLength or byteOffset property of a value. See https://biomejs.dev/linter/rules/use-explicit-length-check

useExponentiationOperator UseExponentiationOperatorConfiguration | null

Disallow the use of Math.pow in favor of the ** operator. See https://biomejs.dev/linter/rules/use-exponentiation-operator

useExportType UseExportTypeConfiguration | null

Promotes the use of export type for types. See https://biomejs.dev/linter/rules/use-export-type

useExportsLast UseExportsLastConfiguration | null

Require that all exports are declared after all non-export statements. See https://biomejs.dev/linter/rules/use-exports-last

useFilenamingConvention UseFilenamingConventionConfiguration | null

Enforce naming conventions for JavaScript and TypeScript filenames. See https://biomejs.dev/linter/rules/use-filenaming-convention

useForOf UseForOfConfiguration | null

Prefer using for...of loops over standard for loops where possible. See https://biomejs.dev/linter/rules/use-for-of

useFragmentSyntax UseFragmentSyntaxConfiguration | null

This rule enforces the use of <>...</> over <Fragment>...</Fragment>. See https://biomejs.dev/linter/rules/use-fragment-syntax

useGraphqlNamingConvention UseGraphqlNamingConventionConfiguration | null

Validates that all enum values are capitalized. See https://biomejs.dev/linter/rules/use-graphql-naming-convention

useGroupedAccessorPairs UseGroupedAccessorPairsConfiguration | null

Enforce that getters and setters for the same property are adjacent in class and object definitions. See https://biomejs.dev/linter/rules/use-grouped-accessor-pairs

useImportType UseImportTypeConfiguration | null

Promotes the use of import type for types. See https://biomejs.dev/linter/rules/use-import-type

useLiteralEnumMembers UseLiteralEnumMembersConfiguration | null

Require all enum members to be literal values. See https://biomejs.dev/linter/rules/use-literal-enum-members

useNamingConvention UseNamingConventionConfiguration | null

Enforce naming conventions for everything across a codebase. See https://biomejs.dev/linter/rules/use-naming-convention

useNodeAssertStrict UseNodeAssertStrictConfiguration | null

Promotes the usage of node:assert/strict over node:assert. See https://biomejs.dev/linter/rules/use-node-assert-strict

useNodejsImportProtocol UseNodejsImportProtocolConfiguration | null

Enforces using the node: protocol for Node.js builtin modules. See https://biomejs.dev/linter/rules/use-nodejs-import-protocol

useNumberNamespace UseNumberNamespaceConfiguration | null

Use the Number properties instead of global ones. See https://biomejs.dev/linter/rules/use-number-namespace

useNumericSeparators UseNumericSeparatorsConfiguration | null

Enforce the use of numeric separators in numeric literals. See https://biomejs.dev/linter/rules/use-numeric-separators

useObjectSpread UseObjectSpreadConfiguration | null

Prefer object spread over Object.assign() when constructing new objects. See https://biomejs.dev/linter/rules/use-object-spread

useReactFunctionComponents UseReactFunctionComponentsConfiguration | null

Enforce that components are defined as functions and never as classes. See https://biomejs.dev/linter/rules/use-react-function-components

useReadonlyClassProperties UseReadonlyClassPropertiesConfiguration | null

Enforce marking members as readonly if they are never modified outside the constructor. See https://biomejs.dev/linter/rules/use-readonly-class-properties

useSelfClosingElements UseSelfClosingElementsConfiguration | null

Prevent extra closing tags for components without children. See https://biomejs.dev/linter/rules/use-self-closing-elements

useShorthandAssign UseShorthandAssignConfiguration | null

Require assignment operator shorthand where possible. See https://biomejs.dev/linter/rules/use-shorthand-assign

useShorthandFunctionType UseShorthandFunctionTypeConfiguration | null

Enforce using function types instead of object type with call signatures. See https://biomejs.dev/linter/rules/use-shorthand-function-type

useSingleVarDeclarator UseSingleVarDeclaratorConfiguration | null

Disallow multiple variable declarations in the same variable statement. See https://biomejs.dev/linter/rules/use-single-var-declarator

useSymbolDescription UseSymbolDescriptionConfiguration | null

Require a description parameter for the Symbol(). See https://biomejs.dev/linter/rules/use-symbol-description

useTemplate UseTemplateConfiguration | null

Prefer template literals over string concatenation. See https://biomejs.dev/linter/rules/use-template

useThrowNewError UseThrowNewErrorConfiguration | null

Require new when throwing an error. See https://biomejs.dev/linter/rules/use-throw-new-error

useThrowOnlyError UseThrowOnlyErrorConfiguration | null

Disallow throwing non-Error values. See https://biomejs.dev/linter/rules/use-throw-only-error

useTrimStartEnd UseTrimStartEndConfiguration | null

Enforce the use of String.trimStart() and String.trimEnd() over String.trimLeft() and String.trimRight(). See https://biomejs.dev/linter/rules/use-trim-start-end

useUnifiedTypeSignatures UseUnifiedTypeSignaturesConfiguration | null

Disallow overload signatures that can be unified into a single signature. See https://biomejs.dev/linter/rules/use-unified-type-signatures

Suspicious object

A list of rules that belong to this group

noAlert NoAlertConfiguration | null

Disallow the use of alert, confirm, and prompt. See https://biomejs.dev/linter/rules/no-alert

noApproximativeNumericConstant NoApproximativeNumericConstantConfiguration | null

Use standard constants instead of approximated literals. See https://biomejs.dev/linter/rules/no-approximative-numeric-constant

noArrayIndexKey NoArrayIndexKeyConfiguration | null

Discourage the usage of Array index in keys. See https://biomejs.dev/linter/rules/no-array-index-key

noAssignInExpressions NoAssignInExpressionsConfiguration | null

Disallow assignments in expressions. See https://biomejs.dev/linter/rules/no-assign-in-expressions

noAsyncPromiseExecutor NoAsyncPromiseExecutorConfiguration | null

Disallows using an async function as a Promise executor. See https://biomejs.dev/linter/rules/no-async-promise-executor

noBiomeFirstException NoBiomeFirstExceptionConfiguration | null

Prevents the misuse of glob patterns inside the files.includes field. See https://biomejs.dev/linter/rules/no-biome-first-exception

noBitwiseOperators NoBitwiseOperatorsConfiguration | null
noCatchAssign NoCatchAssignConfiguration | null

Disallow reassigning exceptions in catch clauses. See https://biomejs.dev/linter/rules/no-catch-assign

noClassAssign NoClassAssignConfiguration | null

Disallow reassigning class members. See https://biomejs.dev/linter/rules/no-class-assign

noCommentText NoCommentTextConfiguration | null

Prevent comments from being inserted as text nodes. See https://biomejs.dev/linter/rules/no-comment-text

noCompareNegZero NoCompareNegZeroConfiguration | null

Disallow comparing against -0. See https://biomejs.dev/linter/rules/no-compare-neg-zero

noConfusingLabels NoConfusingLabelsConfiguration | null

Disallow labeled statements that are not loops. See https://biomejs.dev/linter/rules/no-confusing-labels

noConfusingVoidType NoConfusingVoidTypeConfiguration | null

Disallow void type outside of generic or return types. See https://biomejs.dev/linter/rules/no-confusing-void-type

noConsole NoConsoleConfiguration | null

Disallow the use of console. See https://biomejs.dev/linter/rules/no-console

noConstEnum NoConstEnumConfiguration | null

Disallow TypeScript const enum. See https://biomejs.dev/linter/rules/no-const-enum

noConstantBinaryExpressions NoConstantBinaryExpressionsConfiguration | null

Disallow expressions where the operation doesn't affect the value. See https://biomejs.dev/linter/rules/no-constant-binary-expressions

noControlCharactersInRegex NoControlCharactersInRegexConfiguration | null

Prevents from having control characters and some escape sequences that match control characters in regular expression literals. See https://biomejs.dev/linter/rules/no-control-characters-in-regex

noDebugger NoDebuggerConfiguration | null

Disallow the use of debugger. See https://biomejs.dev/linter/rules/no-debugger

noDocumentCookie NoDocumentCookieConfiguration | null

Disallow direct assignments to document.cookie. See https://biomejs.dev/linter/rules/no-document-cookie

noDocumentImportInPage NoDocumentImportInPageConfiguration | null

Prevents importing next/document outside of pages/_document.jsx in Next.js projects. See https://biomejs.dev/linter/rules/no-document-import-in-page

noDoubleEquals NoDoubleEqualsConfiguration | null

Require the use of === and !==. See https://biomejs.dev/linter/rules/no-double-equals

noDuplicateAtImportRules NoDuplicateAtImportRulesConfiguration | null
noDuplicateCase NoDuplicateCaseConfiguration | null

Disallow duplicate case labels. See https://biomejs.dev/linter/rules/no-duplicate-case

noDuplicateClassMembers NoDuplicateClassMembersConfiguration | null
noDuplicateCustomProperties NoDuplicateCustomPropertiesConfiguration | null

Disallow duplicate custom properties within declaration blocks. See https://biomejs.dev/linter/rules/no-duplicate-custom-properties

noDuplicateElseIf NoDuplicateElseIfConfiguration | null

Disallow duplicate conditions in if-else-if chains. See https://biomejs.dev/linter/rules/no-duplicate-else-if

noDuplicateFields NoDuplicateFieldsConfiguration | null

No duplicated fields in GraphQL operations. See https://biomejs.dev/linter/rules/no-duplicate-fields

noDuplicateFontNames NoDuplicateFontNamesConfiguration | null

Disallow duplicate names within font families. See https://biomejs.dev/linter/rules/no-duplicate-font-names

noDuplicateJsxProps NoDuplicateJsxPropsConfiguration | null

Prevents JSX properties to be assigned multiple times. See https://biomejs.dev/linter/rules/no-duplicate-jsx-props

noDuplicateObjectKeys NoDuplicateObjectKeysConfiguration | null

Disallow two keys with the same name inside objects. See https://biomejs.dev/linter/rules/no-duplicate-object-keys

noDuplicateParameters NoDuplicateParametersConfiguration | null

Disallow duplicate function parameter name. See https://biomejs.dev/linter/rules/no-duplicate-parameters

noDuplicateProperties NoDuplicatePropertiesConfiguration | null

Disallow duplicate properties within declaration blocks. See https://biomejs.dev/linter/rules/no-duplicate-properties

noDuplicateSelectorsKeyframeBlock NoDuplicateSelectorsKeyframeBlockConfiguration | null

Disallow duplicate selectors within keyframe blocks. See https://biomejs.dev/linter/rules/no-duplicate-selectors-keyframe-block

noDuplicateTestHooks NoDuplicateTestHooksConfiguration | null

A describe block should not contain duplicate hooks. See https://biomejs.dev/linter/rules/no-duplicate-test-hooks

noEmptyBlock NoEmptyBlockConfiguration | null

Disallow CSS empty blocks. See https://biomejs.dev/linter/rules/no-empty-block

noEmptyBlockStatements NoEmptyBlockStatementsConfiguration | null

Disallow empty block statements and static blocks. See https://biomejs.dev/linter/rules/no-empty-block-statements

noEmptyInterface NoEmptyInterfaceConfiguration | null

Disallow the declaration of empty interfaces. See https://biomejs.dev/linter/rules/no-empty-interface

noEvolvingTypes NoEvolvingTypesConfiguration | null

Disallow variables from evolving into any type through reassignments. See https://biomejs.dev/linter/rules/no-evolving-types

noExplicitAny NoExplicitAnyConfiguration | null

Disallow the any type usage. See https://biomejs.dev/linter/rules/no-explicit-any

noExportsInTest NoExportsInTestConfiguration | null

Disallow using export or module.exports in files containing tests. See https://biomejs.dev/linter/rules/no-exports-in-test

noExtraNonNullAssertion NoExtraNonNullAssertionConfiguration | null

Prevents the wrong usage of the non-null assertion operator (!) in TypeScript files. See https://biomejs.dev/linter/rules/no-extra-non-null-assertion

noFallthroughSwitchClause NoFallthroughSwitchClauseConfiguration | null

Disallow fallthrough of switch clauses. See https://biomejs.dev/linter/rules/no-fallthrough-switch-clause

noFocusedTests NoFocusedTestsConfiguration | null
noFunctionAssign NoFunctionAssignConfiguration | null

Disallow reassigning function declarations. See https://biomejs.dev/linter/rules/no-function-assign

noGlobalAssign NoGlobalAssignConfiguration | null

Disallow assignments to native objects and read-only global variables. See https://biomejs.dev/linter/rules/no-global-assign

noGlobalIsFinite NoGlobalIsFiniteConfiguration | null

Use Number.isFinite instead of global isFinite. See https://biomejs.dev/linter/rules/no-global-is-finite

noGlobalIsNan NoGlobalIsNanConfiguration | null

Use Number.isNaN instead of global isNaN. See https://biomejs.dev/linter/rules/no-global-is-nan

noHeadImportInDocument NoHeadImportInDocumentConfiguration | null

Prevent using the next/head module in pages/_document.js on Next.js projects. See https://biomejs.dev/linter/rules/no-head-import-in-document

noImplicitAnyLet NoImplicitAnyLetConfiguration | null

Disallow use of implicit any type on variable declarations. See https://biomejs.dev/linter/rules/no-implicit-any-let

noImportAssign NoImportAssignConfiguration | null

Disallow assigning to imported bindings. See https://biomejs.dev/linter/rules/no-import-assign

noImportantInKeyframe NoImportantInKeyframeConfiguration | null

Disallow invalid !important within keyframe declarations. See https://biomejs.dev/linter/rules/no-important-in-keyframe

noIrregularWhitespace NoIrregularWhitespaceConfiguration | null

Disallows the use of irregular whitespace characters. See https://biomejs.dev/linter/rules/no-irregular-whitespace

noLabelVar NoLabelVarConfiguration | null

Disallow labels that share a name with a variable. See https://biomejs.dev/linter/rules/no-label-var

noMisleadingCharacterClass NoMisleadingCharacterClassConfiguration | null

Disallow characters made with multiple code points in character class syntax. See https://biomejs.dev/linter/rules/no-misleading-character-class

noMisleadingInstantiator NoMisleadingInstantiatorConfiguration | null

Enforce proper usage of new and constructor. See https://biomejs.dev/linter/rules/no-misleading-instantiator

noMisplacedAssertion NoMisplacedAssertionConfiguration | null

Checks that the assertion function, for example expect, is placed inside an it() function call. See https://biomejs.dev/linter/rules/no-misplaced-assertion

noMisrefactoredShorthandAssign NoMisrefactoredShorthandAssignConfiguration | null

Disallow shorthand assign when variable appears on both sides. See https://biomejs.dev/linter/rules/no-misrefactored-shorthand-assign

noNonNullAssertedOptionalChain NoNonNullAssertedOptionalChainConfiguration | null

Disallow non-null assertions after optional chaining expressions. See https://biomejs.dev/linter/rules/no-non-null-asserted-optional-chain

noOctalEscape NoOctalEscapeConfiguration | null

Disallow octal escape sequences in string literals. See https://biomejs.dev/linter/rules/no-octal-escape

noPrototypeBuiltins NoPrototypeBuiltinsConfiguration | null

Disallow direct use of Object.prototype builtins. See https://biomejs.dev/linter/rules/no-prototype-builtins

noQuickfixBiome NoQuickfixBiomeConfiguration | null

Disallow the use if quickfix.biome inside editor settings file. See https://biomejs.dev/linter/rules/no-quickfix-biome

noReactSpecificProps NoReactSpecificPropsConfiguration | null

Prevents React-specific JSX properties from being used. See https://biomejs.dev/linter/rules/no-react-specific-props

noRedeclare NoRedeclareConfiguration | null

Disallow variable, function, class, and type redeclarations in the same scope. See https://biomejs.dev/linter/rules/no-redeclare

noRedundantUseStrict NoRedundantUseStrictConfiguration | null

Prevents from having redundant "use strict". See https://biomejs.dev/linter/rules/no-redundant-use-strict

noSelfCompare NoSelfCompareConfiguration | null

Disallow comparisons where both sides are exactly the same. See https://biomejs.dev/linter/rules/no-self-compare

noShadowRestrictedNames NoShadowRestrictedNamesConfiguration | null

Disallow identifiers from shadowing restricted names. See https://biomejs.dev/linter/rules/no-shadow-restricted-names

noShorthandPropertyOverrides NoShorthandPropertyOverridesConfiguration | null

Disallow shorthand properties that override related longhand properties. See https://biomejs.dev/linter/rules/no-shorthand-property-overrides

noSkippedTests NoSkippedTestsConfiguration | null
noSparseArray NoSparseArrayConfiguration | null

Prevents the use of sparse arrays (arrays with holes). See https://biomejs.dev/linter/rules/no-sparse-array

noSuspiciousSemicolonInJsx NoSuspiciousSemicolonInJsxConfiguration | null

It detects possible "wrong" semicolons inside JSX elements. See https://biomejs.dev/linter/rules/no-suspicious-semicolon-in-jsx

noTemplateCurlyInString NoTemplateCurlyInStringConfiguration | null

Disallow template literal placeholder syntax in regular strings. See https://biomejs.dev/linter/rules/no-template-curly-in-string

noThenProperty NoThenPropertyConfiguration | null
noTsIgnore NoTsIgnoreConfiguration | null

Prevents the use of the TypeScript directive @ts-ignore. See https://biomejs.dev/linter/rules/no-ts-ignore

noUnassignedVariables NoUnassignedVariablesConfiguration | null

Disallow let or var variables that are read but never assigned. See https://biomejs.dev/linter/rules/no-unassigned-variables

noUnknownAtRules NoUnknownAtRulesConfiguration | null
noUnsafeDeclarationMerging NoUnsafeDeclarationMergingConfiguration | null

Disallow unsafe declaration merging between interfaces and classes. See https://biomejs.dev/linter/rules/no-unsafe-declaration-merging

noUnsafeNegation NoUnsafeNegationConfiguration | null

Disallow using unsafe negation. See https://biomejs.dev/linter/rules/no-unsafe-negation

noUselessEscapeInString NoUselessEscapeInStringConfiguration | null

Disallow unnecessary escapes in string literals. See https://biomejs.dev/linter/rules/no-useless-escape-in-string

noUselessRegexBackrefs NoUselessRegexBackrefsConfiguration | null

Disallow useless backreferences in regular expression literals that always match an empty string. See https://biomejs.dev/linter/rules/no-useless-regex-backrefs

noVar NoVarConfiguration | null

Disallow the use of var. See https://biomejs.dev/linter/rules/no-var

noWith NoWithConfiguration | null

Disallow with statements in non-strict contexts. See https://biomejs.dev/linter/rules/no-with

recommended boolean | null

Enables the recommended rules for this group

useAdjacentOverloadSignatures UseAdjacentOverloadSignaturesConfiguration | null

Disallow the use of overload signatures that are not next to each other. See https://biomejs.dev/linter/rules/use-adjacent-overload-signatures

useAwait UseAwaitConfiguration | null

Ensure async functions utilize await. See https://biomejs.dev/linter/rules/use-await

useBiomeIgnoreFolder UseBiomeIgnoreFolderConfiguration | null

Promotes the correct usage for ignoring folders in the configuration file. See https://biomejs.dev/linter/rules/use-biome-ignore-folder

useDefaultSwitchClauseLast UseDefaultSwitchClauseLastConfiguration | null

Enforce default clauses in switch statements to be last. See https://biomejs.dev/linter/rules/use-default-switch-clause-last

useErrorMessage UseErrorMessageConfiguration | null

Enforce passing a message value when creating a built-in error. See https://biomejs.dev/linter/rules/use-error-message

useGetterReturn UseGetterReturnConfiguration | null

Enforce get methods to always return a value. See https://biomejs.dev/linter/rules/use-getter-return

useGoogleFontDisplay UseGoogleFontDisplayConfiguration | null

Enforces the use of a recommended display strategy with Google Fonts. See https://biomejs.dev/linter/rules/use-google-font-display

useGuardForIn UseGuardForInConfiguration | null

Require for-in loops to include an if statement. See https://biomejs.dev/linter/rules/use-guard-for-in

useIsArray UseIsArrayConfiguration | null

Use Array.isArray() instead of instanceof Array. See https://biomejs.dev/linter/rules/use-is-array

useIterableCallbackReturn UseIterableCallbackReturnConfiguration | null

Enforce consistent return values in iterable callbacks. See https://biomejs.dev/linter/rules/use-iterable-callback-return

useNamespaceKeyword UseNamespaceKeywordConfiguration | null

Require using the namespace keyword over the module keyword to declare TypeScript namespaces. See https://biomejs.dev/linter/rules/use-namespace-keyword

useNumberToFixedDigitsArgument UseNumberToFixedDigitsArgumentConfiguration | null

Enforce using the digits argument with Number#toFixed(). See https://biomejs.dev/linter/rules/use-number-to-fixed-digits-argument

useStaticResponseMethods UseStaticResponseMethodsConfiguration | null

Use static Response methods instead of new Response() constructor when possible. See https://biomejs.dev/linter/rules/use-static-response-methods

useStrictMode UseStrictModeConfiguration | null

Enforce the use of the directive "use strict" in script files. See https://biomejs.dev/linter/rules/use-strict-mode

UseAdjacentOverloadSignaturesConfiguration RulePlainConfiguration | RuleWithUseAdjacentOverloadSignaturesOptions
UseAdjacentOverloadSignaturesOptions object
UseAltTextConfiguration RulePlainConfiguration | RuleWithUseAltTextOptions
UseAltTextOptions object
UseAnchorContentConfiguration RulePlainConfiguration | RuleWithUseAnchorContentOptions
UseAnchorContentOptions object
UseAriaActivedescendantWithTabindexConfiguration RulePlainConfiguration | RuleWithUseAriaActivedescendantWithTabindexOptions
UseAriaActivedescendantWithTabindexOptions object
UseAriaPropsForRoleConfiguration RulePlainConfiguration | RuleWithUseAriaPropsForRoleOptions
UseAriaPropsForRoleOptions object
UseAriaPropsSupportedByRoleConfiguration RulePlainConfiguration | RuleWithUseAriaPropsSupportedByRoleOptions
UseAriaPropsSupportedByRoleOptions object
UseArrayLiteralsConfiguration RulePlainConfiguration | RuleWithUseArrayLiteralsOptions
UseArrayLiteralsOptions object
UseArraySortCompareConfiguration RulePlainConfiguration | RuleWithUseArraySortCompareOptions
UseArraySortCompareOptions object
UseArrowFunctionConfiguration RulePlainConfiguration | RuleWithUseArrowFunctionOptions
UseArrowFunctionOptions object
UseAsConstAssertionConfiguration RulePlainConfiguration | RuleWithUseAsConstAssertionOptions
UseAsConstAssertionOptions object
UseAtIndexConfiguration RulePlainConfiguration | RuleWithUseAtIndexOptions
UseAtIndexOptions object
UseAwaitConfiguration RulePlainConfiguration | RuleWithUseAwaitOptions
UseAwaitOptions object
UseAwaitThenableConfiguration RulePlainConfiguration | RuleWithUseAwaitThenableOptions
UseAwaitThenableOptions object
UseBiomeIgnoreFolderConfiguration RulePlainConfiguration | RuleWithUseBiomeIgnoreFolderOptions
UseBiomeIgnoreFolderOptions object
UseBlockStatementsConfiguration RulePlainConfiguration | RuleWithUseBlockStatementsOptions
UseBlockStatementsOptions object
UseButtonTypeConfiguration RulePlainConfiguration | RuleWithUseButtonTypeOptions
UseButtonTypeOptions object
UseCollapsedElseIfConfiguration RulePlainConfiguration | RuleWithUseCollapsedElseIfOptions
UseCollapsedElseIfOptions object
UseCollapsedIfConfiguration RulePlainConfiguration | RuleWithUseCollapsedIfOptions
UseCollapsedIfOptions object
UseComponentExportOnlyModulesConfiguration RulePlainConfiguration | RuleWithUseComponentExportOnlyModulesOptions
UseComponentExportOnlyModulesOptions object
allowConstantExport boolean | null

Allows the export of constants. This option is for environments that support it, such as Vite

Default: null
allowExportNames array | null

A list of names that can be additionally exported from the module This option is for exports that do not hinder React Fast Refresh, such as meta in Remix

UseConsistentArrayTypeConfiguration RulePlainConfiguration | RuleWithUseConsistentArrayTypeOptions
UseConsistentArrayTypeOptions object
syntax ConsistentArrayType | null
UseConsistentArrowReturnConfiguration RulePlainConfiguration | RuleWithUseConsistentArrowReturnOptions
UseConsistentArrowReturnOptions object

Options for the useConsistentArrowReturn rule.

requireForObjectLiteral boolean | null

Determines whether the rule enforces a consistent style when the return value is an object literal.

This option is only applicable when used in conjunction with the asNeeded option.

The style to enforce for arrow function return statements.

UseConsistentArrowReturnStyle string | string | string
UseConsistentBuiltinInstantiationConfiguration RulePlainConfiguration | RuleWithUseConsistentBuiltinInstantiationOptions
UseConsistentBuiltinInstantiationOptions object
UseConsistentCurlyBracesConfiguration RulePlainConfiguration | RuleWithUseConsistentCurlyBracesOptions
UseConsistentCurlyBracesOptions object
UseConsistentGraphqlDescriptionsConfiguration RulePlainConfiguration | RuleWithUseConsistentGraphqlDescriptionsOptions
UseConsistentGraphqlDescriptionsOptions object

The description style to enforce. Defaults to "block"

Default: null
UseConsistentGraphqlDescriptionsStyle string

The GraphQL description style to enforce.

UseConsistentMemberAccessibilityConfiguration RulePlainConfiguration | RuleWithUseConsistentMemberAccessibilityOptions
UseConsistentMemberAccessibilityOptions object
accessibility Accessibility | null

The kind of accessibility you want to enforce. Default to "noPublic"

UseConsistentObjectDefinitionsConfiguration RulePlainConfiguration | RuleWithUseConsistentObjectDefinitionsOptions
UseConsistentObjectDefinitionsOptions object
syntax ObjectPropertySyntax | null

The preferred syntax to enforce.

UseConsistentTypeDefinitionsConfiguration RulePlainConfiguration | RuleWithUseConsistentTypeDefinitionsOptions
UseConsistentTypeDefinitionsOptions object
UseConstConfiguration RulePlainConfiguration | RuleWithUseConstOptions
UseConstOptions object
UseDateNowConfiguration RulePlainConfiguration | RuleWithUseDateNowOptions
UseDateNowOptions object
UseDefaultParameterLastConfiguration RulePlainConfiguration | RuleWithUseDefaultParameterLastOptions
UseDefaultParameterLastOptions object
UseDefaultSwitchClauseConfiguration RulePlainConfiguration | RuleWithUseDefaultSwitchClauseOptions
UseDefaultSwitchClauseLastConfiguration RulePlainConfiguration | RuleWithUseDefaultSwitchClauseLastOptions
UseDefaultSwitchClauseLastOptions object
UseDefaultSwitchClauseOptions object
UseDeprecatedDateConfiguration RulePlainConfiguration | RuleWithUseDeprecatedDateOptions
UseDeprecatedDateOptions object
argumentName string | null
UseDeprecatedReasonConfiguration RulePlainConfiguration | RuleWithUseDeprecatedReasonOptions
UseDeprecatedReasonOptions object
UseDestructuringConfiguration RulePlainConfiguration | RuleWithUseDestructuringOptions
UseDestructuringOptions object
UseEnumInitializersConfiguration RulePlainConfiguration | RuleWithUseEnumInitializersOptions
UseEnumInitializersOptions object
UseErrorMessageConfiguration RulePlainConfiguration | RuleWithUseErrorMessageOptions
UseErrorMessageOptions object
UseExhaustiveDependenciesConfiguration RulePlainConfiguration | RuleWithUseExhaustiveDependenciesOptions
UseExhaustiveDependenciesOptions object
hooks array | null

List of hooks of which the dependencies should be validated.

reportMissingDependenciesArray boolean | null

Whether to report an error when a hook has no dependencies array.

reportUnnecessaryDependencies boolean | null

Whether to report an error when a dependency is listed in the dependencies array but isn't used. Defaults to true.

UseExhaustiveSwitchCasesConfiguration RulePlainConfiguration | RuleWithUseExhaustiveSwitchCasesOptions
UseExhaustiveSwitchCasesOptions object
UseExplicitLengthCheckConfiguration RulePlainConfiguration | RuleWithUseExplicitLengthCheckOptions
UseExplicitLengthCheckOptions object
UseExplicitTypeConfiguration RulePlainConfiguration | RuleWithUseExplicitTypeOptions
UseExplicitTypeOptions object
UseExponentiationOperatorConfiguration RulePlainConfiguration | RuleWithUseExponentiationOperatorOptions
UseExponentiationOperatorOptions object
UseExportTypeConfiguration RulePlainConfiguration | RuleWithUseExportTypeOptions
UseExportTypeOptions object
UseExportsLastConfiguration RulePlainConfiguration | RuleWithUseExportsLastOptions
UseExportsLastOptions object
UseFilenamingConventionConfiguration RulePlainConfiguration | RuleWithUseFilenamingConventionOptions
UseFilenamingConventionOptions object
filenameCases FilenameCases | null

Allowed cases for file names.

match Regex | null

Regular expression to enforce

requireAscii boolean | null

If false, then non-ASCII characters are allowed.

strictCase boolean | null

If false, then consecutive uppercase are allowed in camel and pascal cases. This does not affect other [Case].

UseFindConfiguration RulePlainConfiguration | RuleWithUseFindOptions
UseFindOptions object
UseFlatMapConfiguration RulePlainConfiguration | RuleWithUseFlatMapOptions
UseFlatMapOptions object
UseFocusableInteractiveConfiguration RulePlainConfiguration | RuleWithUseFocusableInteractiveOptions
UseFocusableInteractiveOptions object
UseForOfConfiguration RulePlainConfiguration | RuleWithUseForOfOptions
UseForOfOptions object
UseFragmentSyntaxConfiguration RulePlainConfiguration | RuleWithUseFragmentSyntaxOptions
UseFragmentSyntaxOptions object
UseGenericFontNamesConfiguration RulePlainConfiguration | RuleWithUseGenericFontNamesOptions
UseGenericFontNamesOptions object
UseGetterReturnConfiguration RulePlainConfiguration | RuleWithUseGetterReturnOptions
UseGetterReturnOptions object
UseGoogleFontDisplayConfiguration RulePlainConfiguration | RuleWithUseGoogleFontDisplayOptions
UseGoogleFontDisplayOptions object
UseGoogleFontPreconnectConfiguration RulePlainConfiguration | RuleWithUseGoogleFontPreconnectOptions
UseGoogleFontPreconnectOptions object
UseGraphqlNamedOperationsConfiguration RulePlainConfiguration | RuleWithUseGraphqlNamedOperationsOptions
UseGraphqlNamedOperationsOptions object
UseGraphqlNamingConventionConfiguration RulePlainConfiguration | RuleWithUseGraphqlNamingConventionOptions
UseGraphqlNamingConventionOptions object
UseGroupedAccessorPairsConfiguration RulePlainConfiguration | RuleWithUseGroupedAccessorPairsOptions
UseGroupedAccessorPairsOptions object
UseGuardForInConfiguration RulePlainConfiguration | RuleWithUseGuardForInOptions
UseGuardForInOptions object
UseHeadingContentConfiguration RulePlainConfiguration | RuleWithUseHeadingContentOptions
UseHeadingContentOptions object
UseHookAtTopLevelConfiguration RulePlainConfiguration | RuleWithUseHookAtTopLevelOptions
UseHookAtTopLevelOptions object
UseHtmlLangConfiguration RulePlainConfiguration | RuleWithUseHtmlLangOptions
UseHtmlLangOptions object
UseIframeTitleConfiguration RulePlainConfiguration | RuleWithUseIframeTitleOptions
UseIframeTitleOptions object
UseImageSizeConfiguration RulePlainConfiguration | RuleWithUseImageSizeOptions
UseImageSizeOptions null
UseImportExtensionsConfiguration RulePlainConfiguration | RuleWithUseImportExtensionsOptions
UseImportExtensionsOptions object
forceJsExtensions boolean | null

If true, the suggested extension is always .js regardless of what extension the source file has in your project.

UseImportTypeConfiguration RulePlainConfiguration | RuleWithUseImportTypeOptions
UseImportTypeOptions object
style UseImportTypeStyle | null

The style to apply when import types. Default to "auto"

UseImportTypeStyle string

The style to apply when importing types.

UseIndexOfConfiguration RulePlainConfiguration | RuleWithUseIndexOfOptions
UseIndexOfOptions object
UseIsArrayConfiguration RulePlainConfiguration | RuleWithUseIsArrayOptions
UseIsArrayOptions object
UseIsNanConfiguration RulePlainConfiguration | RuleWithUseIsNanOptions
UseIsNanOptions object
UseIterableCallbackReturnConfiguration RulePlainConfiguration | RuleWithUseIterableCallbackReturnOptions
UseIterableCallbackReturnOptions object
UseJsonImportAttributesConfiguration RulePlainConfiguration | RuleWithUseJsonImportAttributesOptions
UseJsonImportAttributesOptions object
UseJsxKeyInIterableConfiguration RulePlainConfiguration | RuleWithUseJsxKeyInIterableOptions
UseJsxKeyInIterableOptions object
checkShorthandFragments boolean | null

Set to true to check shorthand fragments (<></>)

UseKeyWithClickEventsConfiguration RulePlainConfiguration | RuleWithUseKeyWithClickEventsOptions
UseKeyWithClickEventsOptions object
UseKeyWithMouseEventsConfiguration RulePlainConfiguration | RuleWithUseKeyWithMouseEventsOptions
UseKeyWithMouseEventsOptions object
UseLiteralEnumMembersConfiguration RulePlainConfiguration | RuleWithUseLiteralEnumMembersOptions
UseLiteralEnumMembersOptions object
UseLiteralKeysConfiguration RulePlainConfiguration | RuleWithUseLiteralKeysOptions
UseLiteralKeysOptions object
UseMaxParamsConfiguration RulePlainConfiguration | RuleWithUseMaxParamsOptions
UseMaxParamsOptions object
max integer | null

Maximum number of parameters allowed (default: 4)

format=uint8min=0max=255
UseMediaCaptionConfiguration RulePlainConfiguration | RuleWithUseMediaCaptionOptions
UseMediaCaptionOptions object
UseNamespaceKeywordConfiguration RulePlainConfiguration | RuleWithUseNamespaceKeywordOptions
UseNamespaceKeywordOptions object
UseNamingConventionConfiguration RulePlainConfiguration | RuleWithUseNamingConventionOptions
UseNamingConventionOptions object

Rule's options.

conventions array | null

Custom conventions.

requireAscii boolean | null

If false, then non-ASCII characters are allowed.

strictCase boolean | null

If false, then consecutive uppercase are allowed in camel and pascal cases. This does not affect other [Case].

UseNodeAssertStrictConfiguration RulePlainConfiguration | RuleWithUseNodeAssertStrictOptions
UseNodeAssertStrictOptions object
UseNodejsImportProtocolConfiguration RulePlainConfiguration | RuleWithUseNodejsImportProtocolOptions
UseNodejsImportProtocolOptions object
UseNumberNamespaceConfiguration RulePlainConfiguration | RuleWithUseNumberNamespaceOptions
UseNumberNamespaceOptions object
UseNumberToFixedDigitsArgumentConfiguration RulePlainConfiguration | RuleWithUseNumberToFixedDigitsArgumentOptions
UseNumberToFixedDigitsArgumentOptions object
UseNumericLiteralsConfiguration RulePlainConfiguration | RuleWithUseNumericLiteralsOptions
UseNumericLiteralsOptions object
UseNumericSeparatorsConfiguration RulePlainConfiguration | RuleWithUseNumericSeparatorsOptions
UseNumericSeparatorsOptions object
UseObjectSpreadConfiguration RulePlainConfiguration | RuleWithUseObjectSpreadOptions
UseObjectSpreadOptions object
UseOptionalChainConfiguration RulePlainConfiguration | RuleWithUseOptionalChainOptions
UseOptionalChainOptions object
UseParseIntRadixConfiguration RulePlainConfiguration | RuleWithUseParseIntRadixOptions
UseParseIntRadixOptions object
UseQwikClasslistConfiguration RulePlainConfiguration | RuleWithUseQwikClasslistOptions
UseQwikClasslistOptions object
UseQwikMethodUsageConfiguration RulePlainConfiguration | RuleWithUseQwikMethodUsageOptions
UseQwikMethodUsageOptions object
UseQwikValidLexicalScopeConfiguration RulePlainConfiguration | RuleWithUseQwikValidLexicalScopeOptions
UseQwikValidLexicalScopeOptions object
UseReactFunctionComponentsConfiguration RulePlainConfiguration | RuleWithUseReactFunctionComponentsOptions
UseReactFunctionComponentsOptions object
UseReadonlyClassPropertiesConfiguration RulePlainConfiguration | RuleWithUseReadonlyClassPropertiesOptions
UseReadonlyClassPropertiesOptions object
checkAllProperties boolean | null

When true, the keywords public, protected, and private are analyzed by the rule.

UseRegexLiteralsConfiguration RulePlainConfiguration | RuleWithUseRegexLiteralsOptions
UseRegexLiteralsOptions object
UseRegexpExecConfiguration RulePlainConfiguration | RuleWithUseRegexpExecOptions
UseRegexpExecOptions object
UseRequiredScriptsConfiguration RulePlainConfiguration | RuleWithUseRequiredScriptsOptions
UseRequiredScriptsOptions object
requiredScripts string[]

List of script names that must be present in package.json

Default:
[]
UseSelfClosingElementsConfiguration RulePlainConfiguration | RuleWithUseSelfClosingElementsOptions
UseSelfClosingElementsOptions object
ignoreHtmlElements boolean | null
UseSemanticElementsConfiguration RulePlainConfiguration | RuleWithUseSemanticElementsOptions
UseSemanticElementsOptions object
UseShorthandAssignConfiguration RulePlainConfiguration | RuleWithUseShorthandAssignOptions
UseShorthandAssignOptions object
UseShorthandFunctionTypeConfiguration RulePlainConfiguration | RuleWithUseShorthandFunctionTypeOptions
UseShorthandFunctionTypeOptions object
UseSimpleNumberKeysConfiguration RulePlainConfiguration | RuleWithUseSimpleNumberKeysOptions
UseSimpleNumberKeysOptions object
UseSimplifiedLogicExpressionConfiguration RulePlainConfiguration | RuleWithUseSimplifiedLogicExpressionOptions
UseSimplifiedLogicExpressionOptions object
UseSingleJsDocAsteriskConfiguration RulePlainConfiguration | RuleWithUseSingleJsDocAsteriskOptions
UseSingleJsDocAsteriskOptions object
UseSingleVarDeclaratorConfiguration RulePlainConfiguration | RuleWithUseSingleVarDeclaratorOptions
UseSingleVarDeclaratorOptions object
UseSolidForComponentConfiguration RulePlainConfiguration | RuleWithUseSolidForComponentOptions
UseSolidForComponentOptions object
UseSortedAttributesConfiguration RuleAssistPlainConfiguration | RuleAssistWithUseSortedAttributesOptions
UseSortedAttributesOptions object
sortOrder SortOrder | null
UseSortedClassesConfiguration RulePlainConfiguration | RuleWithUseSortedClassesOptions
UseSortedClassesOptions object
attributes array | null

Additional attributes that will be sorted.

functions array | null

Names of the functions or tagged templates that will be sorted.

UseSortedKeysConfiguration RuleAssistPlainConfiguration | RuleAssistWithUseSortedKeysOptions
UseSortedKeysOptions object
sortOrder SortOrder | null
UseSortedPropertiesConfiguration RuleAssistPlainConfiguration | RuleAssistWithUseSortedPropertiesOptions
UseSortedPropertiesOptions object
UseSpreadConfiguration RulePlainConfiguration | RuleWithUseSpreadOptions
UseSpreadOptions object
UseStaticResponseMethodsConfiguration RulePlainConfiguration | RuleWithUseStaticResponseMethodsOptions
UseStaticResponseMethodsOptions object
UseStrictModeConfiguration RulePlainConfiguration | RuleWithUseStrictModeOptions
UseStrictModeOptions object
UseSymbolDescriptionConfiguration RulePlainConfiguration | RuleWithUseSymbolDescriptionOptions
UseSymbolDescriptionOptions object
UseTemplateConfiguration RulePlainConfiguration | RuleWithUseTemplateOptions
UseTemplateOptions object
UseThrowNewErrorConfiguration RulePlainConfiguration | RuleWithUseThrowNewErrorOptions
UseThrowNewErrorOptions object
UseThrowOnlyErrorConfiguration RulePlainConfiguration | RuleWithUseThrowOnlyErrorOptions
UseThrowOnlyErrorOptions object
UseTopLevelRegexConfiguration RulePlainConfiguration | RuleWithUseTopLevelRegexOptions
UseTopLevelRegexOptions object
UseTrimStartEndConfiguration RulePlainConfiguration | RuleWithUseTrimStartEndOptions
UseTrimStartEndOptions object
UseUnifiedTypeSignaturesConfiguration RulePlainConfiguration | RuleWithUseUnifiedTypeSignaturesOptions
UseUnifiedTypeSignaturesOptions object
UseUniqueArgumentNamesConfiguration RulePlainConfiguration | RuleWithUseUniqueArgumentNamesOptions
UseUniqueArgumentNamesOptions object
UseUniqueElementIdsConfiguration RulePlainConfiguration | RuleWithUseUniqueElementIdsOptions
UseUniqueElementIdsOptions object
excludedComponents array | null

Component names that accept an id prop that does not translate to a DOM element id.

uniqueItems=true
UseUniqueFieldDefinitionNamesConfiguration RulePlainConfiguration | RuleWithUseUniqueFieldDefinitionNamesOptions
UseUniqueFieldDefinitionNamesOptions object
UseUniqueGraphqlOperationNameConfiguration RulePlainConfiguration | RuleWithUseUniqueGraphqlOperationNameOptions
UseUniqueGraphqlOperationNameOptions object
UseUniqueInputFieldNamesConfiguration RulePlainConfiguration | RuleWithUseUniqueInputFieldNamesOptions
UseUniqueInputFieldNamesOptions object
UseUniqueVariableNamesConfiguration RulePlainConfiguration | RuleWithUseUniqueVariableNamesOptions
UseUniqueVariableNamesOptions object
UseValidAnchorConfiguration RulePlainConfiguration | RuleWithUseValidAnchorOptions
UseValidAnchorOptions object
UseValidAriaPropsConfiguration RulePlainConfiguration | RuleWithUseValidAriaPropsOptions
UseValidAriaPropsOptions object
UseValidAriaRoleConfiguration RulePlainConfiguration | RuleWithUseValidAriaRoleOptions
UseValidAriaRoleOptions object
allowInvalidRoles array | null

It allows specifying a list of roles that might be invalid otherwise

ignoreNonDom boolean | null

Use this option to ignore non-DOM elements, such as custom components

UseValidAriaValuesConfiguration RulePlainConfiguration | RuleWithUseValidAriaValuesOptions
UseValidAriaValuesOptions object
UseValidAutocompleteConfiguration RulePlainConfiguration | RuleWithUseValidAutocompleteOptions
UseValidAutocompleteOptions object
inputComponents array | null

input like custom components that should be checked.

UseValidForDirectionConfiguration RulePlainConfiguration | RuleWithUseValidForDirectionOptions
UseValidForDirectionOptions object
UseValidLangConfiguration RulePlainConfiguration | RuleWithUseValidLangOptions
UseValidLangOptions object
UseValidTypeofConfiguration RulePlainConfiguration | RuleWithUseValidTypeofOptions
UseValidTypeofOptions object
UseVueConsistentDefinePropsDeclarationConfiguration RulePlainConfiguration | RuleWithUseVueConsistentDefinePropsDeclarationOptions
UseVueConsistentDefinePropsDeclarationOptions object
style DeclarationStyle | null
UseVueConsistentVBindStyleConfiguration RulePlainConfiguration | RuleWithUseVueConsistentVBindStyleOptions
UseVueConsistentVBindStyleOptions object
style VueDirectiveStyle | null

Preferred style for v-bind usage: "shorthand" or "longhand". If omitted, shorthand is preferred.

UseVueConsistentVOnStyleConfiguration RulePlainConfiguration | RuleWithUseVueConsistentVOnStyleOptions
UseVueConsistentVOnStyleOptions object
style VueDirectiveStyle2 | null

Preferred style for v-on usage: "shorthand" or "longhand". If omitted, shorthand is preferred.

UseVueDefineMacrosOrderConfiguration RulePlainConfiguration | RuleWithUseVueDefineMacrosOrderOptions
UseVueDefineMacrosOrderOptions object
order array | null

The order of the Vue define macros.

UseVueHyphenatedAttributesConfiguration RulePlainConfiguration | RuleWithUseVueHyphenatedAttributesOptions
UseVueHyphenatedAttributesOptions object
ignore array | null

List of attribute names to ignore when checking for hyphenated attributes.

Default: null
uniqueItems=true
ignoreTags array | null

List of HTML tags to ignore when checking for hyphenated attributes.

Default: null
uniqueItems=true
UseVueMultiWordComponentNamesConfiguration RulePlainConfiguration | RuleWithUseVueMultiWordComponentNamesOptions
UseVueMultiWordComponentNamesOptions object
ignores string[]

Component names to ignore (allowed to be single-word).

UseVueVForKeyConfiguration RulePlainConfiguration | RuleWithUseVueVForKeyOptions
UseVueVForKeyOptions object
UseVueValidTemplateRootConfiguration RulePlainConfiguration | RuleWithUseVueValidTemplateRootOptions
UseVueValidTemplateRootOptions object
UseVueValidVBindConfiguration RulePlainConfiguration | RuleWithUseVueValidVBindOptions
UseVueValidVBindOptions object
UseVueValidVCloakConfiguration RulePlainConfiguration | RuleWithUseVueValidVCloakOptions
UseVueValidVCloakOptions object
UseVueValidVElseConfiguration RulePlainConfiguration | RuleWithUseVueValidVElseOptions
UseVueValidVElseIfConfiguration RulePlainConfiguration | RuleWithUseVueValidVElseIfOptions
UseVueValidVElseIfOptions object
UseVueValidVElseOptions object
UseVueValidVHtmlConfiguration RulePlainConfiguration | RuleWithUseVueValidVHtmlOptions
UseVueValidVHtmlOptions object
UseVueValidVIfConfiguration RulePlainConfiguration | RuleWithUseVueValidVIfOptions
UseVueValidVIfOptions object
UseVueValidVOnConfiguration RulePlainConfiguration | RuleWithUseVueValidVOnOptions
UseVueValidVOnOptions object
modifiers array | null

Additional modifiers that should be considered valid

Default: null
UseVueValidVOnceConfiguration RulePlainConfiguration | RuleWithUseVueValidVOnceOptions
UseVueValidVOnceOptions object
UseVueValidVPreConfiguration RulePlainConfiguration | RuleWithUseVueValidVPreOptions
UseVueValidVPreOptions object
UseVueValidVTextConfiguration RulePlainConfiguration | RuleWithUseVueValidVTextOptions
UseVueValidVTextOptions object
UseVueVaporConfiguration RulePlainConfiguration | RuleWithUseVueVaporOptions
UseVueVaporOptions object
UseWhileConfiguration RulePlainConfiguration | RuleWithUseWhileOptions
UseWhileOptions object
UseYieldConfiguration RulePlainConfiguration | RuleWithUseYieldOptions
UseYieldOptions object
VcsClientKind string
VcsConfiguration object

Set of properties to integrate Biome with a VCS software.

clientKind VcsClientKind | null

The kind of client.

defaultBranch string | null

The main branch of the project

enabled Bool | null

Whether Biome should integrate itself with the VCS client

root string | null

The folder where Biome should check for VCS files. By default, Biome will use the same folder where biome.json was found.

If Biome can't find the configuration, it will attempt to use the current working directory. If no current working directory can't be found, Biome won't use the VCS integration, and a diagnostic will be emitted

useIgnoreFile Bool | null

Whether Biome should use the VCS ignore file. When [true], Biome will ignore the files specified in the ignore file.

Visibility string
VueDirectiveStyle string
VueDirectiveStyle2 string
WhitespaceSensitivity string | string | string

Whitespace sensitivity for HTML formatting.

The following two cases won't produce the same output:

htmloutput
with spaces1<b> 2 </b>31 2 3
without spaces1<b>2</b>3123

This happens because whitespace is significant in inline elements.

As a consequence of this, the formatter must format blocks that look like this (assume a small line width, <20):

<span>really long content</span>

as this, where the content hugs the tags:

<span
   >really long content</span
>

Note that this is only necessary for inline elements. Block elements do not have this restriction.