chore(deps): update dependency @biomejs/biome to v2 #230
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^1.9.4->^2.0.0Release Notes
biomejs/biome (@biomejs/biome)
v2.0.0Compare Source
Major Changes
Biome now resolves globs and paths from the configuration. Before, paths and globs were resolved from the working directory.
Biome now raises a warning diagnostic for suppression comments that have
<explanation>as reason.<explanation>is provided as a placeholder when applying the suppression code fix from LSP editors.Removed the
--config-pathargument from thebiome lsp-proxyandbiome startcommands.The option was overriding the configuration path for all workspaces opened in the Biome daemon, which led to a configuration mismatch problem when multiple projects are opened in some editors or IDEs.
If you are using one of our official plugins for IDEs or editors, it is recommended to update it to the latest version of the plugin, or you will get unexpected behavior.
If you are a developer of a plugin, please update your plugin to use the
workspace/configurationresponse instead of using the--config-pathargument. Biome's LSP will resolve a configuration in the workspace automatically, so it is recommended to keep it empty unless you are using a custom configuration path.Downgraded some code fixes to unsafe which were previously safe.
The following rules have now a unsafe fix:
noFlatMapIdentitynoUnusedImportsIf you want to keep applying these fixes automatically, configure the rule fix as safe:
{ "linter": { "rules": { "correctness": { "noFlatMapIdentity": { "level": "error", "fix": "safe" }, "noUnusedImports": { "level": "error", "fix": "safe" } } } } }Previously the lint rules
noControlCharactersInRegexandnoMisleadingCharacterClasschecked both regular expression literals like/regex/and dynamically built regular expressions likenew RegExp("regex").Checking dynamically built regular expressions has many limitations, edge cases, and complexities.
In addition, other rules that lint regular expressions don't check dynamically built regular expressions.
Rather than add support for other rules and have half-baked checking, we decided to remove support for dynamically built regular expressions.
Now the lint rules
noControlCharactersInRegexandnoMisleadingCharacterClassonly check literals of regular expressions.The lint rule
noRestrictedGlobalsnow supports customizing message for each global name.For example, the following configuration:
{ "options": { "deniedGlobals": { "$": "jQuery is not allowed. Use native DOM manipulation instead." } } }emits a diagnostic:
Breaking Change: The option
deniedGlobalsis now a record instead of an array. Runbiome migrateto migrate the configuration automatically.Removed
includeandignorefields in favor of the new fieldincludes.The Biome configuration file allows users to specify which files should be processed using glob patterns.
Prior to Biome 2.0, this was done using the
includeandignorefields.In Biome 2.0,
includeandignoreare removed and replaced byincludes.You can run
biome migrateto convertincludeandignoreintoincludesautomatically.includesuses a different glob pattern format that fixes many issues and many other limitations that Biome users reported.includesaccepts an array of glob patterns.A glob pattern starting with a
!is a negated pattern also called exception.This replaces
ignorepatterns and allows users to create chains of include and ignore patterns.Thus, it is now possible to include again a file previously ignored.
This was not possible with
includeandignore, becauseignorehas priority overinclude.The semantics of
*and**/*have changed too.Before, with
includeandignore, the glob*was interpreted as**/*.Now, with
includes, the globs*and**/*are interpreted differently.The first pattern matches all files that are inside a folder.
The second pattern recursively matches all files and sub-folders inside a folder.
Let's take an example.
Given the following file hierarchy of a project...
...we want:
.test.js, exceptspecial.test.ts.testdirectory.The
testdirectory is located at the root of the project.srcdirectory, that don't end with.gen.js.The
srcdirectory is located at the root of the project.noDefaultExportlint rule on files ending with.ts.Prior to Biome 2.0, the configuration might look like:
{ "files": { "ignore": ["*.test.js", "test"] }, "linter": { "include": ["src/**"], "ignore": ["*.gen.js"], "enabled": true }, "overrides": [ { "include": ["*.ts"], "linter": { "rules": { "style": { "noDefaultExport": "on" } } } } ] }Unfortunately, the configuration doesn't quite fit what we want:
Thus, we ignore all files ending with
.test.js, includingspecial.test.ts.test, includingsrc/test.srcAll these issues and limitations are fixed with
includes.Here the migrated configuration:
{ "files": { "includes": ["**", "!**/*.test.js", "**/special.test.ts", "!test"] }, "linter": { "includes": ["src/**", "!**/*.gen.js"], "enabled": true }, "overrides": [ { "includes": ["**/*.ts"], "linter": { "rules": { "style": { "noDefaultExport": "on" } } } } ] }special.test.tsare unignored because the pattern appear after the pattern that ignore files ending with.test.js.testdirectory at the project's root is ignored because the pattern doesn't start with**/.srcdirectory at the project's root only.Because
includespattern have a different pattern format thanincludeandignorewe made some adjustments:**infiles.includesto ensure that all files are included before ignoring some of them.**/for patterns that must match at any level of the file hierarchy.noUndeclaredVariablesno longer reports TypeScript types.In TypeScript projects, developers often use global declaration files to declare global types.
Biome is currently unable to detect these global types.
This creates many false positives for
noUndeclaredVariables.TypeScript is better suited to perform this kind of check.
As proof of this, TypeScript ESLint doesn't provide any rule that extends the
no-undefESLint rule.This is why Biome 1.9 introduced a new option
checkTypeswhich, when it is set to false, ignores undeclared type references.The option was set to
trueby default.This option is now set to
falseby default.To get the previous behavior, you have to set
checkTypestotrue:{ "linter": { "rules": { "correctness": { "noUndeclaredVariables": { "level": "on", "options": { "checkTypes": true } } } } } }The rule
noUnusedVariablesno longer reports unused function parameters. UsenoUnusedFunctionParameters.Fixed #5564.
noTypeOnlyImportAttributesnow ignores files ending with the extension.tswhen the type field ofpackage.jsonis set tocommonjs.The Biome formatter no longer adds a trailing comma in
.jsonfiles, even whenjson.formatter.trailingCommasis set totrue.Prettier 3.4 introduced a change in their normalization process of string literals: it no longer unescapes useless escape sequences.
Biome now matches the new behavior of Prettier when formatting code.
This affects the JSON and JavaScript formatters.
Reduced accepted values for formatter options:
--quote-styledoesn't acceptSingleandDoubleanymore.--quote-propertiesdoesn't acceptAsNeededandPreserveanymore.--semicolonsdoesn't acceptAsNeededandAlwaysanymore.--arrow-parenthesisdoesn't acceptAsNeededandAlwaysanymore.--trailing-commasdoesn't acceptES5,AllandNoneanymore.--attribute-positiondoesn't acceptSingleandMultilineanymore.Removed the option
enumMemberCasefrom the lint ruleuseNamingConvention.enumMemberCaseis an option that allows to customize the enforced case for TypeScript's enum members.The option was introduced prior to the
conventionsoption that allows to do the same thing.The following configuration...
{ "linter": { "rules": { "style": { "useNamingConvention": { "level": "on", "options": { "enumMemberCase": "PascalCase" } } } } } }...must be rewritten as:
{ "linter": { "rules": { "style": { "useNamingConvention": { "level": "on", "options": { "conventions": [ { "selector": { "kind": "enumMember" }, "formats": ["PascalCase"] } ] } } } } } }Run
biome migrate --writeto turnenumMemberCaseintoconventionsautomatically.Removed support for
BIOME_LOG_DIR.The environment variable
BIOME_LOG_DIRisn't supported anymore.Use
BIOME_LOG_PATHinstead.Remove deprecated rules.
The following deprecated rules have been deleted:
noInvalidNewBuiltinnoNewSymboluseShorthandArrayTypeuseSingleCaseStatementnoConsoleLogRun the command
biome migrate --writeto update the configuration.Removed the deprecated
indentSizeoption.The deprecated option
indentSize, and its relative CLI options, has been removed:formatter.indentSizejavascript.formatter.indentSizejson.formatter.indentSize--indent-size--javascript-formatter-indent-size--json-formatter-indent-sizeUse
indentWidthand its relative CLI options instead.Removed
ROME_BINARY. UseBIOME_BINARYinstead.Removed support for legacy suppressions.
Biome used to support "legacy suppressions" that looked like this:
// biome-ignore lint(complexity/useWhile): reasonThis format is no longer supported.
Removed support for
max_line_lengthfrom.editorconfig, as it isn't part of the official spec anymore.Removed support for
rome-ignoresuppression comments.Use
biome-ignoresuppression comments instead.Removed support for
rome.json.Use
biome.jsonorbiome.jsoncinstead.Removed the option
allfrom the linter.The options
linter.rules.allandlinter.rules.<group>.allhas been removed.The number of rules in Biome have increased in scope and use cases, and sometimes some of them can conflict with each other.
The option was useful at the beginning, but now it's deemed harmful, because it can unexpected behaviours in users projects.
To automatically remove it, run the following command:
Removed the option
trailingCommafrom the configuration and the CLI. Use the optiontrailingCommasinstead:{ "javascript": { "formatter": { - "trailingComma": "es5" + "trailingCommas": "es5" } } }Removed
--applyand--apply-unsafe.The CLI options
--applyand--apply-unasfearen't accepted anymore. Use--writeand--write --unafeinstead:Removed support for
assertsyntax.Biome now longer supports the
assertsyntax, use the newwithsyntax insteadFixed #5495: The rule
noBlankTargethas beenupdated to accept the
rel="noopener"in addition torel="noreferrer".In addition, an option has been added that allows
rel="noreferrer"to bedisabled.
The rule has been moved from the
a11ygroup to thesecuritygroup.The rule
useImportRestrictionshas been renamed tonoPrivateImports, and itsfunctionality has been significantly upgraded.
Previously, the rule would assume that any direct imports from modules inside
other directories should be forbidden due to their package private visibility.
The updated rule allows configuring the default visibility of exports, and
recognises JSDoc comments to override this visibility. The default visibility
is now
**public**, but can be set to**package**, or even**private**.Refer to the documentation of the rule to understand how to leverage the JSDoc comments.
noPrivateImportsis now recommended by default.The Biome daemon now reuses its workspace across connections. This allows multiple clients to
reuse the same documents and other cached data that we extract from them.
This primarily affects our IDE extensions: If you open multiple IDEs/windows for the same project,
they'll connect to the same daemon and reuse each other's workspace.
The Biome CLI is unaffected unless you opt in with the
--use-serverargument.Biome no longer treats too large files as errors.
Previously, files that exceed the configured size limit would throw an error, and the CLI would exit with an error code.
Now, the CLI ignores the file, emits an information diagnostic and doesn't exit with an error code.
Change the group of some rules, promote nursery rules and update the recommended rule set.
The following rules have been moved to a new group:
New rules are incubated in the nursery group.
Once stable, we promote them to a stable group.
Use the
biome migratecommand to automatically migrate nursery rules that have been promoted.The following CSS rules have been promoted:
The following GraphQL rules have been promoted:
The following JavaScript rules have been promoted:
Moreover, the following JavaScript rules are now recommended:
And the following style rules are no longer recommended:
Update the default severity level of lint rules.
Every diagnostic emitted by Biome has a severity level set to
error,warn, orinfo.Previously, all recommended lint rules had a default severity level set to
error.All other lint rules had a default severity level set to
warn.We have adjusted the default severity level of every rule, whether recommended or not, to better communicate the severity that a diagnostic highlights.
error.warn.info.You can use the CLI option
--diagnostic-level=errorto display only errors, or--diagnostic-level=warningto display both errors and warnings.By default, all diagnostics are shown.
You can also use the CLI option
--error-on-warningsto make the command fail when warnings are emitted.Reworked some recommended rules recommended to be less pedantic and blocking. This is a breaking change if your project relied on those rules to block the CI in case of violations; if that's the case, you should raise their severity level to error.
Some rules aren't recommended anymore, and some others return a different severity.
The following rules return a warning diagnostic:
noDeletenoForEachnoSuspiciousSemicolonInJsxnoThisInStaticnoUnusedLabelsThe following rules return an information diagnostic:
noUselessCatchnoUselessConstructornoUselessEmptyExportnoUselessFragmentsnoUselessLabelnoUselessLoneBlockStatementsnoUselessSwitchCasenoUselessTernarynoUselessThisAliasnoUselessTypeConstraintnoFlatMapIdentityThe following rules aren't recommended anymore:
noDeletenoForEachThe rule
noRenderReturnValueanduseExhaustiveDependenciesare only recommended when thereactdomain is enabled.Renamed the global option
--skip-errorsto--skip-parse-errors.Remove the code action
quickfix.suppressRule.The code action
quickfix.suppressRulewas removed in favour of two new code actions:quickfix.suppressRule.inline.biome: a code action that adds a suppression comment for each violation.quickfix.suppressRule.topLevel.biome: a code action that adds a suppression comment at the top of the file which suppresses a rule for the whole file.Given the following code
The code action
quickfix.suppressRule.inline.biomewill result in the following code:The code action
quickfix.suppressRule.topLevel.biome, instead, will result in the following code:Changed default formatting of
package.json.When Biome encounters a file called
package.json, by default it will format the file with all objects and arrays expanded.The
organizeImportsis now part of Biome Assist.The rule
noVarnow belongs to thesuspiciousgroupThe rule
useWhilenow belongs to thecomplexitygroup.The rule
useImportExtensionshas been updated to suggest actual file extensions instead of guesses based on hueristics.As part of this, the
suggestedExtensionsoption has been removed. A simpler,new option called
forceJsExtensionshas been introduced for those who usetsc's"module": "node16"setting.The rule also no longer reports diagnostics to add an extension when the path
doesn't exist at all, with or without extension.
Fixed #4545:
useNamingConventionnow correctly ignores declarations inside TypeScript's external modules.The following interface name is no longer reported by the rule:
The rule
useAltTextno longer checks the element's attributes containing object spread.The following code doesn't trigger the rule anymore:
The rule
useNamingConventionno longer accepts non-ASCII characters by default.Prior to Biome 2.0, non-ASCII names were accepted by default. They are now rejected.
For example, the following code is now reported as invalid by the
useNamingConventionrule.If you want to allow non ASCII filenames and non-ASCII identifiers, you need to set the
requireAsciioptions in your Biome configuration file tofalse:{ "linter": { "rules": { "style": { "useFilenamingConvention": { "level": "on", "options": { "requireAscii": false } } "useFilenamingConvention": { "level": "on", "options": { "requireAscii": false } } } } } }Renamed the rule
noUnnecessaryContinuetonoUselessContinue. Run the commandbiome migrateto update your configuration.Renamed the rule
noMultipleSpacesInRegularExpressionLiteralstonoAdjacentSpacesInRegex. Run the commandbiome migrateto update your configuration.Minor Changes
An option called
allowNoReferrerhas been added to thenoBlankTargetrule.By default,
noBlankTargetaccepts bothrel="noopener"andrel="noreferrer"with links that have
target="_blank". This is because the latter implies theformer, so either one is sufficient to mitigate the security risk.
However, allowing
rel="noreferrer"may still be undesirable, because it canbreak tracking, which may be an undesirable side-effect. As such, you can set
allowNoReferrer: falseto only acceptrel="noopener".Added new option
javascript.parser.jsxEverywhere. This new option allows to control whether Biome should expect JSX syntax in.js/.mjs/.cjsfiles.When
jsxEverywhereis set tofalse, having JSX syntax like<div></div>inside.js/.mjs/.cjsfiles will result in a parsing error.Despite the name of the option, JSX is never supported inside
.tsfiles. This is because TypeScript generics syntax may conflict with JSX in such files.This option defaults to
true.Add a new JS assist rule -
useSortedKeyswhich enforces ordering of a JS object properties.This rule will consider spread/calculated keys e.g
[k]: 1as non-sortable.Instead, whenever it encounters a non-sortable key, it will sort all the
previous sortable keys up until the nearest non-sortable key, if one exist.
This prevents breaking the override of certain keys using spread keys.
Source: https://perfectionist.dev/rules/sort-objects
Added the new rule
noFloatingPromises.Added the new rule
noImportCycles.Added the new rule
noTsIgnore.Added the new rule
noUnwantedPolyfillio.Added a format option
expandfor Javascript and JSON formatters.The option allows to enforce the formatting of arrays and objects on multiple lines, regardless of their length.
It has three options:
When set to
auto(default), objects are expanded if the first property has a leading newline.Arrays are collapsed when they fit to a single line.
For example, both styles below are considered as already formatted:
When set to
always, objects and arrays are always expanded.When set to
never, objects and arrays are never expanded when they fit in a single line.It is equivalent to Prettier's Object Wrap option with
collapse.The nursery rule
noUnresolvedImportshas been added.Importing a non-existing export is an error at runtime or build time. With this
rule, Biome can detect such incorrect imports and report errors for them.
Note that if you use TypeScript, you probably don't want to use this rule, since
TypeScript already performs such checks for you.
The rule
noFocusedTestscan now detect the usage of focused tests inside loops.Linter groups now accept new options to enable/disable all rules that belong to a group, and control the severity
of the rules that belong to those groups.
For example, you can downgrade the severity of rules that belong to
"style"to emit"info"diagnostics:{ "linter": { "rules": { "style": "info" } } }You can also enable all rules that belong to a group using the default severity of the rule using the
"on"option:{ "linter": { "rules": { "complexity": "on" } } }Biome assist is a new feature of the Biome analyzer. The assist is meant to provide actions. Actions differ from linter rules in that they aren't meant to signal errors.
The assist will provide code actions that users can opt into via configuration or via IDEs/editors, using the Language Server Protocol.
The assist is enabled by default. However, you can turn if off via configuration:
{ "assist": { "enabled": false } }You can turn on the actions that you want to use in your configuration. For example, you can enable the
useSortedKeysaction like this:{ "assist": { "actions": { "source": { "useSortedKeys": "on" } } } }Alternatively, IDE/editor users can decide which action to apply on save directly from the editor settings, as long as the assist is enabled.
For example, in VS Code you can apply the
useSortedKeysaction when saving a file by adding the following snippet insettings.json:{ "editor.codeActionsOnSave": { "source.biome.useSortedKeys": "explicit" } }In Zed, you can achieve the same by adding the following snippet in
~/.config/zed/settings.json:{ "code_actions_on_format": { "source.biome.useSortedKeys": true } }Biome migrate eslint outputs a better overriding behavior.
A Biome rule can have multiple ESLint equivalent rules.
For example, useLiteralKeys has two ESLint equivalent rules: dot-notation and @typescript-eslint/dot-notation.
Previously, Biome wouldn't always enable a Biome rule even if one of its equivalent rules was enabled.
Now Biome uses the higher severity level of all the equivalent ESLint rules to set the severity level of the Biome rule.
The following ESLint configuration...
{ "rules": { "@​typescript-eslint/dot-notation": "error", "dot-notation": "off" } }...is now migrated to...
{ "linter": { "rules": { "complexity": { "useLiteralKeys": "error" } } } }...because
erroris higher thanoff.Add useSymbolDescription.
Enhanced the command
migrate eslint. Now the command shows which ESLint rules were migrated,and which rules aren't supported yet.
Suppression of syntax rules
Added support for suppressing syntax rules. Syntax rules are particular rules meant to complement the parser, hence they can't be configured.
Biome now allows to suppress those rules. This can, for example, be useful in case the rule is affected by a bug. However, this is more an escape hatch, so if a syntax rule requires a suppression, please file an issue.
Example:
Biome now requires all
biome-ignore-startsuppressions to have an equivalentbiome-ignore-endcomment.Add a new lint rule
noConstantBinaryExpression.This rule is inspired from ESLint's no-constant-binary-expression rule.
The CLI options
--onlyand--skipnow accept rule and action names without prefixing the group name.Previously
--only=noDebuggerwas rejected.You had to add the group name:
--only=suspicious/noDebugger.Fixed #3574:
noUnusedImportsnow reports empty named imports and suggests their removal.The rule now suggests the removal of empty named imports such as:
- import {} from "mod";Added the new rule
useAdjacentGetterSetter, which enforces getters and setters for the same propertyto be adjacent in class and object definitions.
Example (Invalid): Name getter and setter are not adjacent:
**Example (Invalid): Getter should go before the setter.
Example (Valid): Name getter and setter are adjacent:
Added new rule useConsistentResponse which suggests to use static Response.json() and Response.redirect() methods instead of
new Responsewhen possible.Example:
Biome users can now configure code actions from linter rules as well as assist actions directly in the settings of their IDE/editor.
For example, let's consider the lint rule
noSwitchDeclarations, which has an unsafe fix.Previously, if you wanted to use this rule, you were "forced" to enable it via configuration, and if you wanted to apply its fix when you saved a file, you were forced to mark the fix as safe:
{ "linter": { "rules": { "correctness": { "noSwitchDeclarations": { "level": "error", "fix": "safe" } } } } }Now, you can benefit from the code action without making the fix safe for the entire project. IDEs and editors that are LSP compatible allow to list a series of "filters" or code actions that can be applied on save. In the case of VS Code, you will need to add the following snippet in the
settings.json:{ "editor.codeActionsOnSave": { "quickfix.biome.correctness.noSwitchDeclarations": "explicit" } }Upon save, Biome will inform the editor the apply the code action of the rule
noSwitchDeclarations.Fixed #3401:
noUnusedImportsnow keeps comments separated from the import with a blank line.For example:
Added a new
propertyAssignmentoption to thenoParameterAssignrule.This option allows to configure whether property assignments on function parameters are permitted.
By default,
propertyAssignmentis set toallow.Setting it to
denyenforces stricter immutability by disallowing property mutations on function parameters.The formatter option
bracketSpacingis now also supported in JSON files.useValidTypeofnow accepts comparisons with variables.Previously, the rule required to compare a
typeofexpression against anothertypeofexpression or a valid string literal. We now accept more cases, notably comparison against a variable:Added the new rule
noNestedComponentDefinitions,which disallows nested component definitions in React components.
This rule is useful for preventing potential performance issues and improving code readability by ensuring that components are defined at the top level.
Example (Invalid):
Example (Valid):
Added the new rule
noDestructuredProps, which disallow the use of destructured props in Solid projects.You can now enable lint rules using the default severity suggested by Biome using the new variant
"on", when enabling a rule.For example, the default severity of the rule
style.noVariserror, so you would use"on", and then linting a code that usesvar, will result in an error:{ "linter": { "recommended": false, "rules": { "style": { "noVar": "on" } } } }The command
biome lint main.jswill result in an error due to the default severity assigned tonoVar.Refer to the documentation page of each rule to know their suggested diagnostic severity, or use the command
biome explain <RULE_NAME>:Biome VCS integration now supports nested ignore files.
For
git, if a.gitignoreis found in a nested folderroot/packages/foo/, and it contains the patterndist/, only files and directories insideroot/packages/foo/distare matched.Added the rule useUniqueElementIds.
This rule disallows the use of static IDs in React components. It encourages to generate unique IDs for accessibility purposes using
useId.The following code is now reported as invalid:
The following code is now reported as valid:
Added the new JavaScript rule
useConsistentObjectDefinitionrule. The rule enforces a consistent style for the definition of objects:By default, the rule enforces a shorthand style:
Alternatively, the rule can be configured to enforce an explicit style:
Introduced more advanced logging capabilities:
Every Biome CLI command can now be passed a
--log-file=<path>argument, whichwill write all log messages for that invocation to the given path instead of
stdout.In addition, the
--log-levelparameter now also accepts atracingvalue.When
--log-level=tracingis used, Biome also prints timing information fromtracing spans to the log.
Combined with Biome's ability to print logs in JSON format, and the
jqcommandline utility, this allows you to perform advanced analysis on Biome's internal
performance.
For example, if you want to figure out which paths take the longest when
building the module graph, you can use the following commands:
Now you will have a file called
filtered.jsonwith all the relevant timings,together with the paths used during the invocations.
Added options to
suspicious/noConfusingLabelsto allow specific labels.Fixed #4549: noUnknownProperty now accepts more known CSS properties.
This change replaces deprecated properties, improving CSS validation.
LSP clients can now override the configuration path for each workspace, by responding to
workspace/configurationrequests.Added the new CSS rule
noImportantStyles, which prevents the use of!importantinside CSS declarations.Biome now emits a warning diagnostic if the configuration contains an out-of-sync schema URL.
Introduced a new configuration setting
files.experimentalScannerIgnores.This setting may be used to configure a set of file and folder names that should
be unconditionally ignored by Biome's scanner.
Biome maintains an internal list of default ignore entries, which is based on
user feedback and which may change in any release. This setting allows
overriding this internal list completely.
This is considered an advanced feature that users should not need to tweak
themselves, but they can as a last resort. This setting can only be configured
in root configurations, and is ignored in nested configs.
Entries must be file or folder names. Specific paths and globs are not
supported.
Examples where this may be useful:
{ "files": { "experimentalScannerIgnores": [ // You almost certainly don't want to scan your `.git` folder, which // is why it's already ignored by default: ".git", // But the scanner does scan `node_modules` by default. If you // *really* don't want this, you can ignore it like this: "node_modules", // But it's probably better to ignore a specific dependency. // For instance, one that happens to be particularly slow to scan: "RedisCommander.d.ts", ], }, }Please be aware that rules relying on the module graph or type inference
information may be negatively affected if dependencies of your project aren't
(fully) scanned.
Added the new rule useSingleJsDocAsterisk which enforces JSDoc comment lines to start with a single asterisk.
The CLI flag
--javascript-attribute-positionwas renamed to--javascript-formatter-attribute-positionfor consistency.Introduced the
domainslinter feature. The Biome linter now has a new way to opt-in rules, with a concept calleddomains.Domains can be seen as concepts shared by different rules.
You can enable and disable multiple rules that belong to a domain. When you assign
"all", Biome will enable all the rules, when you assign"none", Biome will disable the rules, when you assign "recommended", Biome will enable all rules of the domain that are recommended.New domains introduced:
test: it will enable rules:noExportsInTestnoExcessiveNestedTestSuitesnoDuplicateTestHooksnoFocusedTestsAnd it will inject the following globals:
afterafterAllafterEachbeforebeforeEachbeforeAlldescribeitexpecttestnext: it will enable rules for Next.js projects:useExhaustiveDependenciesuseHookAtTopLevelnoImgElementnoHeadImportInDocumentnoHeadImportInDocumentreact: it will enable rules for React projects:useExhaustiveDependenciesuseHookAtTopLevelsolid: it will enable rules for Solid projects:noReactSpecificPropsFor more information regarding how Biome enables rules via domains, please refer to the documentation page of each rule.
Biome now prints diagnostics sorted by their severity. The order is the following:
This means that error diagnostics are printed last, so users can see them first.
Added the new rule
useIterableCallbackReturn, which enforces consistent return values in iterable callbacks.The following methods require a return value in their callback:
everyfilterfindfindIndexfindLastfindLastIndexflatMapmapreducereduceRightsomesorttoSorted—
from(when called onArray)The rule disallows a return value inside the callback of the method
forEach.Examples:
Added the new rule
noReactPropAssign, based on the react-hooks rule react-hooks/react-compilerThe following code is now reported as invalid:
The following code is now reported as valid:
Added new rule
noBitwiseOperators, which disallows bitwise operators.The Biome analyzer now supports a new top-level suppression. These suppression have to be placed at the top of the file, and they must be followed by two newlines (
\n\n\).The analyzer rules specified inside the block comment will be suppressed for the whole file.
In the example, we suppress the rules
lint/style/useConstandlint/suspicious/noDebuggerfor the whole file:In this other example, we suppress
lint/suspicious/noEmptyBlockfor a whole CSS file:A new diagnostic is emitted if
biome-ignore-allsuppression isn't placed at the top of the file:Added the new rule
useNumericSeparators, which encourages the use of numeric separators to improve readability.useImportExtensions now checks imports with sub extensions.
It's possible to override the option
files.maxSize. This option is helpful if you need to process specific files that exceed the defaultmaxSize:{ "overrides": [{ "includes": ["dist/**"] "files": { "maxSize": 20000 } }] }Added the new CLI option called
--threadsto thecicommand. It allows to control the numbers of threads that can be used when using the Biome CLI.It's possible to use the environment variable
BIOME_THREADSas an alternatives.This feature is useful when running the CLI in environments that have limited resources, for example CI/CD.
Added the new rule
useObjectSpread, which prefers object spread syntax overObject.assign()when constructing new objects.Example (Invalid): Using Object.assign with an empty object:
Example (Invalid): Using Object.assign with object literal as first argument:
Example (Valid): Using object spread syntax:
Example (Valid): Modifying existing objects is allowed:
Added an option to the
lintcommand called--suppress. The new option suppresses a violation instead of applying a rule fix. The option accepts a string that is used as reason of the suppression comment.When running the following command, it will add the suppression comment:
biome lint --write --suppress="Migration to Biome"Add an
ignoreRestSiblingsoption intonoUnusedVariables.When this option is set to
false, the rule will not ignore variables that created using the rest pattern:{ "linter": { "rules": { "correctness": { "noUnusedVariables": { "level": "error", "options": { "ignoreRestSiblings": false } } } } } }Upgraded some unsafe fixes to safe fixes.
The following rules have now a safe fix:
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.