feat: detect Biome lint config + docs

Author: KristjanESPERANTO

guides/README.md

@@ -8,9 +8,9 @@ Sometimes it's not so easy to find the entry point, so we provide a few hints to
 
 Please help use to improve this guide. If you have any suggestions, please create an issue or a pull request.
 
-## Hint "No ESLint configuration was found. ESLint is very helpful, it is worth using it even for small projects."
+## Hint "No linter configuration was found. A linter is very helpful, it is worth using one even for small projects."
 
-To get started with ESLint, check out [ESLint](eslint.md).
+To get started with a linter, check out [ESLint](eslint.md) or [Biome](biome.md).
 
 ## Hint "Recommendation: The README seems not to have a config example. Please add one."
 

guides/biome.md

@@ -0,0 +1,85 @@
+# How to use Biome for your MagicMirror² module
+
+It's recommend using a linter to help you catch errors and enforce coding standards in your JavaScript code. Biome is a fast all-in-one tool that can handle both linting and formatting.
+
+If you want to better understand how to set up Biome by yourself, check out the [Biome documentation](https://biomejs.dev/guides/getting-started/).
+
+## Guide to using Biome for your MagicMirror² module
+
+This guide will help you set up Biome for your MagicMirror² module. It will cover the installation, configuration, and how to run it.
+
+### 0 - Prerequisites
+
+- Make sure you have a `package.json` file in your module's root directory. If you don't have one, you can create it by running `npm init -y` in your terminal.
+- Make sure you have a `.gitignore` file in your module's root directory. If you don't have one, you can create it by running `touch .gitignore` in your terminal.
+- Add `node_modules` to your `.gitignore` file to prevent committing the `node_modules` directory to your repository.
+
+### 1 - Install Biome
+
+Install Biome as a development dependency:
+
+```bash
+npm install --save-dev @biomejs/biome
+```
+
+### 2 - Create Biome configuration file
+
+Create a file named `biome.jsonc` in the root directory of your module:
+
+```json
+{
+  "$schema": "https://biomejs.dev/schemas/2.0.5/schema.json",
+  "linter": {
+    "enabled": true
+  },
+  "formatter": {
+    "enabled": true
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "double"
+    }
+  }
+},
+```
+
+### 3 - Add scripts to package.json
+
+Add the following scripts to your `package.json` file:
+
+```json
+{
+  "scripts": {
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "format": "biome format --write .",
+    "check": "biome check ."
+  }
+},
+```
+
+### 4 - Run Biome
+
+Run linting:
+
+```bash
+node --run lint
+```
+
+Run linting with automatic fixes:
+
+```bash
+node --run lint:fix
+```
+
+Run formatting:
+
+```bash
+node --run format
+```
+
+Run all checks:
+
+```bash
+node --run check
+```

scripts/check-modules/__tests__/module-analyzer.test.js

@@ -140,5 +140,42 @@ test("analyzer applies classic-module exceptions for mmpm", async () => {
   assert.equal(result.issues.some(issue => issue.includes("README seems not to have an update section")), false);
   assert.equal(result.issues.some(issue => issue.includes("There is no CODE_OF_CONDUCT file")), true);
   assert.equal(result.issues.some(issue => issue.includes("There is no dependabot configuration file")), false);
-  assert.equal(result.issues.some(issue => issue.includes("No ESLint configuration was found")), false);
+  assert.equal(result.issues.some(issue => issue.includes("No linter configuration was found")), false);
+});
+
+test("analyzer accepts biome config as linting setup", async () => {
+  const moduleRoot = await fsPromises.mkdtemp(join(tmpdir(), "module-analyzer-biome-test-"));
+
+  await fsPromises.writeFile(join(moduleRoot, "README.md"), "# MMM-Biome-Test\n");
+  await fsPromises.writeFile(join(moduleRoot, "CHANGELOG.md"), "changelog\n");
+  await fsPromises.writeFile(join(moduleRoot, "CODE_OF_CONDUCT.md"), "code of conduct\n");
+  await fsPromises.writeFile(join(moduleRoot, "LICENSE.md"), "MIT\n");
+  await fsPromises.writeFile(join(moduleRoot, "biome.jsonc"), "{\n  \"linter\": { \"enabled\": true }\n}\n");
+  await fsPromises.writeFile(
+    join(moduleRoot, "package.json"),
+    JSON.stringify({
+      name: "mmm-biome-test",
+      version: "1.0.0"
+    })
+  );
+
+  const files = [
+    join(moduleRoot, "README.md"),
+    join(moduleRoot, "CHANGELOG.md"),
+    join(moduleRoot, "CODE_OF_CONDUCT.md"),
+    join(moduleRoot, "LICENSE.md"),
+    join(moduleRoot, "biome.jsonc"),
+    join(moduleRoot, "package.json")
+  ];
+
+  const result = await analyzeModule(
+    moduleRoot,
+    "MMM-Biome-Test",
+    "https://github.com/example/MMM-Biome-Test",
+    files
+  );
+
+  assert.equal(result.issues.some(issue => issue.includes("No linter configuration was found")), false);
+  assert.equal(result.issues.some(issue => issue.includes("ESLint is not in the dependencies or devDependencies")), false);
+  assert.equal(result.issues.some(issue => issue.includes("lint script in package.json does not contain `eslint`")), false);
 });

scripts/check-modules/module-analyzer.ts

@@ -523,18 +523,19 @@ export async function analyzeModule(
     );
   }
 
-  // ESLint checks
+  // Linting setup checks (ESLint or Biome)
   if (!moduleExceptions.skipEslintChecks) {
     const hasOldEslintrc = filenames.has("ESLINTRC") || filenames.has("ESLINTRC.JSON") || filenames.has("ESLINTRC.JS") || filenames.has("ESLINTRC.YML") || filenames.has("ESLINTRC.YAML");
     const hasNewEslint = filenames.has("ESLINT.CONFIG.JS") || filenames.has("ESLINT.CONFIG.MJS");
+    const hasBiome = filenames.has("BIOME.JSON") || filenames.has("BIOME.JSONC");
 
     if (hasOldEslintrc) {
       issues.push("Recommendation: Replace eslintrc by new flat config.");
-    } else if (!hasNewEslint) {
+    } else if (!hasNewEslint && !hasBiome) {
       issues.push(
-        "Recommendation: No ESLint configuration was found. ESLint is very helpful, it is worth using it even for small projects ([basic instructions](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/eslint.md))."
+        "Recommendation: No linter configuration was found. A linter is very helpful, it is worth using one even for small projects. You can use ESLint or Biome ([ESLint guide](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/eslint.md), [Biome guide](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/biome.md))."
       );
-    } else {
+    } else if (hasNewEslint) {
       // Check if ESLint is in package.json dependencies
       const packageJsonFiles = relevantFiles.filter((f) => f.endsWith("package.json"));
       for (const pkgFile of packageJsonFiles) {