Merge pull request #24 from SigNoz/chore/biome-setup

chore: migrate from ESLint and Prettier to Biome for linting and formatting

Author: YounixM

.changeset/config.json

@@ -1,11 +1,11 @@
 {
-    "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
-    "changelog": "@changesets/cli/changelog",
-    "commit": false,
-    "fixed": [],
-    "linked": [],
-    "access": "restricted",
-    "baseBranch": "main",
-    "updateInternalDependencies": "patch",
-    "ignore": []
+ "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
+ "changelog": "@changesets/cli/changelog",
+ "commit": false,
+ "fixed": [],
+ "linked": [],
+ "access": "restricted",
+ "baseBranch": "main",
+ "updateInternalDependencies": "patch",
+ "ignore": []
 }

.eslintrc.js

@@ -1,16 +1,16 @@
-import type { StorybookConfig } from "@storybook/react-vite";
+import type { StorybookConfig } from '@storybook/react-vite';
 
 const config: StorybookConfig = {
-  stories: ["../stories/**/*.stories.@(js|jsx|ts|tsx)"],
-  addons: ["@storybook/addon-a11y", "@storybook/addon-docs"],
-  framework: {
-    name: "@storybook/react-vite",
-    options: {},
-  },
-  typescript: {
-    check: false,
-    reactDocgen: false,
-  },
+ stories: ['../stories/**/*.stories.@(js|jsx|ts|tsx)'],
+ addons: ['@storybook/addon-a11y', '@storybook/addon-docs'],
+ framework: {
+  name: '@storybook/react-vite',
+  options: {},
+ },
+ typescript: {
+  check: false,
+  reactDocgen: false,
+ },
 };
 
 export default config;

.prettierrc

@@ -1,19 +1,19 @@
-import React from "react";
+import React from 'react';
 
 /** @type { import('@storybook/react-vite').Preview } */
 const preview = {
-  parameters: {
-    layout: "padded",
-    controls: { hideNoControlsWarning: true },
-  },
-  decorators: [
-    (Story) =>
-      React.createElement(
-        "div",
-        { style: { fontFamily: "'Inter', system-ui, sans-serif" } },
-        React.createElement(Story)
-      ),
-  ],
+ parameters: {
+  layout: 'padded',
+  controls: { hideNoControlsWarning: true },
+ },
+ decorators: [
+  (Story) =>
+   React.createElement(
+    'div',
+    { style: { fontFamily: "'Inter', system-ui, sans-serif" } },
+    React.createElement(Story),
+   ),
+ ],
 };
 
 export default preview;

.storybook/main.ts

@@ -0,0 +1,51 @@
+{
+ "$schema": "https://biomejs.dev/schemas/2.4.3/schema.json",
+ "vcs": {
+  "enabled": true,
+  "clientKind": "git",
+  "useIgnoreFile": true
+ },
+ "files": {
+  "includes": ["**", "!dist", "!src", "!assets", "!**/*.svg"]
+ },
+ "formatter": {
+  "enabled": true,
+  "indentStyle": "space",
+  "indentWidth": 1,
+  "lineWidth": 100
+ },
+ "javascript": {
+  "formatter": {
+   "quoteStyle": "single",
+   "trailingCommas": "all",
+   "semicolons": "always"
+  }
+ },
+ "linter": {
+  "enabled": true,
+  "rules": {
+   "recommended": true,
+   "correctness": {
+    "useExhaustiveDependencies": "warn"
+   },
+   "style": {
+    "useImportType": "off"
+   },
+   "a11y": {
+    "useKeyWithClickEvents": "off"
+   }
+  }
+ },
+ "overrides": [
+  {
+   "includes": ["*.config.js", "*.config.cjs", "*.config.mjs"],
+   "linter": {
+    "rules": {
+     "suspicious": {
+      "noExplicitAny": "off"
+     }
+    }
+   }
+  }
+ ]
+}

.storybook/preview.js

@@ -1,3 +1,3 @@
 module.exports = {
-    extends: ['@commitlint/config-conventional'],
-  };
+ extends: ['@commitlint/config-conventional'],
+};

biome.json

