ci: Setup biome and pre-commit hooks for formatting (no-changelog) (#…

…10795)

Co-authored-by: Tomi Turtiainen <[email protected]>

.github/workflows/ci-pull-requests.yml

@@ -30,6 +30,9 @@ jobs:
       - name: Build
         run: pnpm build
 
+      - name: Run formatcheck
+        run: pnpm format:check
+
       - name: Run typecheck
         run: pnpm typecheck
 

.prettierignore

@@ -7,3 +7,11 @@ packages/nodes-base/nodes/**/test
 packages/cli/templates/form-trigger.handlebars
 cypress/fixtures
 CHANGELOG.md
+.github/pull_request_template.md
+# Ignored for now
+**/*.md
+# Handled by biome
+**/*.ts
+**/*.js
+**/*.json
+**/*.jsonc

.vscode/extensions.json

@@ -1,5 +1,6 @@
 {
 	"recommendations": [
+		"biomejs.biome",
 		"streetsidesoftware.code-spell-checker",
 		"dangmai.workspace-default-settings",
 		"dbaeumer.vscode-eslint",

.vscode/settings.default.json

@@ -1,6 +1,22 @@
 {
 	"editor.defaultFormatter": "esbenp.prettier-vscode",
 	"editor.formatOnSave": true,
+	"[javascript]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[typescript]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[json]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[jsonc]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"editor.codeActionsOnSave": {
+		"quickfix.biome": "explicit",
+		"source.organizeImports.biome": "never"
+	},
 	"search.exclude": {
 		"node_modules": true,
 		"dist": true,

biome.jsonc

@@ -0,0 +1,48 @@
+{
+	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+	"vcs": {
+		"clientKind": "git",
+		"enabled": true,
+		"useIgnoreFile": true
+	},
+	"files": {
+		"ignore": [
+			"**/.turbo",
+			"**/coverage",
+			"**/dist",
+			"**/package.json",
+			"**/pnpm-lock.yaml",
+			"**/CHANGELOG.md"
+		]
+	},
+	"formatter": {
+		"enabled": true,
+		"formatWithErrors": false,
+		"indentStyle": "tab",
+		"indentWidth": 2,
+		"lineEnding": "lf",
+		"lineWidth": 100,
+		"attributePosition": "auto",
+		"ignore": [
+			// Handled by prettier
+			"**/*.vue"
+		]
+	},
+	"organizeImports": { "enabled": false },
+	"linter": {
+		"enabled": false
+	},
+	"javascript": {
+		"formatter": {
+			"jsxQuoteStyle": "double",
+			"quoteProperties": "asNeeded",
+			"trailingCommas": "all",
+			"semicolons": "always",
+			"arrowParentheses": "always",
+			"bracketSpacing": true,
+			"bracketSameLine": false,
+			"quoteStyle": "single",
+			"attributePosition": "auto"
+		}
+	}
+}

cypress/biome.jsonc

@@ -0,0 +1,7 @@
+{
+	"$schema": "../node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../biome.jsonc"],
+	"formatter": {
+		"ignore": ["fixtures/**"]
+	}
+}

cypress/e2e/24-ndv-paired-item.cy.ts

