chore(deps): update @biomejs/biome to 2.0.0 #633
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.0
1.9.4
->2.0.0
Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
biomejs/biome (@biomejs/biome)
v2.0.0
Compare Source
Major Changes
9d5d95f
Thanks @arendjr! - Biome now resolves globs and paths from the configuration. Before, paths and globs were resolved from the working directory.9d5d95f
Thanks @arendjr! - 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.9d5d95f
Thanks @arendjr! - Removed the--config-path
argument from thebiome lsp-proxy
andbiome start
commands.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/configuration
response instead of using the--config-path
argument. 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.9d5d95f
Thanks @arendjr! - Downgraded some code fixes to unsafe which were previously safe.The following rules have now a unsafe fix:
noFlatMapIdentity
noUnusedImports
If you want to keep applying these fixes automatically, configure the rule fix as safe:
9d5d95f
Thanks @arendjr! - Previously the lint rulesnoControlCharactersInRegex
andnoMisleadingCharacterClass
checked 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
noControlCharactersInRegex
andnoMisleadingCharacterClass
only check literals of regular expressions.9d5d95f
Thanks @arendjr! - The lint rulenoRestrictedGlobals
now supports customizing message for each global name.For example, the following configuration:
emits a diagnostic:
Breaking Change: The option
deniedGlobals
is now a record instead of an array. Runbiome migrate
to migrate the configuration automatically.9d5d95f
Thanks @arendjr! - Removedinclude
andignore
fields 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
include
andignore
fields.In Biome 2.0,
include
andignore
are removed and replaced byincludes
.You can run
biome migrate
to convertinclude
andignore
intoincludes
automatically.includes
uses a different glob pattern format that fixes many issues and many other limitations that Biome users reported.includes
accepts an array of glob patterns.A glob pattern starting with a
!
is a negated pattern also called exception.This replaces
ignore
patterns 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
include
andignore
, becauseignore
has priority overinclude
.The semantics of
*
and**/*
have changed too.Before, with
include
andignore
, 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
.test
directory.The
test
directory is located at the root of the project.src
directory, that don't end with.gen.js
.The
src
directory is located at the root of the project.noDefaultExport
lint rule on files ending with.ts
.Prior to Biome 2.0, the configuration might look like:
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
.src
All these issues and limitations are fixed with
includes
.Here the migrated configuration:
special.test.ts
are unignored because the pattern appear after the pattern that ignore files ending with.test.js
.test
directory at the project's root is ignored because the pattern doesn't start with**/
.src
directory at the project's root only.Because
includes
pattern have a different pattern format thaninclude
andignore
we made some adjustments:**
infiles.includes
to ensure that all files are included before ignoring some of them.**/
for patterns that must match at any level of the file hierarchy.9d5d95f
Thanks @arendjr! -noUndeclaredVariables
no 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-undef
ESLint rule.This is why Biome 1.9 introduced a new option
checkTypes
which, when it is set to false, ignores undeclared type references.The option was set to
true
by default.This option is now set to
false
by default.To get the previous behavior, you have to set
checkTypes
totrue
:9d5d95f
Thanks @arendjr! - The rulenoUnusedVariables
no longer reports unused function parameters. UsenoUnusedFunctionParameters
.9d5d95f
Thanks @arendjr! - Fixed #5564.noTypeOnlyImportAttributes
now ignores files ending with the extension.ts
when the type field ofpackage.json
is set tocommonjs
.9d5d95f
Thanks @arendjr! - The Biome formatter no longer adds a trailing comma in.json
files, even whenjson.formatter.trailingCommas
is set totrue
.9d5d95f
Thanks @arendjr! - 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.
9d5d95f
Thanks @arendjr! - Reduced accepted values for formatter options:--quote-style
doesn't acceptSingle
andDouble
anymore.--quote-properties
doesn't acceptAsNeeded
andPreserve
anymore.--semicolons
doesn't acceptAsNeeded
andAlways
anymore.--arrow-parenthesis
doesn't acceptAsNeeded
andAlways
anymore.--trailing-commas
doesn't acceptES5
,All
andNone
anymore.--attribute-position
doesn't acceptSingle
andMultiline
anymore.9d5d95f
Thanks @arendjr! - Removed the optionenumMemberCase
from the lint ruleuseNamingConvention
.enumMemberCase
is an option that allows to customize the enforced case for TypeScript's enum members.The option was introduced prior to the
conventions
option that allows to do the same thing.The following configuration...
...must be rewritten as:
Run
biome migrate --write
to turnenumMemberCase
intoconventions
automatically.9d5d95f
Thanks @arendjr! - Removed support forBIOME_LOG_DIR
.The environment variable
BIOME_LOG_DIR
isn't supported anymore.Use
BIOME_LOG_PATH
instead.9d5d95f
Thanks @arendjr! - Remove deprecated rules.The following deprecated rules have been deleted:
noInvalidNewBuiltin
noNewSymbol
useShorthandArrayType
useSingleCaseStatement
noConsoleLog
Run the command
biome migrate --write
to update the configuration.9d5d95f
Thanks @arendjr! - Removed the deprecatedindentSize
option.The deprecated option
indentSize
, and its relative CLI options, has been removed:formatter.indentSize
javascript.formatter.indentSize
json.formatter.indentSize
--indent-size
--javascript-formatter-indent-size
--json-formatter-indent-size
Use
indentWidth
and its relative CLI options instead.9d5d95f
Thanks @arendjr! - RemovedROME_BINARY
. UseBIOME_BINARY
instead.9d5d95f
Thanks @arendjr! - Removed support for legacy suppressions.Biome used to support "legacy suppressions" that looked like this:
// biome-ignore lint(complexity/useWhile): reason
This format is no longer supported.
9d5d95f
Thanks @arendjr! - Removed support formax_line_length
from.editorconfig
, as it isn't part of the official spec anymore.9d5d95f
Thanks @arendjr! - Removed support forrome-ignore
suppression comments.Use
biome-ignore
suppression comments instead.9d5d95f
Thanks @arendjr! - Removed support forrome.json
.Use
biome.json
orbiome.jsonc
instead.9d5d95f
Thanks @arendjr! - Removed the optionall
from the linter.The options
linter.rules.all
andlinter.rules.<group>.all
has 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:
9d5d95f
Thanks @arendjr! - Removed the optiontrailingComma
from the configuration and the CLI. Use the optiontrailingCommas
instead:9d5d95f
Thanks @arendjr! - Removed--apply
and--apply-unsafe
.The CLI options
--apply
and--apply-unasfe
aren't accepted anymore. Use--write
and--write --unafe
instead:9d5d95f
Thanks @arendjr! - Removed support forassert
syntax.Biome now longer supports the
assert
syntax, use the newwith
syntax instead9d5d95f
Thanks @arendjr! - Fixed #5495: The rulenoBlankTarget
has 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
a11y
group to thesecurity
group.9d5d95f
Thanks @arendjr! - The ruleuseImportRestrictions
has 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.
noPrivateImports
is now recommended by default.9d5d95f
Thanks @arendjr! - The Biome daemon now reuses its workspace across connections. This allows multiple clients toreuse 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-server
argument.9d5d95f
Thanks @arendjr! - 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.
9d5d95f
Thanks @arendjr! - 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
biomem igrate
command 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:
9d5d95f
Thanks @arendjr! - 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=error
to display only errors, or--diagnostic-level=warning
to display both errors and warnings.By default, all diagnostics are shown.
You can also use the CLI option
--error-on-warnings
to make the command fail when warnings are emitted.9d5d95f
Thanks @arendjr! - 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:
noDelete
noForEach
noSuspiciousSemicolonInJsx
noThisInStatic
noUnusedLabels
The following rules return an information diagnostic:
noUselessCatch
noUselessConstructor
noUselessEmptyExport
noUselessFragments
noUselessLabel
noUselessLoneBlockStatements
noUselessSwitchCase
noUselessTernary
noUselessThisAlias
noUselessTypeConstraint
noFlatMapIdentity
The following rules aren't recommended anymore:
noDelete
noForEach
The rule
noRenderReturnValue
anduseExhaustiveDependencies
are only recommended when thereact
domain is enabled.9d5d95f
Thanks @arendjr! - Renamed the global option--skip-errors
to--skip-parse-errors
.9d5d95f
Thanks @arendjr! - Remove the code actionquickfix.suppressRule
.The code action
quickfix.suppressRule
was 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.biome
will result in the following code:The code action
quickfix.suppressRule.topLevel.biome
, instead, will result in the following code:9d5d95f
Thanks @arendjr! - Changed default formatting ofpackage.json
.When Biome encounters a file called
package.json
, by default it will format the file with all objects and arrays expanded.9d5d95f
Thanks @arendjr! - TheorganizeImports
is now part of Biome Assist.9d5d95f
Thanks @arendjr! - The rulenoVar
now belongs to thesuspicious
group9d5d95f
Thanks @arendjr! - The ruleuseWhile
now belongs to thecomplexity
group.9d5d95f
Thanks @arendjr! - The ruleuseImportExtensions
has been updated to suggest actual file extensions instead of guesses based on hueristics.As part of this, the
suggestedExtensions
option has been removed. A simpler,new option called
forceJsExtensions
has 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.
9d5d95f
Thanks @arendjr! - Fixed #4545:useNamingConvention
now correctly ignores declarations inside TypeScript's external modules.The following interface name is no longer reported by the rule:
9d5d95f
Thanks @arendjr! - The ruleuseAltText
no longer checks the element's attributes containing object spread.The following code doesn't trigger the rule anymore:
9d5d95f
Thanks @arendjr! - The ruleuseNamingConvention
no 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
useNamingConvention
rule.If you want to allow non ASCII filenames and non-ASCII identifiers, you need to set the
requireAscii
options in your Biome configuration file tofalse
:9d5d95f
Thanks @arendjr! - Renamed the rulenoUnnecessaryContinue
tonoUselessContinue
. Run the commandbiome migrate
to update your configuration.9d5d95f
Thanks @arendjr! - Renamed the rulenoMultipleSpacesInRegularExpressionLiterals
tonoAdjacentSpacesInRegex
. Run the commandbiome migrate
to update your configuration.Minor Changes
9d5d95f
Thanks @arendjr! - An option calledallowNoReferrer
has been added to thenoBlankTarget
rule.By default,
noBlankTarget
accepts 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: false
to only acceptrel="noopener"
.9d5d95f
Thanks @arendjr! - Added new optionjavascript.parser.jsxEverywhere
. This new option allows to control whether Biome should expect JSX syntax in.js
/.mjs
/.cjs
files.When
jsxEverywhere
is set tofalse
, having JSX syntax like<div></div>
inside.js
/.mjs
/.cjs
files will result in a parsing error.Despite the name of the option, JSX is never supported inside
.ts
files. This is because TypeScript generics syntax may conflict with JSX in such files.This option defaults to
true
.9d5d95f
Thanks @arendjr! - Add a new JS assist rule -useSortedKeys
which enforces ordering of a JS object properties.This rule will consider spread/calculated keys e.g
[k]: 1
as 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
9d5d95f
Thanks @arendjr! - Added the new rulenoFloatingPromises
.9d5d95f
Thanks @arendjr! - Added the new rulenoImportCycles
.9d5d95f
Thanks @arendjr! - Added the new rulenoTsIgnore
.9d5d95f
Thanks @arendjr! - Added the new rulenoUnwantedPolyfillio
.9d5d95f
Thanks @arendjr! - Added a format optionexpand
for 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
.9d5d95f
Thanks @arendjr! - The nursery rulenoUnresolvedImports
has 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.
9d5d95f
Thanks @arendjr! - The rulenoFocusedTests
can now detect the usage of focused tests inside loops.9d5d95f
Thanks @arendjr! - Linter groups now accept new options to enable/disable all rules that belong to a group, and control the severityof the rules that belong to those groups.
For example, you can downgrade the severity of rules that belong to
"style"
to emit"info"
diagnostics:You can also enable all rules that belong to a group using the default severity of the rule using the
"on"
option:9d5d95f
Thanks @arendjr! - 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:
You can turn on the actions that you want to use in your configuration. For example, you can enable the
useSortedKeys
action like this: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
useSortedKeys
action when saving a file by adding the following snippet insettings.json
:In Zed, you can achieve the same by adding the following snippet in
~/.config/zed/settings.json
:9d5d95f
Thanks @arendjr! - 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...
...is now migrated to...
...because
error
is higher thanoff
.9d5d95f
Thanks @arendjr! - Add useSymbolDescription.9d5d95f
Thanks @arendjr! - Enhanced the commandmigrate eslint
. Now the command shows which ESLint rules were migrated,and which rules aren't supported yet.
9d5d95f
Thanks @arendjr! - Suppression of syntax rulesAdded 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-start
suppressions to have an equivalentbiome-ignore-end
comment.9d5d95f
Thanks @arendjr! - Add a new lint rulenoConstantBinaryExpression
.This rule is inspired from ESLint's no-constant-binary-expression rule.
9d5d95f
Thanks @arendjr! - The CLI options--only
and--skip
now accept rule and action names without prefixing the group name.Previously
--> was rejected.
You had to add the group name:
-->.
9d5d95f
Thanks @arendjr! - Fixed #3574:noUnusedImports
now reports empty named imports and suggests their removal.The rule now suggests the removal of empty named imports such as:
- import {} from "mod";
9d5d95f
Thanks @arendjr! - Added the new ruleuseAdjacentGetterSetter
, 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:
9d5d95f
Thanks @arendjr! - Added new rule useConsistentResponse which suggests to use static Response.json() and Response.redirect() methods instead ofnew Response
when possible.Example:
9d5d95f
Thanks @arendjr! - 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:
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
:Upon save, Biome will inform the editor the apply the code action of the rule
noSwitchDeclarations
.9d5d95f
Thanks @arendjr! - Fixed #3401:noUnusedImports
now keeps comments separated from the import with a blank line.For example:
9d5d95f
Thanks @arendjr! - Added a newpropertyAssignment
option to thenoParameterAssign
rule.This option allows to configure whether property assignments on function parameters are permitted.
By default,
propertyAssignment
is set toallow
.Setting it to
deny
enforces stricter immutability by disallowing property mutations on function parameters.9d5d95f
Thanks @arendjr! - The formatter optionbracketSpacing
is now also supported in JSON files.9d5d95f
Thanks @arendjr! -useValidTypeof
now accepts comparisons with variables.Previously, the rule required to compare a
typeof
expression against anothertypeof
expression or a valid string literal. We now accept more cases, notably comparison against a variable:9d5d95f
Thanks @arendjr! - Added the new rulenoNestedComponentDefinitions
,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):
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 these updates again.
This PR was generated by Mend Renovate. View the repository job log.