@nedcloarbr/biome-config

BiomeJS Configuration used by NedcloarBR in their projects

Table of Contents

• Description
• Installation
• Usage
• To-Do

Description

Configuring a linter and formatter, such as BiomeJS, is crucial for maintaining consistent, readable, and error-free code. Linters ensure uniform coding standards and early error detection, saving debugging time. Formatters automate code structuring, enhancing readability and maintenance. These tools increase productivity by allowing developers to focus on critical tasks. They also enforce quality standards, creating a professional development environment. In CI/CD workflows, they ensure code adherence to quality standards, preserving codebase integrity.

The package includes configuration for:

• NestJS
• React
  • Vite
  • NextJS

Installation

You can use the following command to install this package.

npm install --save-dev --save-exact @biomejs/biome @nedcloarbr/biome-config
yarn add --dev --exact @biomejs/biome @nedcloarbr/biome-config
pnpm install --save-dev --save-exact @biomejs/biome @nedcloarbr/biome-config
bun add --dev --exact @biomejs/biome @nedcloarbr/biome-config

[!WARNING] At the moment BiomeJS doesn't support Yarn PnP completely
Discussion for add this support: https://github.com/biomejs/biome/discussions/3393
If you're using Yarn Classic (v1.x) you don't have to worry about this
To opt out of using PnP in Yarn Modern (^v2.x), do the following

# .yarnrc.yml
+ nodeLinker: node-modules

Usage

NodeJS

# biome.json
+ extends: ["@nedcloabr/biome-config"]

or

# biome.json
+ extends: ["@nedcloabr/biome-config/base"]

NestJS

This config includes base config

# biome.json
+  "extends": ["@nedcloarbr/biome-config/nestjs"]

React

This config includes base config

# biome.json
+  "extends": ["@nedcloarbr/biome-config/react"]

If you're in a Vite Project
Install this Vite Plugin and follow the configuration guide

If you're in a NextJS Project
You will need to disable eslint checking since NextJS doesn't support Biome natively yet

# next.config.js
+  eslint: {
+    ignoreDuringBuilds: true,
+  }

Ignore (an array of commonly ignored folders)

This config don't includes base config

# biome.json
+  "extends": ["@nedcloarbr/biome-config/ignore"]

To-Do

Add support for other types of projects

• Configs

  • [x] ReactJS
    • [x] Vanilla
    • [x] Vite
    • [x] NextJS
  • [x] NodeJS
    • [x] Vanilla
    • [x] TypeScript

• Repository

  • [ ] Fix cliff for generate changelogs correctly