Biome plugin to warn developers to use app.logger instead of console.

[malewis5]

While working on Bolt apps I am normally reaching for the console to log any info/warn/errors. To keep things consistent I created this custom Biome plugin using Grit. I think this would be a great addition to Bolt's developer experience!

Requirements

Here's an example of the .grit plugin:

// Biome GritQL plugin to warn against console usage and suggest app.logger
or {
    `console.log($args)` as $node where {
        register_diagnostic(
            span = $node,
            message = "Use app.logger.info() instead of console.log()",
            severity = "warn"
        )
    },
    `console.error($args)` as $node where {
        register_diagnostic(
            span = $node,
            message = "Use app.logger.error() instead of console.error()",
            severity = "warn"
        )
    },
    `console.warn($args)` as $node where {
        register_diagnostic(
            span = $node,
            message = "Use app.logger.warn() instead of console.warn()",
            severity = "warn"
        )
    },
    `console.info($args)` as $node where {
        register_diagnostic(
            span = $node,
            message = "Use app.logger.info() instead of console.info()",
            severity = "warn"
        )
    },
    `console.debug($args)` as $node where {
        register_diagnostic(
            span = $node,
            message = "Use app.logger.debug() instead of console.debug()",
            severity = "warn"
        )
    }
}

and here's an example of the warning:

[mwbrooks]

Good morning @malewis5 👋🏻

I love your focus on developer experience! ⚡ 💻 ⚡

How do you imagine the @slack/bolt would export the Biome plugin to developers? I know Biome v2's docs are still getting updated, but right now the examples are mostly focused around a plugin being referenced inside of the project.

[malewis5]

Thanks @mwbrooks! In my project I'm keeping it in a ./biome directory. But there's a way to make this feel more "native" to Bolt.

Simplest, but least "native" would be adding this ./biome directory with the custom plugin to the template/starters. That way developers can start fresh with best practices. This should lead to some devs also adopting it for their current projects. Adding a note about this to the documentation could also lead to more adoption.

To make it feel more "native" to Bolt, you could bundle this rule in the Bolt package and then reference it in the biome.json file with extends. This is similar to other frameworks who ship a tsconfig.json default and then reference it:

 {
    "extends": ["@slack/bolt/biome.json"]
 }

Or maybe just reference the plugin?

{
    "plugins": ["@slack/bolt/biome/no-console.grit"]
}

I would want to strike a balance between "Opinionated ruleset approved by Bolt" and "Easy to remove opinion". Do you have any approach in mind?

[github-actions]

👋 It looks like this issue has been open for 30 days with no activity. We'll mark this as stale for now, and wait 10 days for an update or for further comment before closing this issue out. If you think this issue needs to be prioritized, please comment to get the thread going again! Maintainers also review issues marked as stale on a regular basis and comment or adjust status if the issue needs to be reprioritized.