Biome is a performant linter for JavaScript, TypeScript, and JSX that features more than 200 rules from ESLint, typescript-eslint, and other sources.
It outputs detailed and contextualized diagnostics that help you to improve your code and become a better programmer!
Biome is designed from the start to be used interactively within an editor.
It can format and lint malformed code as you are writing it.
# format files
npx @biomejs/biome format --write ./src
# lint files
npx @biomejs/biome lint ./src
# run format, lint, etc. and apply the safe suggestions
npx @biomejs/biome check --write ./src
# check all files against format, lint, etc. in CI environments
npx @biomejs/biome ci ./src
If you want to give Biome a run without installing it, use the online playground, compiled to WebAssembly.
Documentation
Check out our homepage to learn more about Biome,
or directly head to the Getting Started guide to start using Biome.
More about Biome
Biome has sane defaults and it doesn't require configuration.
Biome has first-class LSP support, with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery.
Biome unifies functionality that has previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelize work, caching, and configuration.
Add --graphql-linter-enabled option, to control whether the linter should be enabled or not for GraphQL files. Contributed by @ematipico
New EXPERIMENTAL search command. The search command allows you to search a Biome project using GritQL syntax.
GritQL is a powerful language that lets you do structural searches on your codebase. This means that trivia such as whitespace or even the type of strings quotes used will be ignored in your search query. It also has many features for querying the structure of your code, making it much more elegant for searching code than regular expressions.
While we believe this command may already be useful to users in some situations (especially when integrated in the IDE extensions!), we also had an ulterior motive for adding this command: We intend to utilize GritQL for our plugin efforts, and by allowing our users to try it out in a first iteration, we hope to gain insight in the type of queries you want to do, as well as the bugs we need to focus on.
For now, the search command is explicitly marked as EXPERIMENTAL, since many bugs remain. Keep this in mind when you try it out, and please let us know your issues!
Note: GritQL escapes code snippets using backticks, but most shells interpret backticks as command invocations. To avoid this, it's best to put single quotes around your Grit queries.
biome search '`console.log($message)`' # find all `console.log` invocations
Contributed by @arendjr and @BackupMiles
The option --max-diagnostics now accept a none value, which lifts the limit of diagnostics shown. Contributed by @ematipico
[
{
"description": "Use === instead of ==. == is only allowed when comparing against `null`",
"check_name": "lint/suspicious/noDoubleEquals",
"fingerprint": "6143155163249580709",
"severity": "critical",
"location": {
"path": "main.ts",
"lines": {
"begin": 4
}
}
}
]
Contributed by @NiclasvanEyk
Add new options to the lsp-proxy and start commands:
--log-path: a directory where to store the daemon logs. The commands also accepts the environment variable BIOME_LOG_PATH.
--log-prefix-name: a prefix that's added to the file name of the logs. It defaults to server.log. The commands also accepts the environment variable BIOME_LOG_PREFIX_NAME.
@Contributed by @ematipico
Enhancements
When a --reporter is provided, and it's different from the default one, the value provided by via --max-diagnostics is ignored and the limit is lifted. Contributed by @ematipico
biome init now generates a new config file with more options set.
This change intends to improve discoverability of the options and to set the more commonly used options to their default values.
Contributed by @Conaclos
The --verbose flag now reports the list of files that were evaluated, and the list of files that were fixed.
The evaluated files are the those files that can be handled by Biome, files that are ignored, don't have an extension or have an extension that Biome can't evaluate are excluded by this list.
The fixed files are those files that were handled by Biome and changed. Files that stays the same after the process are excluded from this list.
Allow passing nursery to the --only and --skip filters.
The --only option allows you to run a given rule or rule group.
The --skip option allows you to skip the execution of a given group or a given rule.
Previously, it was not possible to pass nursery.
This restriction is now removed, as it may make sense to skip the nursery rules that a project has enabled.
Contributed by @Conaclos
The CLI now returns an error code when calling a command in stdin mode, and the contents of the files aren't fixed. For example, the following example will result in an error code of 1 because the lint command triggers some lint rules:
echo "let x = 1" | biome lint --stdin-file-path=stdin.js
Contributed by @ematipico
Bug fixes
biome lint --write now takes --only and --skip into account (#3470). Contributed by @Conaclos
Fix #3368, now the reporter github tracks the diagnostics that belong to formatting and organize imports. Contributed by @ematipico
Fix #3545, display a warning, 'Avoid using unnecessary Fragment,' when a Fragment contains only one child element that is placed on a new line. Contributed by @satojin219
Migrating from Prettier or ESLint no longer overwrite the overrides field from the configuration (#3544). Contributed by @Conaclos
Fix JSX expressions for noAriaHiddenOnFocusable (#3708). Contributed by @anthonyshew
Fix edge case for <canvas> elements that use role="img" (#3728). Contributed by @anthonyshew
Fix #3633, where diagnostics where incorrectly printed if the code has errors. Contributed by @ematipico
Allow aria-label on heading to prevent useHeadingContent diagnostic (#3767). Contributed by @anthonyshew
Fix edge case #3791 for rule noFocusedTests being used with non-string-like expressions (#3793). Contributed by @h-a-n-a
Fix optional ARIA properties for role="separator" in useAriaPropsForRole (#3856). Contributed by @anthonyshew
Configuration
Add support for loading configuration from .editorconfig files (#1724).
Configuration supplied in .editorconfig will be overridden by the configuration in biome.json. Support is disabled by default and can be enabled by adding the following to your formatter configuration in biome.json:
{
"formatter": {
"useEditorconfig": true
}
}
Contributed by @dyc3
overrides from an extended configuration is now merged with the overrides of the extension.
Given the following shared configuration biome.shared.json:
Keep the parentheses around infer ... extends declarations in type unions and type intersections (#3419). Contributed by @Conaclos
Keep parentheses around a yield expression inside a type assertion.
Previously, Biome removed parentheses around some expressions that require them inside a type assertion.
For example, in the following code, Biome now preserves the parentheses.
function* f() {
return <T>(yield 0);
}
Contributed by @Conaclos
Remove parentheses around expressions that don't need them inside a decorator.
Biome now matches Prettier in the following cases:
class {
- @(decorator)
+ @decorator
method() {}
},
class {
- @(decorator())
+ @decorator()
method() {}
},
class {
@(decorator?.())
method() {}
},
Contributed by @Conaclos
Keep parentheses around objects preceded with a @satisfies comment.
In the following example, parentheses are no longer removed.
The rule no longer reports type-only imports such as:
import type assert from "assert";
import type * as assert2 from "assert";
Contributed by @Conaclos
noRedundantUseStrict no longer reports "use strict" directives when the package.json marks explicitly the file as a script using the field "type": "commonjs". Contributed by @ematipico
noStaticOnlyClass no longer reports a class that extends another class (#3612). Contributed by @errmayank
This allows to report a type that is unused because it isn't exported.
Global declarations files (declarations files without exports and imports) are still ignored.
unicase letters have a single case: they are neither uppercase nor lowercase.
Biome now accepts filenames in unicase.
For example, the filename 안녕하세요 is now accepted.
We still reject a name that mixes unicase characters with lowercase or uppercase characters.
For example, the filename A안녕하세요 is rejected.
This change also fixes #3353.
Filenames consisting only of numbers are now accepted.
An empty export {} allows you to force TypeScript to consider a file with no imports and exports as an EcmaScript module.
While export type {} is valid, it is more common to use export {}.
Users may find it confusing that the linter asks them to convert it to export type {}.
Also, a bundler should be able to remove export {} as well as export type {}.
So it is not so useful to report export {}.
The following import is no longer reported by the rule:
import * as mod from "my-package";
Contributed by @Conaclos
Fix [#3149] crashes that occurred when applying the noUselessFragments unsafe fixes in certain scenarios. Contributed by @unvalley
noRedeclare no longer reports a variable named as the function expression where it is declared. Contributed by @Conaclos
useAdjacentOverloadSignatures no longer reports a #private class member and a public class member that share the same name (#3309).
The following code is no longer reported:
class C {
#f() {}
g() {}
f() {}
}
Contributed by @Conaclos
useAltText n olonger requests alt text for elements hidden from assistive technologies (#3316). Contributed by @robintown
useNamingConvention now accepts applying custom convention on abstract classes. Contributed by @Conaclos
useNamingConvention no longer suggests an empty fix when a name doesn't match strict Pascal case (#3561).
Previously the following code led useNamingConvention to suggest an empty fix.
The rule no longer provides a fix for this case.
type AAb = any
Contributed by @Conaclos
useNamingConvention no longer provides fixes for global TypeScript declaration files.
Global TypeScript declaration files have no epxorts and no imports.
All the declared types are available in all files of the project.
Thus, it is not safe to propose renaming only in the declaration file.
Contributed by @Conaclos
useSortedClasses lint error with Template literals (#3394). Contributed by @hangaoke1
Properties that expect a string now accept arbitrary text.
An identifiers can now be made up of any characters except ASCII whitespace.
An identifier list can now be separated by any ASCII whitespace.
Contributed by @Conaclos
Parser
Enhancements
The JSON parser now allows comments in turbo.json and jest.config.json. Contributed by @Netail and @Conaclos
The JSON parser now allows comments in files with the .json extension under the .vscode and .zed directories.
Biome recognizes are well known JSON files that allows comments and/or trailing commas.
Previously, Biome did not recognize JSON files under the .vscode and the .zed directories as JSON files that allow comments.
You had to configure Biome to recognize them:
Biome is a toolchain for the web: formatter, linter and more
The npm package @biomejs/biome receives a total of 740,137 weekly downloads. As such, @biomejs/biome popularity was classified as popular.
We found that @biomejs/biome demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 0 open source maintainers collaborating on the project.
Package last updated on 12 Sep 2024
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.