chore: use biome for code formatting (#2301)

This takes ~50ms on my machine 🤯 - closes #2366 - Replacing spaces with tabs won't be done right here, right now. - eslint and biome are reconciled - ~biome check fails because of typescript errors - we can either fix those or find a way to ignore it~
apify · May 22, 2024 · 5db533a · 5db533a
1 parent 43381bf
commit 5db533a
Show file tree

Hide file tree

Showing 310 changed files with 6,220 additions and 4,554 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -7,6 +7,4 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 end_of_line = lf
-# editorconfig-tools is unable to ignore longs strings or urls
-max_line_length = null
 quote_type = single
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,66 +1,71 @@
 {
-    "root": true,
-    "env": {
-        "browser": true,
-        "es2020": true,
-        "node": true
-    },
-    "extends": "@apify/eslint-config-ts",
-    "parserOptions": {
-        "project": "./tsconfig.eslint.json",
-        "ecmaVersion": 2022
-    },
-    "ignorePatterns": [
-        "node_modules",
-        "dist",
-        "coverage",
-        "**/*.d.ts"
-    ],
-    "overrides": [
-        {
-            "plugins": [
-                "@typescript-eslint"
-            ],
-            "files": [
-                "*.ts"
-            ],
-            "rules": {
-                "@typescript-eslint/array-type": "error",
-                "@typescript-eslint/ban-ts-comment": 0,
-                "@typescript-eslint/consistent-type-imports": ["error", {
-                    "disallowTypeAnnotations": false
-                }],
-                "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
-                "@typescript-eslint/member-delimiter-style": ["error", {
-                    "multiline": { "delimiter": "semi", "requireLast": true },
-                    "singleline": { "delimiter": "semi", "requireLast": false }
-                }],
-                "@typescript-eslint/no-empty-interface": "off",
-                "no-empty-function": "off",
-                "@typescript-eslint/no-empty-function": "off",
-                "@typescript-eslint/no-explicit-any": "off",
-                "@typescript-eslint/no-floating-promises": "error",
-                "@typescript-eslint/no-unused-vars": "off",
-                "@typescript-eslint/comma-dangle": ["error", "always-multiline"]
-            }
-        }
-    ],
-    "rules": {
-        "quote-props": ["error", "consistent"],
-        "import/no-extraneous-dependencies": "off",
-        "max-classes-per-file": 0,
-        "no-console": "error",
-        "no-underscore-dangle": 0,
-        "no-void": 0,
-        "max-len": ["error", {
-            "code": 160,
-            "ignoreUrls": true,
-            "ignoreComments": true
-        }],
-        "import/order": ["error", {
-            "groups": ["builtin", "external", ["parent", "sibling"], "index", "object"],
-            "alphabetize": { "order": "asc", "caseInsensitive": true },
-            "newlines-between": "always"
-        }]
-    }
+	"root": true,
+	"env": {
+		"browser": true,
+		"es2020": true,
+		"node": true
+	},
+	"extends": ["@apify/eslint-config-ts", "prettier"],
+	"parserOptions": {
+		"project": "./tsconfig.eslint.json",
+		"ecmaVersion": 2022
+	},
+	"ignorePatterns": ["node_modules", "dist", "coverage", "**/*.d.ts"],
+	"overrides": [
+		{
+			"plugins": ["@typescript-eslint"],
+			"files": ["*.ts"],
+			"rules": {
+				"@typescript-eslint/array-type": "error",
+				"@typescript-eslint/ban-ts-comment": 0,
+				"@typescript-eslint/consistent-type-imports": [
+					"error",
+					{
+						"disallowTypeAnnotations": false
+					}
+				],
+				"@typescript-eslint/consistent-type-definitions": [
+					"error",
+					"interface"
+				],
+				"@typescript-eslint/member-delimiter-style": [
+					"error",
+					{
+						"multiline": { "delimiter": "semi", "requireLast": true },
+						"singleline": { "delimiter": "semi", "requireLast": false }
+					}
+				],
+				"@typescript-eslint/no-empty-interface": "off",
+				"no-empty-function": "off",
+				"@typescript-eslint/no-empty-function": "off",
+				"@typescript-eslint/no-explicit-any": "off",
+				"@typescript-eslint/no-floating-promises": "error",
+				"@typescript-eslint/no-unused-vars": "off",
+				"@typescript-eslint/comma-dangle": ["error", "always-multiline"]
+			}
+		}
+	],
+	"rules": {
+		"quote-props": ["error", "consistent"],
+		"import/no-extraneous-dependencies": "off",
+		"max-classes-per-file": 0,
+		"no-console": "error",
+		"no-underscore-dangle": 0,
+		"no-void": 0,
+		"max-len": "off",
+		"import/order": [
+			"error",
+			{
+				"groups": [
+					"builtin",
+					"external",
+					["parent", "sibling"],
+					"index",
+					"object"
+				],
+				"alphabetize": { "order": "asc", "caseInsensitive": true },
+				"newlines-between": "always"
+			}
+		]
+	}
 }
diff --git a/.github/workflows/test-ci.yml b/.github/workflows/test-ci.yml
@@ -150,6 +150,9 @@ jobs:
             - name: ESLint
               run: yarn lint
 
+            - name: Biome format
+              run: yarn format:check
+
     release_next:
         name: Release @next
         if: github.event_name == 'push' && contains(github.event.ref, 'master') && (!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, 'docs:'))

