@rmtc/plugin-biome v2.0.1
@rmtc/plugin-biome
A Biome plugin for @rmtc/toolchain.
!WARNING This project is intended for use in @rowanmanning's projects. It's free to use but I don't offer support for use-cases outside of what I need.
Table of Contents
Requirements
This library requires the following to run:
Usage
Install the module with npm:
npm install --save-dev @rmtc/plugin-biome
Include it in your .rmtc.json
file:
{
plugins: [
// ...
'@rmtc/plugin-biome'
]
// ...
}
Workflows
This plugin defines the following workflows:
format
: a general workflow used to automatically format code.verify
: a general workflow used to verify code quality.
Steps
This plugin defines the following steps that can be added to any workflow:
biome:format
: run thebiome format
command-line tool on the whole project with the--write
flag, so that formatting changes are applied in place.biome:lint
: run thebiome lint
command-line tool on the whole project.
E.g. if you prefer to define a lint
workflow, use the following:
{
plugins: ['@rmtc/plugin-biome'],
workflows: {
lint: ['biome:lint']
}
}
Configuration
This plugin provides no additional configuration. To configure the way that the biome
command-line tool runs, you should use one of the configuration methods that they suggest.
Contributing
See the central README for a contribution guide and code of conduct.
License
Licensed under the MIT license. Copyright © 2023, Rowan Manning