@biomejs/biome
Advanced tools
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
Changelog
1.6.4 (2024-04-03)
recommended
or all
is false
(#2191). Contributed by @Sec-antquickfix.biome
is enabled and some import
-related rules are applied (#2222, #688, #1015). Contributed by @Sec-antFix #2211. noChildrenProp should work fine when children pass as a prop in a new line. Contributed by @fireairforce
Fix #2248. lint/a11y/useButtonType
should not trigger when button element with spread attribute. Contributed by @fireairforce
Fix #2216. lint/style/useNamingConvention
should not ignore JSX Component name binding. Contributed by @fireairforce
useSortedClasses
. Contributed by @ematipicoThe parser doesn't throw any error when the frontmatter of .astro
files contains an illegal return:
---
const condition = true;
if (condition) {
return "Something";
}
---
<div></div>
Contributed by @ematipico
Changelog
1.6.3 (2024-03-25)
Fix configuration resolution. Biome is now able to correctly find the biome.jsonc
configuration file when --config-path
is explicitly set (#2164). Contributed by @Sec-ant
JavaScript/TypeScript files of different variants (.ts
, .js
, .tsx
, .jsx
) in a single workspace now have stable formatting behaviors when running the CLI command in paths of different nested levels or in different operating systems (#2080, #2109). Contributed by @Sec-ant
formatter.lineEnding
, [language].formatter.lineEnding
, formatter.attributePosition
and javascript.formatter.attributePosition
. Contributed by @Sec-antany
type through reassignments. Contributed by @fujiyamaorangenoSemicolonInJsx
to noSuspiciousSemicolonInJsx
. Contributed by @fujiyamaorangelinter
is disabled (#2161). Contributed by @Sec-antChangelog
1.6.2 (2024-03-22)
The noSuperWithoutExtends
rule now allows for calling super()
in derived class constructors of class expressions (#2108). Contributed by @Sec-ant
Fix discrepancies on file source detection. Allow module syntax in .cts
files (#2114). Contributed by @Sec-ant
Fixes #2131, where folders were incorrectly ignored when running the command check
. Now folders are correctly ignored based on their command. Contributed by @ematipico
Smoother handling of "endOfLine": "auto"
in prettier migration: falling back to "lf"
(#2145). Contributed by @eMerzh
all
and recommend
presets in top-level and group-level configs is now correctly respected. More details can be seen in (#2072) (#2028). Contributed by @Sec-antlintContent
method of the Biome
class (#1956). Contributed by @mnahkiesRule noUndeclaredDependencies
now also validates peerDependencies
and optionalDependencies
(#2122). Contributed by @Sec-ant
Rule noUndeclaredDependencies
won't check declare module
statements anymore (#2123). Contributed by @Sec-ant
Fix #1925. The fix for useOptionalChain
would sometimes suggest an incorrect fix that discarded optional chaining operators on the left-hand side of logical expressions. These are now preserved. Contributed by @arendjr
Rule noUndeclaredVariables
now also checks for worker globals (#2121). Contributed by @Sec-ant
Correctly parse .jsonc
files. Contributed by @Sec-ant
Correctly resolve external extends
configs. Contributed by @Sec-ant
Changelog
1.6.1 (2024-03-12)
biome.jsonc
(#2008). Contributed by @Sec-antjson.formatter.trailingCommas
option now works in overrides
(#2009). Contributed by @Sec-antAdd rule noDoneCallback, this rule checks the function parameter of hooks & tests for use of the done argument, suggesting you return a promise instead. Contributed by @vasucp1207
beforeEach(done => {
// ...
});
useJsxKeyInIterable now recognizes function bodies wrapped in parentheses (#2011). Contributed by @Sec-ant
useShorthandFunctionType now preserves type parameters of generic interfaces when applying fixes (#2015). Contributed by @Sec-ant
Code fixes of useImportType and useExportType now handle multiline statements (#2041). Contributed by @Conaclos
noRedeclare no longer reports type parameter and parameter with identical names (#1992).
The following code is no longer reported:
function f<a>(a: a) {}
Contributed by @Conaclos
noRedeclare now reports duplicate type parameters in a same declaration.
The following type parameters are now reported as a redeclaration:
function f<T, T>() {}
Contributed by @Conaclos
noUndeclaredDependencies now recognizes imports of subpath exports.
E.g., the following import statements no longer report errors if @mui/material
and tailwindcss
are installed as dependencies:
import Button from "@mui/material/Button";
import { fontFamily } from "tailwindcss/defaultTheme";
Contributed by @Sec-ant
JavaScript lexer is now able to lex regular expression literals with escaped non-ascii chars (#1941).
Contributed by @Sec-ant