@biomejs/biome
Advanced tools
Changelog
v1.8.3 (2024-06-27)
Fix #3104 by suppressing node warnings when using biome migrate
. Contributed by @SuperchupuDev
Force colors to be off when using the GitHub reporter to properly create annotations in GitHub actions (#3148). Contributed by @Sec-ant
nursery/useDeprecatedReason
rule. Contributed by @vohoanglong0107.useImportExtensions
rule. Contributed by @drdaemosuseConsistentArrayType
and useShorthandArrayType
now ignore Array
in the extends
and implements
clauses. Fix #3247. Contributed by @Conaclospackage.json
. Contributed by @ematipicouseArrowFunction
rule now preserves a trailing comma when there is only a single type parameter in the arrow function and JSX is enabled. Fixes #3292. Contributed by @Sec-antEnhance tailwind sorting lint rule #1274 with variant support.
Every preconfigured variant is assigned a weight
that concurs on establishing the output sorting order.
Since nesting variants on the same utility class is possible, the resulting weight
is the Bitwise XOR of all the variants weight for that class.
Dynamic variants (e.g. has-[.custom-class]
, group-[:checked]
) are also supported and they take the weight
of their base variant name the custom value attached (e.g. has-[.custom-class]
takes has
weight).
Arbitrary variants (e.g. [&nth-child(2)]
) don't have a weight assigned and they are placed after every known variant.
Classes with the same amount of arbitrary variants follow lexicographical order. The class that has the highest number of nested arbitrary variants is placed last.
Screen variants (e.g. sm:
, max-md:
, min-lg:
) are not supported yet.
Contributed by @lutaok
Changelog
v1.8.2 (2024-06-20)
biome migrate
and thus choke the parser. Contributed by @Sec-antReword the reporter message No fixes needed
to No fixes applied
.
The former message is misleading when there're still errors or warnings in the files that should be taken care of manually. For example:
Checked 2 files in <TIME>. No fixes needed.
Found 2 errors.
The new message suits better in these cases.
Contributed by @Sec-ant
Don't conceal previous overrides (#3176).
Previously, each override inherited the unset configuration of the base configuration. This means that setting a configuration in an override can be concealed by a subsequent override that inherits of the value from the base configuration.
For example, in the next example, noDebugger
was disabled for the index.js
file.
{
"linter": {
"rules": {
"suspicious": { "noDebugger": "off" }
}
},
"overrides": [
{
"include": ["index.js"],
"linter": {
"rules": {
"suspicious": { "noDebugger": "warn" }
}
}
}, {
"include": ["index.js"],
"linter": {
"rules": {
"suspicious": { "noDoubleEquals": "off" }
}
}
}
]
}
The rule is now correctly enabled for the index.js
file.
Contributed by @Conaclos
v1.8.0
Add nursery/noSubstr. Contributed by @chansuke
Add nursery/useConsistentCurlyBraces. Contributed by @dyc3
Add nursery/useValidAutocomplete. Contributed by @unvalley
Add nursery/noShorthandPropertyOverrides. #2958 Contributed by @neokidev
Fix [#3084] false positive by correctly recognize parenthesized return statement. Contributed by @unvalley
useImportExtensions now suggests a correct fix for import '.'
and import './.'
. Contributed by @minht11
Fix useDateNow false positive when new Date object has arguments new Date(0).getTime()
. Contributed by @minht11.
The noUnmatchableAnbSelector
rule is now able to catch unmatchable an+b
selectors like 0n+0
or -0n+0
. Contributed by @Sec-ant.
The useHookAtTopLevel
rule now recognizes properties named as hooks like foo.useFoo()
. Contributed by @ksnyder9801
Fix #3092, prevent warning for Custom properties (--*)
. Contributed by @chansuke
Fix a false positive in the useLiteralKeys
rule. (#3160)
This rule now ignores the following kind of computed member name:
const a = {
[`line1
line2`]: true,
};
Contributed by @Sec-ant
The noUnknownProperty rule now ignores the composes
property often used in css modules. #3000 Contributed by @chansuke
Fix false positives of the useExhaustiveDependencies rule.
The component itself is considered stable when it is used recursively inside a hook closure defined inside of it:
import { useMemo } from "react";
function MyRecursiveComponent() {
// MyRecursiveComponent is stable, we don't need to add it to the dependencies list.
const children = useMemo(() => <MyRecursiveComponent />, []);
return <div>{children}</div>;
}
Also, export default function
and export default class
are considered stable now because they can only appear at the top level of a module.
Contributed by @Sec-ant
Fix missing withDefaults
macro in vue files for globals variables. Contributed by @Shyam-Chen
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