diff --git a/biome.json b/biome.json
@@ -0,0 +1,18 @@
+{
+	"formatter": {
+		"ignore": ["website/**", "packages/*/dist/**", "package.json"],
+		"formatWithErrors": true
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "single",
+			"semicolons": "always",
+			"trailingComma": "all",
+			"lineWidth": 120,
+			"indentStyle": "space",
+			"indentWidth": 4,
+			"quoteProperties": "preserve",
+			"lineEnding": "lf"
+		}
+	}
+}
diff --git a/docs/examples/.eslintrc.json b/docs/examples/.eslintrc.json
@@ -1,13 +1,13 @@
 {
-    "root": true,
-    "extends": "@apify/ts",
-    "parserOptions": {
-        "project": "./tsconfig.eslint.json",
-        "ecmaVersion": 2022
-    },
-    "rules": {
-        "import/extensions": 0,
-        "import/no-extraneous-dependencies": 0,
-        "no-console": "off"
-    }
+	"root": true,
+	"extends": "@apify/ts",
+	"parserOptions": {
+		"project": "./tsconfig.eslint.json",
+		"ecmaVersion": 2022
+	},
+	"rules": {
+		"import/extensions": 0,
+		"import/no-extraneous-dependencies": 0,
+		"no-console": "off"
+	}
 }
diff --git a/docs/examples/cheerio_crawler.ts b/docs/examples/cheerio_crawler.ts
@@ -57,8 +57,6 @@ const crawler = new CheerioCrawler({
 });
 
 // Run the crawler and wait for it to finish.
-await crawler.run([
-    'https://crawlee.dev',
-]);
+await crawler.run(['https://crawlee.dev']);
 
 log.debug('Crawler finished.');
diff --git a/docs/examples/crawl_multiple_urls_cheerio.ts b/docs/examples/crawl_multiple_urls_cheerio.ts
@@ -9,8 +9,4 @@ const crawler = new CheerioCrawler({
 });
 
 // Run the crawler with initial request
-await crawler.run([
-    'http://www.example.com/page-1',
-    'http://www.example.com/page-2',
-    'http://www.example.com/page-3',
-]);
+await crawler.run(['http://www.example.com/page-1', 'http://www.example.com/page-2', 'http://www.example.com/page-3']);
diff --git a/docs/examples/crawl_multiple_urls_playwright.ts b/docs/examples/crawl_multiple_urls_playwright.ts
@@ -9,8 +9,4 @@ const crawler = new PlaywrightCrawler({
 });
 
 // Run the crawler with initial request