@@ -1,19 +1,19 @@
-const path = require("path");
+const path = require('node:path');
 
 /**
  * SVGR index template: generates src/index.ts with named exports.
  * Component names starting with a number get an "Icon" prefix (e.g. 42.svg -> Icon42).
  */
 function indexTemplate(filePaths) {
-  const exportEntries = filePaths
-    .filter((entry) => entry && (entry.path != null || entry.originalPath != null))
-    .map((entry) => {
-      const filePath = entry.path ?? entry.originalPath;
-      const basename = path.basename(filePath, path.extname(filePath));
-      const exportName = /^\d/.test(basename) ? `Icon${basename}` : basename;
-      return `export { default as ${exportName} } from './${basename}'`;
-    });
-  return exportEntries.join("\n");
+ const exportEntries = filePaths
+  .filter((entry) => entry && (entry.path != null || entry.originalPath != null))
+  .map((entry) => {
+   const filePath = entry.path ?? entry.originalPath;
+   const basename = path.basename(filePath, path.extname(filePath));
+   const exportName = /^\d/.test(basename) ? `Icon${basename}` : basename;
+   return `export { default as ${exportName} } from './${basename}'`;
+  });
+ return exportEntries.join('\n');
 }
 
 module.exports = indexTemplate;

commitlint.config.js

@@ -15,27 +15,30 @@
  ],
  "scripts": {
   "prebuild": "pnpm run precheck",
-  "precheck": "pnpm run clean && pnpm run lint ",
+  "precheck": "pnpm run clean && pnpm run lint",
   "clean": "rimraf src && rimraf dist",
   "build": "pnpm run svgr && rollup -c",
   "svgr": "rimraf src && svgr --typescript  --replace-attr-values '#1D1D1D=currentColor' --template ./svgr-template.js --index-template ./index-template.cjs -d src -- assets",
-  "lint": "eslint .",
+  "lint": "biome check .",
+  "lint:fix": "biome check --write .",
   "type-check": "tsc --noEmit",
   "commitlint": "commitlint --edit",
-  "format": "prettier --write .",
-  "format:check": "prettier --check .",
+  "format": "biome format --write .",
+  "format:check": "biome format .",
   "changeset": "changeset",
   "version": "changeset version",
   "release": "pnpm run build && changeset publish",
   "storybook": "pnpm run svgr && storybook dev -p 6006",
-  "build-storybook": "pnpm run svgr && storybook build"
+  "build-storybook": "pnpm run svgr && storybook build",
+  "update:browserslist": "pnpm dlx update-browserslist-db@latest"
  },
  "license": "MIT",
  "devDependencies": {
   "@babel/plugin-transform-runtime": "^7.22.5",
   "@babel/preset-env": "^7.16.4",
   "@babel/preset-react": "^7.16.0",
   "@babel/traverse": "^7.25.6",
+  "@biomejs/biome": "^2.4.3",
   "@changesets/cli": "^2.27.8",
   "@rollup/plugin-babel": "^5.3.0",
   "@rollup/plugin-typescript": "^12.1.2",
@@ -45,18 +48,9 @@
   "@storybook/react-vite": "^10.2.10",
   "@svgr/cli": "^6.1.2",
   "@types/react": "^18.2.0",
-  "@typescript-eslint/eslint-plugin": "^5.59.11",
-  "@typescript-eslint/parser": "^5.59.11",
   "chromatic": "^15.1.1",
-  "eslint": "^8.42.0",
-  "eslint-config-prettier": "^10.0.1",
-  "eslint-import-resolver-node": "^0.3.9",
-  "eslint-plugin-import": "^2.31.0",
-  "eslint-plugin-react": "^7.37.4",
-  "eslint-plugin-storybook": "10.2.10",
   "husky": "^8.0.3",
   "lint-staged": "^15.5.1",
-  "prettier": "^2.8.8",
   "react": "^18.2.0",
   "react-dom": "^18.2.0",
   "rimraf": "^3.0.2",
@@ -74,9 +68,8 @@
   "@commitlint/config-conventional": "^17.6.7"
  },
  "lint-staged": {
-  "*.{js,jsx,ts,tsx}": [
-   "prettier --write",
-   "eslint --fix"
+  "*.{js,jsx,ts,tsx,json,jsonc}": [
+   "biome check --write"
   ]
  },
  "resolutions": {
@@ -88,11 +81,5 @@
    "react": "^18.2.0",
    "react-dom": "^18.2.0"
   }
- },
- "eslintIgnore": [
-  "dist/**",
-  "src/**",
-  "assets/**",
-  "*.svg"
- ]
+ }
 }