Add code linting and formatting

.devcontainer/devcontainer.json

@@ -20,7 +20,8 @@
 			// NOTE: keep this in sync with: .vscode/extensions.json
 			"extensions": [
 				"davidanson.vscode-markdownlint",
-				"streetsidesoftware.code-spell-checker"
+				"streetsidesoftware.code-spell-checker",
+				"biomejs.biome"
 			]
 		}
 	},

.vscode/extensions.json

@@ -2,6 +2,7 @@
   // NOTE: keep this in sync with: .devcontainer/devcontainer.json
   "recommendations": [
     "davidanson.vscode-markdownlint",
-    "streetsidesoftware.code-spell-checker"
+    "streetsidesoftware.code-spell-checker",
+    "biomejs.biome"
   ]
 }

.vscode/settings.json

@@ -1,8 +1,17 @@
 {
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.formatOnSave": true,
   "cSpell.words": [
     "Airmass",
     "autotune",
     "autotuner",
+    "biomejs",
     "bootloader",
     "CANBUS",
     "Colour",
@@ -11,6 +20,7 @@
     "Deadtime",
     "deadzone",
     "debugmode",
+    "devcontainer",
     "devcontainers",
     "DFCO",
     "dyno",

README.md

@@ -30,6 +30,8 @@ Docusaurus guides: [https://docusaurus.io/docs/category/guides](https://docusaur
 
 ```bash
 npm run lint
+
+npm run lint:fix
 ```
 
 ### Build

biome.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.1.2/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "files": {
+    "ignore": [".devcontainer", ".vscode", "node_modules", ".docusaurus", "build", "pdf"]
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "all": true,
+      "style": {
+        "all": true,
+        "useEnumInitializers": "off",
+        "noNonNullAssertion": "off"
+      },
+      "suspicious": {
+        "all": true,
+        "noConsoleLog": "off"
+      },
+      "nursery": {
+        "all": true,
+        "useExhaustiveDependencies": "off"
+      },
+      "complexity": {
+        "all": true,
+        "noForEach": "off"
+      }
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 100,
+    "indentSize": 2
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingComma": "all"
+    }
+  }
+}

docs/02-Intro-Start-Here/_category_.json

@@ -1,7 +1,7 @@
 {
-    "label": "Intro - Start Here",
-    "link": {
-      "type": "generated-index",
-      "description": "Where to start learning about FOME."
-    }
-  }
+  "label": "Intro - Start Here",
+  "link": {
+    "type": "generated-index",
+    "description": "Where to start learning about FOME."
+  }
+}

docs/03-Fundamentals-Of-Tuning/_category_.json

@@ -1,7 +1,7 @@
 {
-    "label": "Fundamentals of FOME tuning",
-    "link": {
-      "type": "generated-index",
-      "description": "The place to learn how to start tuning your FOME Hardware"
-    }
-  }
+  "label": "Fundamentals of FOME tuning",
+  "link": {
+    "type": "generated-index",
+    "description": "The place to learn how to start tuning your FOME Hardware"
+  }
+}

docs/04-Sensors-And-Gauges/_category_.json

@@ -4,4 +4,4 @@
     "type": "generated-index",
     "description": "Information on all sensor inputs and data outputs"
   }
-}
+}

docusaurus.config.js

@@ -13,11 +13,8 @@ const pdfName = 'wiki.fome.pdf';
 const pdfChecksum = () => {
   const data = fs.readFileSync(`static/pdf/${pdfName}`, 'utf8');
 
-  return crypto
-    .createHash('md5')
-    .update(data, 'utf8')
-    .digest('hex');
-}
+  return crypto.createHash('md5').update(data, 'utf8').digest('hex');
+};
 
 const pdfUrl = `${isBuild ? url : 'http://localhost:3000'}/pdf/${pdfName}?v=${pdfChecksum()}`;
 
@@ -60,12 +57,9 @@ const config = {
           routeBasePath: '/', // Serve the docs at the site's root
           sidebarPath: require.resolve('./sidebars.js'),
           // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/FOME-Tech/wiki/tree/master',
+          editUrl: 'https://github.com/FOME-Tech/wiki/tree/master',
           remarkPlugins: [require('remark-math')],
-          rehypePlugins: [
-            [require('rehype-katex'), { output: 'mathml' }]
-          ],
+          rehypePlugins: [[require('rehype-katex'), { output: 'mathml' }]],
         },
         blog: false,
         theme: {
@@ -79,8 +73,7 @@ const config = {
     {
       href: 'https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css',
       type: 'text/css',
-      integrity:
-        'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
+      integrity: 'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
       crossorigin: 'anonymous',
     },
   ],
@@ -157,7 +150,7 @@ const config = {
           style: {
             height: 30,
             marginTop: -2,
-          }
+          },
         },
         items: [
           {

package.json

@@ -6,7 +6,10 @@
     "docusaurus": "docusaurus",
     "start": "docusaurus start --host 0.0.0.0",
     "build": "docusaurus build",
-    "lint": "npm run lint:ts && npm run lint:links && npm run lint:md",
+    "lint": "npm run lint:biome && npm run lint:ts && npm run lint:links && npm run lint:md",
+    "lint:biome": "biome check .",
+    "lint:fix": "biome format --write . && biome check --apply .",
+    "lint:fix:unsafe": "biome check . --apply-unsafe .",
     "lint:ts": "tsc",
     "lint:links": "node scripts/linkValidator.js",
     "lint:md": "npx markdownlint-cli docs",
@@ -32,6 +35,7 @@
     "remark-math": "^3.0.1"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.1.2",
     "@docusaurus/module-type-aliases": "^2.4.1",
     "@tsconfig/docusaurus": "^2.0.0",
     "docusaurus-prince-pdf": "^1.2.1",

scripts/linkValidator.js

@@ -34,14 +34,12 @@ const validateAbsoluteUrls = (files) => {
     console.log('❌ Failed\n');
     console.log(red(`Absolute URLs to "${wikiUrl}" found in the following files:\n`));
     errors.forEach((error) => {
-      console.log(
-        `[${error.fileName}:${error.lineNo}] ${error.lineContent.trim()}`
-      );
+      console.log(`[${error.fileName}:${error.lineNo}] ${error.lineContent.trim()}`);
     });
 
     process.exit(1);
   }
-}
+};
 
 /**
  * Load all md and mdx files from / docs and process them
@@ -54,6 +52,6 @@ const main = () => {
   // validateRelativeUrls(files);
 
   console.log('✅ Ok');
-}
+};
 
 main();

sidebars.js

@@ -14,7 +14,7 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  mainSidebar: [{type: 'autogenerated', dirName: '.'}],
+  mainSidebar: [{ type: 'autogenerated', dirName: '.' }],
 
   // But you can create a sidebar manually
   /*