fix: Migrate to Biome (#27150)

Author: Nerivec

.github/workflows/ci.yml

@@ -30,14 +30,14 @@ jobs:
                   cache: pnpm
 
             - name: Install dependencies
-              run: pnpm install --frozen-lockfile
-
-            - name: Build
-              run: pnpm run build
+              run: pnpm i --frozen-lockfile
 
             - name: Check
               run: pnpm run check
 
+            - name: Build
+              run: pnpm run build
+
             - name: Test
               run: pnpm run test:coverage
 

.prettierignore

@@ -107,7 +107,7 @@ Zigbee2MQTT is made up of three modules, each developed in its own Github projec
 Zigbee2MQTT uses TypeScript (partially for now). Therefore after making changes to files in the `lib/` directory you need to recompile Zigbee2MQTT. This can be done by executing `pnpm run build`. For faster development instead of running `pnpm run build` you can run `pnpm run build-watch` in another terminal session, this will recompile as you change files.
 
 Before running any of the commands, you'll first need to run `pnpm install --include=dev`.
-Before submitting changes run `pnpm run test:coverage`, `pnpm run pretty:check` and `pnpm run eslint`
+Before submitting changes run `pnpm run check:w` then `pnpm run test:coverage`.
 
 ## Supported devices
 

.prettierrc

@@ -0,0 +1,86 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "vcs": {
+        "enabled": true,
+        "clientKind": "git",
+        "useIgnoreFile": true
+    },
+    "formatter": {
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineWidth": 150,
+        "bracketSpacing": false
+    },
+    "linter": {
+        "ignore": [],
+        "rules": {
+            "correctness": {
+                "noUnusedImports": "error",
+                "noUnusedVariables": {
+                    "level": "warn",
+                    "fix": "none"
+                }
+            },
+            "style": {
+                "noParameterAssign": "off",
+                "useThrowNewError": "error",
+                "useThrowOnlyError": "error",
+                "useNamingConvention": {
+                    "level": "error",
+                    "options": {
+                        "strictCase": false,
+                        "conventions": [
+                            {
+                                "selector": {
+                                    "kind": "objectLiteralProperty"
+                                },
+                                "formats": ["snake_case", "camelCase", "CONSTANT_CASE", "PascalCase"]
+                            },
+                            {
+                                "selector": {
+                                    "kind": "const"
+                                },
+                                "formats": ["snake_case", "camelCase", "CONSTANT_CASE", "PascalCase"]
+                            },
+                            {
+                                "selector": {
+                                    "kind": "typeProperty"
+                                },
+                                "formats": ["snake_case", "camelCase", "CONSTANT_CASE", "PascalCase"]
+                            },
+                            {
+                                "selector": {
+                                    "kind": "enumMember"
+                                },
+                                "formats": ["CONSTANT_CASE", "PascalCase"]
+                            }
+                        ]
+                    }
+                }
+            },
+            "performance": {
+                "noDelete": "off"
+            },
+            "suspicious": {
+                "noConstEnum": "off",
+                "useAwait": "error"
+            }
+        }
+    },
+    "overrides": [
+        {
+            "include": ["test/**"],
+            "linter": {
+                "rules": {
+                    "style": {
+                        "noNonNullAssertion": "off",
+                        "useNamingConvention": "off"
+                    },
+                    "suspicious": {
+                        "noImplicitAnyLet": "off"
+                    }
+                }
+            }
+        }
+    ]
+}

README.md

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
-const path = require('path');
-process.env['ZIGBEE2MQTT_DATA'] = process.env['ZIGBEE2MQTT_DATA'] || path.join(process.env['HOME'], '.z2m');
-require('./index');
+const path = require("node:path");
+process.env.ZIGBEE2MQTT_DATA = process.env.ZIGBEE2MQTT_DATA || path.join(process.env.HOME, ".z2m");
+require("./index");

biome.json

@@ -1,29 +1,29 @@
-const semver = require('semver');
-const engines = require('./package.json').engines;
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const {exec} = require('child_process');
-require('source-map-support').install();
+const semver = require("semver");
+const engines = require("./package.json").engines;
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+const {exec} = require("node:child_process");
+require("source-map-support").install();
 
 let controller;
 let stopping = false;
-let watchdog = process.env.Z2M_WATCHDOG != undefined;
+const watchdog = process.env.Z2M_WATCHDOG != null;
 let watchdogCount = 0;
 let unsolicitedStop = false;
 // csv in minutes, default: 1min, 5min, 15min, 30min, 60min
 let watchdogDelays = [2000, 60000, 300000, 900000, 1800000, 3600000];
 