@@ -227,7 +227,7 @@ describe('NDV', () => {
 
 		workflowPage.actions.zoomToFit();
 
-		/* prettier-ignore */
+		// biome-ignore format:
 		const PINNED_DATA = [
 			{
 				"id": "abc",
@@ -263,7 +263,6 @@ describe('NDV', () => {
 				]
 			}
 		];
-		/* prettier-ignore */
 		workflowPage.actions.openNode('Get thread details1');
 		ndv.actions.pastePinnedData(PINNED_DATA);
 		ndv.actions.close();

cypress/e2e/6-code-node.cy.ts

@@ -43,7 +43,9 @@ describe('Code node', () => {
 			const getParameter = () => ndv.getters.parameterInput('jsCode').should('be.visible');
 			const getEditor = () => getParameter().find('.cm-content').should('exist');
 
-			getEditor().type('{selectall}').paste(`$input.itemMatching()
+			getEditor()
+				.type('{selectall}')
+				.paste(`$input.itemMatching()
 $input.item
 $('When clicking ‘Test workflow’').item
 $input.first(1)
@@ -68,7 +70,9 @@ return
 
 			ndv.getters.parameterInput('mode').click();
 			ndv.actions.selectOptionInParameterDropdown('mode', 'Run Once for Each Item');
-			getEditor().type('{selectall}').paste(`$input.itemMatching()
+			getEditor()
+				.type('{selectall}')
+				.paste(`$input.itemMatching()
 $input.all()
 $input.first()
 $input.item()

cypress/package.json

@@ -7,7 +7,8 @@
     "test:e2e:ui": "scripts/run-e2e.js ui",
     "test:e2e:dev": "scripts/run-e2e.js dev",
     "test:e2e:all": "scripts/run-e2e.js all",
-    "format": "prettier --write . --ignore-path ../.prettierignore",
+    "format": "biome format --write .",
+    "format:check": "biome ci .",
     "lint": "eslint . --quiet",
     "lintfix": "eslint . --fix",
     "develop": "cd ..; pnpm dev",

lefthook.yml

@@ -0,0 +1,10 @@
+pre-commit:
+  commands:
+    biome_check:
+      glob: 'packages/**/*.{js,ts,json}'
+      run: ./node_modules/.bin/biome check --write --no-errors-on-unmatched --files-ignore-unknown=true --colors=off {staged_files}
+      stage_fixed: true
+    prettier_check:
+      glob: 'packages/**/*.{vue,yml,md}'
+      run: ./node_modules/.bin/prettier --write --ignore-unknown --no-error-on-unmatched-pattern {staged_files}
+      stage_fixed: true

n8n.code-workspace

@@ -1,7 +1,7 @@
 {
 	"folders": [
 		{
-			"path": ".",
-		},
-	],
+			"path": "."
+		}
+	]
 }

package.json

@@ -8,6 +8,7 @@
   },
   "packageManager": "[email protected]",
   "scripts": {
+    "prepare": "lefthook install",
     "preinstall": "node scripts/block-npm-install.js",
     "build": "turbo run build",
     "build:backend": "turbo run build:backend",
@@ -19,6 +20,7 @@
     "clean": "turbo run clean --parallel",
     "reset": "node scripts/ensure-zx.mjs && zx scripts/reset.mjs",
     "format": "turbo run format && node scripts/format.mjs",
+    "format:check": "turbo run format:check",
     "lint": "turbo run lint",
     "lintfix": "turbo run lintfix",
     "lint:backend": "turbo run lint:backend",
@@ -38,6 +40,7 @@
     "worker": "./packages/cli/bin/n8n worker"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.9.0",
     "@n8n_io/eslint-config": "workspace:*",
     "@types/jest": "^29.5.3",
     "@types/supertest": "^6.0.2",
@@ -46,6 +49,7 @@
     "jest-expect-message": "^1.1.3",
     "jest-mock": "^29.6.2",
     "jest-mock-extended": "^3.0.4",
+    "lefthook": "^1.7.15",
     "nock": "^13.3.2",
     "nodemon": "^3.0.1",
     "p-limit": "^3.1.0",

packages/@n8n/api-types/package.json

@@ -6,7 +6,8 @@
     "dev": "pnpm watch",
     "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json",
-    "format": "prettier --write . --ignore-path ../../../.prettierignore",
+    "format": "biome format --write .",
+    "format:check": "biome ci .",
     "lint": "eslint .",
     "lintfix": "eslint . --fix",
     "watch": "tsc -p tsconfig.build.json --watch",

packages/@n8n/benchmark/biome.jsonc

@@ -0,0 +1,7 @@
+{
+	"$schema": "../node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../../../biome.jsonc"],
+	"files": {
+		"ignore": ["scripts/mock-api/**"]
+	}
+}

packages/@n8n/benchmark/package.json

@@ -5,6 +5,8 @@
   "main": "dist/index",
   "scripts": {
     "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "format": "biome format --write .",
+    "format:check": "biome ci .",
     "lint": "eslint .",
     "lintfix": "eslint . --fix",
     "start": "./bin/n8n-benchmark",

packages/@n8n/chat/package.json

@@ -12,7 +12,8 @@
     "typecheck": "vue-tsc --noEmit",
     "lint": "eslint . --ext .js,.ts,.vue --quiet",
     "lintfix": "eslint . --ext .js,.ts,.vue --fix",
-    "format": "prettier --write src/",
+    "format": "biome format --write src .storybook && prettier --write src/ --ignore-path ../../.prettierignore",
+    "format:check": "biome ci src .storybook && prettier --check src/ --ignore-path ../../.prettierignore",
     "storybook": "storybook dev -p 6006 --no-open",
     "build:storybook": "storybook build"
   },