@biomejs/biome
Advanced tools
Changelog
v1.8.1 (2024-06-10)
--staged
or --changed
options. Contributed by @unvalleyindentWidth
. Contributed by @ematipicoThe noEmptyBlock
css lint rule now treats empty blocks containing comments as valid ones. Contributed by @Sec-ant
useLiteralKeys no longer reports quoted member names (#3085).
Previously useLiteralKeys reported quoted member names that can be unquoted. For example, the rule suggested the following fix:
- const x = { "prop": 0 };
+ const x = { prop: 0 };
This conflicted with the option quoteProperties of our formatter.
The rule now ignores quoted member names.
Contributed by @Conaclos
noEmptyInterface now ignores empty interfaces in ambient modules (#3110). Contributed by @Conaclos
noUnusedVariables and noUnusedFunctionParameters no longer report the parameters of a constructor type (#3135).
Previously, arg
was reported as unused in a constructor type like:
export type Classlike = new (arg: unknown) => string;
Contributed by @Conaclos
noStringCaseMismatch now ignores escape sequences (#3134).
The following code is no longer reported by the rule:
s.toUpperCase() === "\u001b";
Contributed by @Conaclos
Changelog
1.8.0 (2024-06-04)
useExhaustiveDependencies
, which is now able to
suppress specific dependencies. Fixes #2509. Contributed by @arendjrAstro
object is always a global when processing .astro
files. Contributed by @minht11.vue
files. (#2771) Contributed by @dyc3New clean
command. Use this new command to clean after the biome-logs
directory, and remove all the log files.
biome clean
Add two new options --only
and --skip
to the command biome lint
(#58).
The --only
option allows you to run a given rule or rule group,
For example, the following command runs only the style/useNamingConvention
and style/noInferrableTypes
rules.
If the rule is disabled in the configuration, then its severity level is set to error
for a recommended rule or warn
otherwise.
biome lint --only=style/useNamingConvention --only=style/noInferrableTypes
Passing a group does not change the severity level of the rules in the group.
All the disabled rules in the group will remain disabled.
To ensure that the group is run, the recommended
field of the group is enabled.
The nursery
group cannot be passed, as no rules are enabled by default in the nursery group.
The --skip
option allows you to skip the execution of a given group or a given rule.
For example, the following command skips the style
group and the suspicious/noExplicitAny
rule.
biome lint --skip=style --skip=suspicious/noExplicitAny
You can also use --only
and --skip
together. --skip
overrides --only
.
The following command executes only the rules from the style
group, but the style/useNamingConvention
rule.
biome lint --only=style --skip=style/useNamingConvention
These options are compatible with other options such as --write
(previously --apply
), and --reporter
.
Contributed by @Conaclos
Add new command biome clean
. Use this command to purge all the logs emitted by the Biome daemon. This command is really useful, because the Biome daemon tends
log many files and contents during its lifecycle. This means that if your editor is open for hours (or even days), the biome-logs
folder could become quite heavy. Contributed by @ematipico
Add support for formatting and linting CSS files from the CLI. These operations are opt-in for the time being.
If you don't have a configuration file, you can enable these features with --css-formatter-enabled
and --css-linter-enabled
:
biome check --css-formatter-enabled=true --css-linter-enabled=true ./
Contributed by @ematipico
Add new CLI options to control the CSS formatting. Check the CLI reference page for more details. Contributed by @ematipico
Add new options --write
, --fix
(alias of --write
) and --unsafe
to the command biome lint
and biome check
.
Add a new option --fix
(alias of --write
) to the command biome format
and biome migrate
.
biome <lint|check> --<write|fix> [--unsafe]
biome format --<write|fix>
biome migrate --<write|fix>
The biome <lint|check> --<write|fix>
has the same behavior as biome <lint|check> --apply
.
The biome <lint|check> --<write|fix> --unsafe
has the same behavior as biome <lint|check> --apply-unsafe
.
The biome format --fix
has the same behavior as biome format --write
.
The biome migrate --fix
has the same behavior as biome migrate --write
.
This change allows these commands to write modifications in the same options.
With this change, the --apply
and --apply-unsafe
options are deprecated.
Contributed by @unvalley
Biome now executes commands (lint, format, check and ci) on the working directory by default. #2266 Contributed by @unvalley
- biome check .
+ biome check # You can run the command without the path
biome migrate eslint
now tries to convert ESLint ignore patterns into Biome ignore patterns.
ESLint uses gitignore patterns. Biome now tries to convert these patterns into Biome ignore patterns.
For example, the gitignore pattern /src
is a relative path to the file in which it appears.
Biome now recognizes this and translates this pattern to ./src
.
Contributed by @Conaclos
biome migrate eslint
now supports the eslintIgnore
field in package.json
.
ESLint allows the use of package.json
as an ESLint configuration file.
ESLint supports two fields: eslintConfig
and eslintIgnore
.
Biome only supported the former. It now supports both.
Contributed by @Conaclos
biome migrate eslint
now propagates NodeJS errors to the user.
This will help users to identify why Biome is unable to load some ESLint configurations.
Contributed by @Conaclos
Add a new --reporter
called summary
. This reporter will print diagnostics in a different way, based on the tools (formatter, linter, etc.) that are executed.
Import sorting and formatter shows the name of the files that require formatting. Instead, the linter will group the number of rules triggered and the number of errors/warnings:
Formatter ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
The following files needs to be formatted:
main.ts
index.ts
Organize Imports ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
The following files needs to have their imports sorted:
main.ts
index.ts
Analyzer ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Some analyzer rules were triggered
Rule Name Diagnostics
lint/suspicious/noImplicitAnyLet 12 (12 error(s), 0 warning(s), 0 info(s))
lint/suspicious/noDoubleEquals 8 (8 error(s), 0 warning(s), 0 info(s))
lint/suspicious/noRedeclare 12 (12 error(s), 0 warning(s), 0 info(s))
lint/suspicious/noDebugger 20 (20 error(s), 0 warning(s), 0 info(s))
Contributed by @ematipico
biome ci
now enforces printing the output using colours. If you were previously using --colors=force
, you can remove it because it's automatically set. Contributed by @ematipico
Add a new --reporter
called github
. This reporter will print diagnostics using GitHub workflow commands:
::error title=lint/suspicious/noDoubleEquals,file=main.ts,line=4,endLine=4,col=3,endColumn=5::Use === instead of ==
::error title=lint/suspicious/noDebugger,file=main.ts,line=6,endLine=6,col=1,endColumn=9::This is an unexpected use of the debugger statement.
::error title=lint/nursery/noEvolvingAny,file=main.ts,line=8,endLine=8,col=5,endColumn=6::This variable's type is not allowed to evolve implicitly, leading to potential any types.
Contributed by @ematipico
Add a new --reporter
called junit
. This reporter will print diagnostics using GitHub workflow commands:
<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="Biome" tests="16" failures="16" errors="20" time="<TIME>">
<testsuite name="main.ts" tests="1" disabled="0" errors="0" failures="1" package="org.biome">
<testcase name="org.biome.lint.suspicious.noDoubleEquals" line="4" column="3">
<failure message="Use === instead of ==. == is only allowed when comparing against `null`">line 3, col 2, Use === instead of ==. == is only allowed when comparing against `null`</failure>
</testcase>
</testsuite>
<testsuite name="main.ts" tests="1" disabled="0" errors="0" failures="1" package="org.biome">
<testcase name="org.biome.lint.suspicious.noDebugger" line="6" column="1">
<failure message="This is an unexpected use of the debugger statement.">line 5, col 0, This is an unexpected use of the debugger statement.</failure>
</testcase>
</testsuite>
<testsuite name="main.ts" tests="1" disabled="0" errors="0" failures="1" package="org.biome">
<testcase name="org.biome.lint.nursery.noEvolvingAny" line="8" column="5">
<failure message="This variable's type is not allowed to evolve implicitly, leading to potential any types.">line 7, col 4, This variable's type is not allowed to evolve implicitly, leading to potential any types.</failure>
</testcase>
</testsuite>
</testsuites>
Contributed by @ematipico
biome init
would create biome.json
even if biome.jsonc
already exists. Contributed by @minht11Add an rule option fix
to override the code fix kind of a rule (#2882).
A rule can provide a safe or an unsafe code action.
You can now tune the kind of code actions thanks to the fix
option.
This rule option takes a value among:
none
: the rule no longer emits code actions.safe
: the rule emits safe code action.unsafe
: the rule emits unsafe code action.The following configuration disables the code actions of noUnusedVariables
, makes the emitted code actions of style/useConst
and style/useTemplate
unsafe and safe respectively.
{
"linter": {
"rules": {
"correctness": {
"noUnusedVariables": {
"level": "error",
"fix": "none"
},
"style": {
"useConst": {
"level": "warn",
"fix": "unsafe"
},
"useTemplate": {
"level": "warn",
"fix": "safe"
}
}
}
}
}
}
Contributed by @Conaclos
Add option javascript.linter.enabled
to control the linter for JavaScript (and its super languages) files. Contributed by @ematipico
Add option json.linter.enabled
to control the linter for JSON (and its super languages) files. Contributed by @ematipico
Add option css.linter.enabled
to control the linter for CSS (and its super languages) files. Contributed by @ematipico
Add option css.formatter
, to control the formatter options for CSS (and its super languages) files. Contributed by @ematipico
You can now change the severity of lint rules down to "info"
. The "info"
severity doesn't emit error codes, and it isn't affected by other options like --error-on-warnings
:
{
"linter": {
"rules": {
"suspicious": {
"noDebugger": "info"
}
}
}
}
Contributed by @ematipico
javascript.formatter.trailingComma
option is deprecated and renamed to javascript.formatter.trailingCommas
. The corresponding CLI option --trailing-comma
is also deprecated and renamed to --trailing-commas
. Details can be checked in #2492. Contributed by @Sec-antbiome.json
. Contributed by @dyc3New rules are incubated in the nursery group. Once stable, we promote them to a stable group. The following rules are promoted:
Add nursery/useDateNow. Contributed by @minht11
Add nursery/useErrorMessage. Contributed by @minht11
Add nursery/useThrowOnlyError. Contributed by @minht11
Add nursery/useImportExtensions. Contributed by @minht11
useNamingConvention now supports an option to enforce custom conventions (#1900).
For example, you can enforce the use of a prefix for private class members:
{
"linter": {
"rules": {
"style": {
"useNamingConvention": {
"level": "error",
"options": {
"conventions": [
{
"selector": {
"kind": "classMember",
"modifiers": ["private"]
},
"match": "_(.*)",
"formats": ["camelCase"]
}
]
}
}
}
}
}
}
Please, find more details in the rule documentation.
Contributed by @Conaclos
Add nursery/useNumberToFixedDigitsArgument. Contributed by @minht11
Add nursery/useThrowNewError. Contributed by @minht11
Add nursery/useTopLevelRegex, which enforces defining regular expressions at the top level of a module. #2148 Contributed by @dyc3.
Add nursery/noCssEmptyBlock. #2513 Contributed by @togami2864
Add nursery/noDuplicateAtImportRules. #2658 Contributed by @DerTimonius
Add nursery/noDuplicateFontNames. #2308 Contributed by @togami2864
Add nursery/noDuplicateSelectorsKeyframeBlock. #2534 Contributed by @isnakode
Add nursery/noImportantInKeyframe. #2542 Contributed by @isnakode
Add nursery/noInvalidPositionAtImportRule. #2717 Contributed by @t-shiratori
Add nursery/noUnknownFunction. #2570 Contributed by @neokidev
Add nursery/noUnknownMediaFeatureName. #2751 Contributed by @Kazuhiro-Mimaki
Add nursery/noUnknownProperty. #2755 Contributed by @chansuke
Add nursery/noUnknownPseudoElement. #2655 Contributed by @keita-hino
Add nursery/noUnknownUnit. #2535 Contributed by @neokidev
Add nursery/noUnmatchableAnbSelector. #2706 Contributed by @togami2864
Add nursery/useGenericFontNames. #2573 Contributed by @togami2864
Add nursery/noYodaExpression. Contributed by @michellocana
Add nursery/noUnusedFunctionParameters Contributed by @printfn
Add nursery/UseSemanticElements. Contributed by @fujiyamaorange
Add a code action for noConfusingVoidType and improve the diagnostics.
The rule now suggests using undefined
instead of void
in confusing places.
The diagnosis is also clearer.
Contributed by @Conaclos
Improve code action for nursery/noUselessUndefinedInitialization to handle comments.
The rule now places inline comments after the declaration statement, instead of removing them. The code action is now safe to apply.
Contributed by @lutaok
Make useExhaustiveDependencies report duplicate dependencies. Contributed by @tunamaguro
Rename noEvolvingAny
into noEvolvingTypes
(#48). Contributed by @Conaclos
noUndeclaredVariables and noUnusedImports now correctly handle import namespaces (#2796).
Previously, Biome bound unqualified type to import namespaces. Import namespaces can only be used as qualified names in a type (ambient) context.
// Unused import
import * as Ns1 from "";
// This doesn't reference the import namespace `Ns1`
type T1 = Ns1; // Undeclared variable `Ns1`
// Unused import
import type * as Ns2 from "";
// This doesn't reference the import namespace `Ns2`
type T2 = Ns2; // Undeclared variable `Ns2`
import type * as Ns3 from "";
// This references the import namespace because it is a qualified name.
type T3 = Ns3.Inner;
// This also references the import namespace.
export type { Ns3 }
Contributed by @Conaclos
noUndeclaredVariables now correctly handle ambient computed member names (#2975).
A constant can be imported as a type and used in a computed member name of a member signature. Previously, Biome was unable to bind the value imported as a type to the computed member name.
import type { NAME } from "./constants.js";
type X = { [NAME]: number };
Contributed by @Conaclos
noUndeclaredVariables now ignores this
in JSX components (#2636).
The rule no longer reports this
as undeclared in following code.
import { Component } from 'react';
export class MyComponent extends Component {
render() {
return <this.foo />
}
}
Contributed by @printfn and @Conaclos
useJsxKeyInIterable
now handles more cases involving fragments. See the snippets below. Contributed by @dyc3
// valid
[].map((item) => {
return <>{item.condition ? <div key={item.id} /> : <div key={item.id}>foo</div>}</>;
});
// invalid
[].map((item) => {
return <>{item.condition ? <div /> : <div>foo</div>}</>;
});
noExcessiveNestedTestSuites
no longer erroneously alerts on describe
calls that are not invoking the global describe
function. #2599 Contributed by @dyc3// now valid
z.object({})
.describe('')
.describe('')
.describe('')
.describe('')
.describe('')
.describe('');
noEmptyBlockStatements
no longer reports empty constructors using typescript parameter properties. #3005 Contributed by @dyc3
noEmptyBlockStatements
no longer reports empty private or protected constructors. Contributed by @dyc3
noExportsInTest rule no longer treats files with in-source testing as test files https://github.com/biomejs/biome/issues/2859. Contributed by @ah-yu
useSortedClasses now keeps leading and trailing spaces when applying the code action inside template literals:
i Unsafe fix: Sort the classes.
1 1 │ <>
2 │ - → <div·class={`${variable}·px-2·foo·p-4·bar`}/>
2 │ + → <div·class={`${variable}·foo·bar·p-4·px-2`}/>
3 3 │ <div class={`px-2 foo p-4 bar ${variable}`}/>
4 4 │ </>
noUndeclaredDependencies is correctly triggered when running biome ci
. Contributed by @ematipico
noUnusedVariables no longer panics when a certain combination of characters is typed. Contributed by @ematipico
noUndeclaredVariables no logger alerts on arguments
object in a function scope. Contributed by @ah-yu
lang="tsx"
is now supported in Vue Single File Components. #2765 Contributed by @dyc3The const
modifier for type parameters is now accepted for TypeScript new
signatures (#2825).
The following code is now correctly parsed:
interface I {
new<const T>(x: T): T
}
Contributed by @Conaclos
Some invalid TypeScript syntax caused the Biome parser to crash.
The following invalid syntax no longer causes the Biome parser to crash:
declare using x: null;
declare qwait using x: null;
Contributed by @Conaclos
Changelog
1.7.3 (2024-05-06)
The stdin-file-path option now works correctly for Astro/Svelte/Vue files (#2686)
Fix #2225 where lint output become empty for Vue files.
Contributed by @tasshi-me
biome migrate eslint
now correctly resolve @scope/eslint-config
(#2705). Contributed by @Conaclos
Add nursery/useExplicitLengthCheck. Contributed by @minht11
useExhaustiveDependencies
now recognizes (some) dependencies that change on
every render (#2374).
Contributed by @arendjr
noBlankTarget no longer hangs when applying a code fix (#2675).
Previously, the following code made Biome hangs when applying a code fix.
<a href="https://example.com" rel="" target="_blank"></a>
Contributed by @Conaclos
noRedeclare no longer panics on conditional type (#2659).
This is a regression introduced by #2394.
This regression makes noRedeclare
panics on every conditional types with infer
bindings.
Contributed by @Conaclos
noUnusedLabels and noConfusingLabels now ignore svelte reactive statements (#2571).
The rules now ignore reactive Svelte blocks in Svelte components.
<script>
$: { /* reactive block */ }
</script>
Contributed by @Conaclos
useExportType no longer removes leading comments (#2685).
Previously, useExportType
removed leading comments when it factorized the type
qualifier.
It now provides a code fix that preserves the leading comments:
- export {
+ export type {
/**leading comment*/
- type T
+ T
}
Contributed by @Conaclos
useJsxKeyInIterable no longer reports false positive when iterating on non-jsx items (#2590).
The following snipet of code no longer triggers the rule:
<>{data.reduce((total, next) => total + next, 0)}</>
Contributed by @dyc3
Fix typo by renaming useConsistentBuiltinInstatiation
to useConsistentBuiltinInstantiation
Contributed by @minht11
Fix the rule useSingleCaseStatement
including break
statements when counting the number of statements in a switch
statement (#2696)
Changelog
1.7.2 (2024-04-30)
Import sorting now ignores side effect imports (#817).
A side effect import consists now in its own group. This ensures that side effect imports are not reordered.
Here is an example of how imports are now sorted:
import "z"
- import { D } from "d";
import { C } from "c";
+ import { D } from "d";
import "y"
import "x"
- import { B } from "b";
import { A } from "a";
+ import { B } from "b";
import "w"
Contributed by @Conaclos
Import sorting now adds spaces where needed (#1665) Contributed by @Conaclos
biome migrate eslint
now handles cyclic references.
Some plugins and configurations export objects with cyclic references.
This causes biome migrate eslint
to fail or ignore them.
These edge cases are now handled correctly.
Contributed by @Conaclos
Add nursery/noReactSpecificProps. Contributed by @marvin-j97
Add noUselessUndefinedInitialization. Contributed by @lutaok
Add nursery/useArrayLiterals. Contributed by @Kazuhiro-Mimaki
Add nursery/useConsistentBuiltinInstatiation. Contributed by @minht11
Add nursery/useDefaultSwitchClause. Contributed by @michellocana
noDuplicateJsonKeys no longer crashes when a JSON file contains an unterminated string (#2357). Contributed by @Conaclos
noRedeclare now reports redeclarations of parameters in a functions body (#2394).
The rule was unable to detect redeclarations of a parameter or a type parameter in the function body. The following two redeclarations are now reported:
function f<T>(a) {
type T = number; // redeclaration
const a = 0; // redeclaration
}
Contributed by @Conaclos
noRedeclare no longer reports overloads in object types (#2608).
The rule no longer report redeclarations in the following code:
type Overloads = {
({ a }: { a: number }): number,
({ a }: { a: string }): string,
};
Contributed by @Conaclos
noRedeclare now merge default function export declarations and types (#2372).
The following code is no longer reported as a redeclaration:
interface Foo {}
export default function Foo() {}
Contributed by @Conaclos
noUndeclaredVariables no longer reports variable-only and type-only exports (#2637). Contributed by @Conaclos
noUnusedVariables no longer crash Biome when encountering a malformed conditional type (#1695). Contributed by @Conaclos
useConst now ignores a variable that is read before its assignment.
Previously, the rule reported the following example:
let x;
x; // read
x = 0; // write
It is now correctly ignored.
Contributed by @Conaclos
useShorthandFunctionType now suggests correct code fixes when parentheses are required (#2595).
Previously, the rule didn't add parentheses when they were needed. It now adds parentheses when the function signature is inside an array, a union, or an intersection.
- type Union = { (): number } | string;
+ type Union = (() => number) | string;
Contributed by @Conaclos
useTemplate now correctly escapes strings (#2580).
Previously, the rule didn't correctly escape characters preceded by an escaped character.
Contributed by @Conaclos
noMisplacedAssertion now allow these matchers
expect.any()
expect.anything()
expect.closeTo
expect.arrayContaining
expect.objectContaining
expect.stringContaining
expect.stringMatching
expect.extend
expect.addEqualityTesters
expect.addSnapshotSerializer
Contributed by @fujiyamaorange
Changelog
1.7.1 (2024-04-22)
Add parentheses for the return expression that has leading multiline comments. #2504. Contributed by @ah-yu
Correctly format dangling comments of continue statements. #2555. Contributed by @ah-yu
Prevent comments from being eaten by the formatter #2578. Now the comments won't be eaten for the following code:
console.log((a,b/* comment */));
Contributed by @ah-yu
Correctly format nested union type to avoid reformatting issue. #2628. Contributed by @ah-yu
jsxRuntime
wasn't being respected by useImportType
rule (#2473).Contributed by @arendjrnoUselessFragments
was crashing the linter in some cases. Now cases like these are correctly handled:
callFunction(<>{bar}</>)
Contributed by @ematipiconoDuplicateJsonKeys
incorrectly computed the kes to highlight. Contributed by @ematipiconoMisplacedAssertions
now considers valid calling expect
inside waitFor
:
import { waitFor } from '@testing-library/react';
await waitFor(() => {
expect(111).toBe(222);
});
Contributed by @ematipicoChangelog
1.7.0 (2024-04-15)
Now Biome can detect the script language in Svelte and Vue script blocks more reliably (#2245). Contributed by @Sec-ant
useExhaustiveDependencies
no longer reports recursive calls as missing
dependencies (#2361).
Contributed by @arendjr
useExhaustiveDependencies
correctly reports missing dependencies declared
using function declarations (#2362).
Contributed by @arendjr
Biome now can handle .svelte
and .vue
files with CRLF
as the end-of-line sequence. Contributed by @Sec-ant
noMisplacedAssertion
no longer reports method calls by describe
, test
, it
objects (e.g. test.each([])()
) (#2443). Contributed by @unvalley.
Biome now can handle .vue
files with generic components (#2456).
<script generic="T extends Record<string, any>" lang="ts" setup>
//...
</script>
Contributed by @Sec-ant
Complete the well-known file lists for JSON-like files. Trailing commas are allowed in .jsonc
files by default. Some well-known files like tsconfig.json
and .babelrc
don't use the .jsonc
extension but still allow comments and trailing commas. While others, such as .eslintrc.json
, only allow comments. Biome is able to identify these files and adjusts the json.parser.allowTrailingCommas
option accordingly to ensure they are correctly parsed. Contributed by @Sec-ant
Fix dedent logic inconsistent with prettier where the indent-style is space and the indent-width is not 2. Contributed by @mdm317
Add a command to migrate from ESLint
biome migrate eslint
allows you to migrate an ESLint configuration to Biome.
The command supports legacy ESLint configurations and new flat ESLint configurations.
Legacy ESLint configurations using the YAML format are not supported.
When loading a legacy ESLint configuration, Biome resolves the extends
field.
It resolves both shared configurations and plugin presets!
To do this, it invokes Node.js.
Biome relies on the metadata of its rules to determine the equivalent rule of an ESLint rule.
A Biome rule is either inspired or roughly identical to an ESLint rules.
By default, inspired and nursery rules are excluded from the migration.
You can use the CLI flags --include-inspired
and --include-nursery
to migrate them as well.
Note that this is a best-effort approach. You are not guaranteed to get the same behavior as ESLint.
Given the following ESLint configuration:
{
"ignore_patterns": ["**/*.test.js"],
"globals": { "var2": "readonly" },
"rules": {
"eqeqeq": "error"
},
"overrides": [{
"files": ["lib/*.js"],
"rules": {
"default-param-last": "off"
}
}]
}
biome migrate eslint --write
changes the Biome configuration as follows:
{
"linter": {
"rules": {
"recommended": false,
"suspicious": {
"noDoubleEquals": "error"
}
}
},
"javascript": { "globals": ["var2"] },
"overrides": [{
"include": ["lib/*.js"],
"linter": {
"rules": {
"style": {
"useDefaultParameterLast": "off"
}
}
}
}]
}
Also, if the working directory contains .eslintignore
, then Biome migrates the glob patterns.
Nested .eslintignore
in subdirectories and negated glob patterns are not supported.
If you find any issue, please don't hesitate to report them.
Contributed by @Conaclos
Added two new options to customise the emitted output of the CLI: --reporter=json
and --reporter=json-pretty
. With --reporter=json
, the diagnostics and the
summary will be printed in the terminal in JSON format. With --reporter=json-pretty
, you can print the same information, but formatted using the same options of your configuration.
NOTE: the shape of the JSON is considered experimental, and the shape of the JSON might change in the future.
<details> <summary>Example of output when running `biome format` command</summary> ```json { "summary": { "changed": 0, "unchanged": 1, "errors": 1, "warnings": 0, "skipped": 0, "suggestedFixesSkipped": 0, "diagnosticsNotPrinted": 0 }, "diagnostics": [ { "category": "format", "severity": "error", "description": "Formatter would have printed the following content:", "message": [ { "elements": [], "content": "Formatter would have printed the following content:" } ], "advices": { "advices": [ { "diff": { "dictionary": " statement();\n", "ops": [ { "diffOp": { "delete": { "range": [0, 2] } } }, { "diffOp": { "equal": { "range": [2, 12] } } }, { "diffOp": { "delete": { "range": [0, 2] } } }, { "diffOp": { "equal": { "range": [12, 13] } } }, { "diffOp": { "delete": { "range": [0, 2] } } }, { "diffOp": { "insert": { "range": [13, 15] } } } ] } } ] }, "verboseAdvices": { "advices": [] }, "location": { "path": { "file": "format.js" }, "span": null, "sourceCode": null }, "tags": [], "source": null } ], "command": "format" } ``` </details>Added new --staged
flag to the check
, format
and lint
subcommands.
This new option allows users to apply the command only to the files that are staged (the
ones that will be committed), which can be very useful to simplify writing git hook scripts
such as pre-commit
. Contributed by @castarco
Improve support of .prettierignore
when migrating from Prettier
Now, Biome translates most of the glob patterns in .prettierignore
to the equivalent Biome ignore pattern.
Only negated glob patterns are not supported.
Contributed by @Conaclos
Support JavaScript configuration files when migrating from Prettier
biome migrate prettier
is now able to migrate Prettier configuration files
ending with js
, mjs
, or cjs
extensions.
To do this, Biome invokes Node.js.
Also, embedded Prettier configurations in package.json
are now supported.
Contributed by @Conaclos
Support overrides
field in Prettier configuration files when migrating from Prettier.
Contributed by @Conaclos
Support passing a file path to the --config-path
flag or the BIOME_CONFIG_PATH
environment variable.
Now you can pass a .json
/.jsonc
file path with any filename to the --config-path
flag or the
BIOME_CONFIG_PATH
environment variable. This will disable the configuration auto-resolution and Biome
will try to read the configuration from the said file path (#2265).
biome format --config-path=../biome.json ./src
Contributed by @Sec-ant
Biome now tags the diagnostics emitted by organizeImports
and formatter
with correct severity levels, so they will be properly filtered by the flag --diagnostic-level
(#2288). Contributed by @Sec-ant
Biome now correctly filters out files that are not present in the current directory when using the --changed
flag #1996. Contributed by @castarco
Biome now skips traversing fifo
or socket
files (#2311). Contributed by @Sec-ant
Biome now resolves configuration files exported from external libraries in extends
from the working directory (CLI) or project root (LSP). This is the documented behavior and previous resolution behavior is considered as a bug (#2231). Contributed by @Sec-ant
Now setting group level all
to false
can disable recommended rules from that group when top level recommended
is true
or unset. Contributed by @Sec-ant
Biome configuration files can correctly extends .jsonc
configuration files now (#2279). Contributed by @Sec-ant
Fixed the JSON schema for React hooks configuration (#2396). Contributed by @arendjr
Biome now displays the location of a parsing error for its configuration file (#1627).
Previously, when Biome encountered a parsing error in its configuration file, it didn't indicate the location of the error. It now displays the name of the configuration file and the range where the error occurred.
Contributed by @Conaclos
options
is no longer required for rules without any options (#2313).
Previously, the JSON schema required to set options
to null
when an object is used to set the diagnostic level of a rule without any option.
However, if options
is set to null
, Biome emits an error.
The schema is now fixed and it no longer requires specifying options
.
This makes the following configuration valid:
{
"linter": {
"rules": {
"style": {
"noDefaultExport": {
"level": "off"
}
}
}
}
}
Contributed by @Conaclos
javascript
language identifier. This is an ad hoc fix, because in the React world, .js
files are allowed to include JSX syntax, and these files are often associated with the javascript
language identifier in most of the editors. Plus, some editor extensions will also associate .jsx
files with the javascript
language identifier. Relative links: discussion, #2085. Contributed by @Sec-antNew rules are incubated in the nursery group. Once stable, we promote them to a stable group. The following rules are promoted:
Add a new option jsxRuntime
to the javascript
configuration. When set to reactClassic
, the noUnusedImports and useImportType rules use this information to make exceptions for the React global that is required by the React Classic JSX transform.
This is only necessary for React users who haven't upgraded to the new JSX transform.
Contributed by @Conaclos and @arendjr
Implement #2043: The React rule useExhaustiveDependencies
is now also compatible with Preact hooks imported from preact/hooks
or preact/compat
. Contributed by @arendjr
Add rule noFlatMapIdentity to disallow unnecessary callback use on flatMap
. Contributed by @isnakode
Add rule noConstantMathMinMaxClamp, which disallows using Math.min
and Math.max
to clamp a value where the result itself is constant. Contributed by @mgomulak
style/useFilenamingConvention now allows prefixing a filename with +
(#2341).
This is a convention used by Sveltekit and Vike.
Contributed by @Conaclos
style/useNamingConvention now accepts PascalCase
for local and top-level variables.
This allows supporting local variables that hold a component or a regular class. The following code is now accepted:
function loadComponent() {
const Component = getComponent();
return <Component />;
}
Contributed by @Conaclos
complexity/useLiteralKeys no longer report computed properties named __proto__
(#2430).
In JavaScript, {["__proto__"]: null}
and {__proto__: null}
have not the same semantic.
The first code set a regular property to null
.
The second one set the prototype of the object to null
.
See the MDN Docs for more details.
The rule now ignores computed properties named __proto__
.
Contributed by @Conaclos
Lint rules useNodejsImportProtocol
, useNodeAssertStrict
, noRestrictedImports
, noNodejsModules
will no longer check declare module
statements anymore. Contributed by @Sec-ant
style/useNamingConvention now accepts any case for variables from object destructuring (#2332).
The following name is now ignored:
const { Strange_Style } = obj;
Previously, the rule renamed this variable. This led to a runtime error.
Contributed by @Conaclos