Plugins de linter

Biome Linter soporta plugins GritQL. Actualmente, estos plugins permiten ajustar patrones de código específicos y registrar mensajes de diagnóstico personalizados para ellos.

Este es un ejemplo de un plugin que informa de todos los usos de Object.assign():

1
`$fn($args)` where {
2
    $fn <: `Object.assign`,
3
    register_diagnostic(
4
        span = $fn,
5
        message = "Prefer object spread instead of `Object.assign()`"
6
    )
7
}

Puedes poner un fragmento GritQL en un archivo en cualquier parte de tu proyecto, pero ten cuidado de usar la extensión .grit. Luego, puedes simplemente habilitarlo como un plugin con la siguiente configuración:

1
{
2
  "plugins": ["./ruta-al-plugin.grit"]
3
}

El plugin estará ahora habilitado en todos los archivos soportados en los que se ejecute el linter. Puedes ver sus resultados al ejecutar biome lint o biome check. Por ejemplo:

1
$ biome lint
2
/packages/tailwindcss-config-analyzer/src/introspect.ts:12:17 plugin ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
3

4
  ✖ Prefer object spread instead of `Object.assign()`
5

6
    10 │ function createContextFromConfig(config: Partial<Config>) {
7
    11 │        return createContext(
8
  > 12 │                resolveConfig(Object.assign({}, DEFAULT_CONFIG, config)),
9
       │                              ^^^^^^^^^^^^^
10
    13 │        );
11
    14 │ }

Lenguas de objetivo

Un fragmento GritQL siempre intenta coincidir con un idioma de destino determinado. Si no se especifica ningún idioma de destino, se asume JavaScript o uno de sus superlenguajes.

Si deseas utilizar una lengua de destino diferente, debes especificarlo explícitamente. Por ejemplo, aquí hay un plugin CSS para informar de cualquier selector que establezca un color fuera de las clases permitidas .color-*.:

1
language css;
2

3
`$selector { $props }` where {
4
    $props <: contains `color: $color` as $rule,
5
    not $selector <: r"\.color-.*",
6
    register_diagnostic(
7
        span = $rule,
8
        message = "Don't set explicit colors. Use `.color-*` classes instead."
9
    )
10
}

Actualmente no admitimos más lenguajes de destino que JavaScript y CSS.

API de plugins

Además de las funciones incorporadas de Grit, Biome admite actualmente una función adicional:

`register_diagnostic()`

Registra un diagnóstico que se notificará siempre que el patrón coincida.

Apoya tres argumentos:

span (obligatorio): El nodo sintáctico al que adjuntar el diagnóstico. Se trata normalmente de una variable que se empareja dentro de un fragmento de código.
message (obligatorio): El mensaje a mostrar con el diagnóstico.
severity: La gravedad del diagnóstico. Los valores permitidos son: hint, info, warn, y error. Por defecto, se utilizaerror.