-await crawler.run([
-    'http://www.example.com/page-1',
-    'http://www.example.com/page-2',
-    'http://www.example.com/page-3',
-]);
+await crawler.run(['http://www.example.com/page-1', 'http://www.example.com/page-2', 'http://www.example.com/page-3']);
diff --git a/docs/examples/crawl_multiple_urls_puppeteer.ts b/docs/examples/crawl_multiple_urls_puppeteer.ts
@@ -9,8 +9,4 @@ const crawler = new PuppeteerCrawler({
 });
 
 // Run the crawler with initial request
-await crawler.run([
-    'http://www.example.com/page-1',
-    'http://www.example.com/page-2',
-    'http://www.example.com/page-3',
-]);
+await crawler.run(['http://www.example.com/page-1', 'http://www.example.com/page-2', 'http://www.example.com/page-3']);
diff --git a/docs/examples/forms.ts b/docs/examples/forms.ts
@@ -23,8 +23,8 @@ await Promise.all([
 ]);
 
 // Obtain and print list of search results
-const results = await page.$$eval('[data-testid="results-list"] div.search-title > a',
-    (nodes) => nodes.map((node) => ({
+const results = await page.$$eval('[data-testid="results-list"] div.search-title > a', (nodes) =>
+    nodes.map((node) => ({
         url: node.href,
         name: node.innerText,
     })),

diff --git a/docs/examples/http_crawler.ts b/docs/examples/http_crawler.ts
@@ -36,7 +36,7 @@ const crawler = new HttpCrawler({
         // the data will be stored as JSON files in ./storage/datasets/default
         await Dataset.pushData({
             url: request.url, // URL of the page
-            body,  // HTML code of the page
+            body, // HTML code of the page
         });
     },
 
@@ -48,8 +48,6 @@ const crawler = new HttpCrawler({
 
 // Run the crawler and wait for it to finish.
 // It will crawl a list of URLs from an external file, load each URL using a plain HTTP request, and save HTML
-await crawler.run([
-    'https://crawlee.dev',
-]);
+await crawler.run(['https://crawlee.dev']);
 
 log.debug('Crawler finished.');
diff --git a/docs/examples/jsdom_crawler.ts b/docs/examples/jsdom_crawler.ts
@@ -57,8 +57,6 @@ const crawler = new JSDOMCrawler({
 });
 
 // Run the crawler and wait for it to finish.
-await crawler.run([
-    'https://crawlee.dev',
-]);
+await crawler.run(['https://crawlee.dev']);
 
 log.debug('Crawler finished.');
diff --git a/docs/examples/jsdom_crawler_react.ts b/docs/examples/jsdom_crawler_react.ts
@@ -1,9 +1,9 @@
 import { JSDOMCrawler, log } from 'crawlee';
 
-// Create an instance of the JSDOMCrawler class - crawler that automatically 
+// Create an instance of the JSDOMCrawler class - crawler that automatically
 // loads the URLs and parses their HTML using the jsdom library.
 const crawler = new JSDOMCrawler({
-    // Setting the `runScripts` option to `true` allows the crawler to execute client-side 
+    // Setting the `runScripts` option to `true` allows the crawler to execute client-side
     // JavaScript code on the page. This is required for some websites (such as the React application in this example), but may pose a security risk.
     runScripts: true,
     // This function will be called for each crawled URL.
@@ -18,15 +18,13 @@ const crawler = new JSDOMCrawler({
         document.querySelectorAll('button')[18].click(); // =
 
         const result = document.querySelectorAll('.component-display')[0].childNodes[0] as Element;
-        // The result is passed to the console. Unlike with Playwright or Puppeteer crawlers, 
+        // The result is passed to the console. Unlike with Playwright or Puppeteer crawlers,
         // this console call goes to the Node.js console, not the browser console. All the code here runs right in Node.js!
         log.info(result.innerHTML); // 2
     },
 });
 
 // Run the crawler and wait for it to finish.
-await crawler.run([
-    'https://ahfarmer.github.io/calculator/',
-]);
+await crawler.run(['https://ahfarmer.github.io/calculator/']);
 
-log.debug('Crawler finished.');
+log.debug('Crawler finished.');
diff --git a/docs/examples/map.ts b/docs/examples/map.ts
@@ -1,8 +1,8 @@
 import { Dataset, KeyValueStore } from 'crawlee';
 
 const dataset = await Dataset.open<{
-    url: string,
-    headingCount: number,
+    url: string;
+    headingCount: number;
 }>();
 
 // Seeding the dataset with some data

diff --git a/docs/examples/reduce.ts b/docs/examples/reduce.ts
@@ -1,8 +1,8 @@
 import { Dataset, KeyValueStore } from 'crawlee';
 
 const dataset = await Dataset.open<{
-    url: string,
-    headingCount: number,
+    url: string;
+    headingCount: number;
 }>();
 
 // Seeding the dataset with some data

diff --git a/docs/examples/tsconfig.json b/docs/examples/tsconfig.json
@@ -1,21 +1,21 @@
 {
-    "extends": "@apify/tsconfig",
-    "compilerOptions": {
-        "baseUrl": "../..",
-        "paths": {
-            "crawlee": ["packages/crawlee/src"],
-            "@crawlee/basic": ["packages/basic-crawler/src"],
-            "@crawlee/browser": ["packages/browser-crawler/src"],
-            "@crawlee/http": ["packages/http-crawler/src"],
-            "@crawlee/linkedom": ["packages/linkedom-crawler/src"],
-            "@crawlee/jsdom": ["packages/jsdom-crawler/src"],
-            "@crawlee/cheerio": ["packages/cheerio-crawler/src"],
-            "@crawlee/playwright": ["packages/playwright-crawler/src"],
-            "@crawlee/puppeteer": ["packages/puppeteer-crawler/src"],
-            "@crawlee/*": ["packages/*/src"]
-        },
-        "target": "ES2022",
-        "module": "ES2022",
-        "noUnusedParameters": false
-    }
+	"extends": "@apify/tsconfig",
+	"compilerOptions": {
+		"baseUrl": "../..",
+		"paths": {
+			"crawlee": ["packages/crawlee/src"],
+			"@crawlee/basic": ["packages/basic-crawler/src"],
+			"@crawlee/browser": ["packages/browser-crawler/src"],
+			"@crawlee/http": ["packages/http-crawler/src"],
+			"@crawlee/linkedom": ["packages/linkedom-crawler/src"],
+			"@crawlee/jsdom": ["packages/jsdom-crawler/src"],
+			"@crawlee/cheerio": ["packages/cheerio-crawler/src"],
+			"@crawlee/playwright": ["packages/playwright-crawler/src"],
+			"@crawlee/puppeteer": ["packages/puppeteer-crawler/src"],
+			"@crawlee/*": ["packages/*/src"]
+		},
+		"target": "ES2022",
+		"module": "ES2022",
+		"noUnusedParameters": false
+	}
 }
diff --git a/docs/guides/avoid_blocking_playwright.ts b/docs/guides/avoid_blocking_playwright.ts
@@ -6,16 +6,14 @@ const crawler = new PlaywrightCrawler({
         useFingerprints: true, // this is the default
         fingerprintOptions: {
             fingerprintGeneratorOptions: {
-                browsers: [{
-                    name: BrowserName.edge,
-                    minVersion: 96,
-                }],
-                devices: [
-                    DeviceCategory.desktop,
-                ],
-                operatingSystems: [
-                    OperatingSystemsName.windows,
+                browsers: [
+                    {
+                        name: BrowserName.edge,
+                        minVersion: 96,
+                    },
                 ],
+                devices: [DeviceCategory.desktop],
+                operatingSystems: [OperatingSystemsName.windows],
             },
         },
     },