-if (watchdog && process.env.Z2M_WATCHDOG !== 'default') {
+if (watchdog && process.env.Z2M_WATCHDOG !== "default") {
     if (/^\d+(.\d+)?(,\d+(.\d+)?)*$/.test(process.env.Z2M_WATCHDOG)) {
-        watchdogDelays = process.env.Z2M_WATCHDOG.split(',').map((v) => parseFloat(v) * 60000);
+        watchdogDelays = process.env.Z2M_WATCHDOG.split(",").map((v) => Number.parseFloat(v) * 60000);
     } else {
         console.log(`Invalid watchdog delays (must use number-only CSV format representing minutes, example: 'Z2M_WATCHDOG=1,5,15,30,60'.`);
         process.exit(1);
     }
 }
 
-const hashFile = path.join(__dirname, 'dist', '.hash');
+const hashFile = path.join(__dirname, "dist", ".hash");
 
 async function triggerWatchdog(code) {
     const delay = watchdogDelays[watchdogCount];
@@ -58,11 +58,11 @@ async function exit(code, restart = false) {
 
 async function currentHash() {
     return await new Promise((resolve) => {
-        exec('git rev-parse --short=8 HEAD', (error, stdout) => {
+        exec("git rev-parse --short=8 HEAD", (error, stdout) => {
             const commitHash = stdout.trim();
 
-            if (error || commitHash === '') {
-                resolve('unknown');
+            if (error || commitHash === "") {
+                resolve("unknown");
             } else {
                 resolve(commitHash);
             }
@@ -81,26 +81,26 @@ async function build(reason) {
 
     return await new Promise((resolve, reject) => {
         const env = {...process.env};
-        const _600mb = 629145600;
+        const mb600 = 629145600;
 
-        if (_600mb > os.totalmem() && !env.NODE_OPTIONS) {
+        if (mb600 > os.totalmem() && !env.NODE_OPTIONS) {
             // Prevent OOM on tsc compile for system with low memory
             // https://github.com/Koenkk/zigbee2mqtt/issues/12034
-            env.NODE_OPTIONS = '--max_old_space_size=256';
+            env.NODE_OPTIONS = "--max_old_space_size=256";
         }
 
         // clean build, prevent failures due to tsc incremental building
-        exec('pnpm run prepack', {env, cwd: __dirname}, async (err, stdout, stderr) => {
+        exec("pnpm run prepack", {env, cwd: __dirname}, (err) => {
             if (err) {
-                process.stdout.write(', failed\n');
+                process.stdout.write(", failed\n");
 
                 if (err.code === 134) {
-                    process.stderr.write('\n\nBuild failed; ran out-of-memory, free some memory (RAM) and start again\n\n');
+                    process.stderr.write("\n\nBuild failed; ran out-of-memory, free some memory (RAM) and start again\n\n");
                 }
 
                 reject(err);
             } else {
-                process.stdout.write(', finished\n');
+                process.stdout.write(", finished\n");
                 resolve();
             }
         });
@@ -109,19 +109,19 @@ async function build(reason) {
 
 async function checkDist() {
     if (!fs.existsSync(hashFile)) {
-        await build('initial build');
+        await build("initial build");
     }
 
-    const distHash = fs.readFileSync(hashFile, 'utf8');
+    const distHash = fs.readFileSync(hashFile, "utf8");
     const hash = await currentHash();
 
-    if (hash !== 'unknown' && distHash !== hash) {
-        await build('hash changed');
+    if (hash !== "unknown" && distHash !== hash) {
+        await build("hash changed");
     }
 }
 
 async function start() {
-    console.log(`Starting Zigbee2MQTT ${watchdog ? `with watchdog (${watchdogDelays})` : `without watchdog`}.`);
+    console.log(`Starting Zigbee2MQTT ${watchdog ? `with watchdog (${watchdogDelays})` : "without watchdog"}.`);
     await checkDist();
 
     // gc
@@ -132,7 +132,7 @@ async function start() {
             console.log(`\t\tZigbee2MQTT requires node version ${version}, you are running ${process.version}!\n`);
         }
 
-        const {onboard} = require('./dist/util/onboarding');
+        const {onboard} = require("./dist/util/onboarding");
 
         const success = await onboard();
 
@@ -143,7 +143,7 @@ async function start() {
         }
     }
 
-    const {Controller} = require('./dist/controller');
+    const {Controller} = require("./dist/controller");
     controller = new Controller(restart, exit);
 
     await controller.start();
@@ -172,17 +172,17 @@ async function handleQuit() {
     }
 }
 
-if (require.main === module || require.main.filename.endsWith(path.sep + 'cli.js')) {
-    if (process.argv.length === 3 && process.argv[2] === 'writehash') {
+if (require.main === module || require.main.filename.endsWith(`${path.sep}cli.js`)) {
+    if (process.argv.length === 3 && process.argv[2] === "writehash") {
         writeHash();
     } else {
-        process.on('SIGINT', handleQuit);
-        process.on('SIGTERM', handleQuit);
+        process.on("SIGINT", handleQuit);
+        process.on("SIGTERM", handleQuit);
         start();
     }
 } else {
-    process.on('SIGINT', handleQuit);
-    process.on('SIGTERM', handleQuit);
+    process.on("SIGINT", handleQuit);
+    process.on("SIGTERM", handleQuit);
 
     module.exports = {start};
 }