chore: switch from ESLint to Biome

Author: scriptcoded

.eslintrc.js

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["biomejs.biome"]
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "editor.defaultFormatter": "biomejs.biome"
+}

.vscode/settings.json

@@ -138,11 +138,11 @@ See the [contribution guidelines](CONTRIBUTING.md).
 
 ## Tests
 
-We use [Jest](https://jestjs.io/) for running our tests. The test suite can be run by running `npm run test`. This will run both Jest and ESLint.
+We use [Jest](https://jestjs.io/) for running our tests. The test suite can be run by running `npm run test`. This will run both Jest and Biome.
 
 ## Code style
 
-We use [ESLint](https://eslint.org/) for making sure that our code remains pretty and consistent throughout the project. If your editor doesn't automatically pick up our config you can lint the code using `npm run lint`.
+We use [Biome](https://biomejs.dev/) for making sure that our code remains pretty and consistent throughout the project. If your editor doesn't automatically pick up our config you can lint the code using `npm run lint`.
 
 ## A note on Dependabot
 

README.md

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "formatter": {
+    "indentStyle": "space"
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingCommas": "none"
+    }
+  },
+  "overrides": [
+    {
+      "include": ["test/debug.js"],
+      "formatter": {
+        "lineWidth": 320
+      }
+    }
+  ]
+}

biome.json

@@ -5,4 +5,4 @@ module.exports = {
     'subject-case': [1, 'always', 'lower-case'],
     'header-case': [1, 'always', 'lower-case']
   }
-}
+};

commitlint.config.js

@@ -35,25 +35,25 @@ const charCodeMap = {
   39: ''', // '
   60: '&lt;', // <
   62: '&gt;' // >
-}
+};
 
-function escapeHtml (str) {
-  let html = ''
-  let lastIndex = 0
+function escapeHtml(str) {
+  let html = '';
+  let lastIndex = 0;
 
   for (let i = 0; i < str.length; i++) {
-    const escape = charCodeMap[str.charCodeAt(i)]
-    if (!escape) continue
+    const replacement = charCodeMap[str.charCodeAt(i)];
+    if (!replacement) continue;
 
     if (lastIndex !== i) {
-      html += str.substring(lastIndex, i)
+      html += str.substring(lastIndex, i);
     }
 
-    lastIndex = i + 1
-    html += escape
+    lastIndex = i + 1;
+    html += replacement;
   }
 
-  return html + str.substring(lastIndex)
+  return html + str.substring(lastIndex);
 }
 
-module.exports = escapeHtml
+module.exports = escapeHtml;

lib/escapeHtml.js

@@ -1,7 +1,7 @@
 declare module 'sql-highlight' {
   export interface HighlightOptions {
     html?: boolean;
-    htmlEscaper?: (str: string) => string
+    htmlEscaper?: (str: string) => string;
     classPrefix?: string;
     colors?: {
       keyword: string;
@@ -20,8 +20,11 @@ declare module 'sql-highlight' {
     name: string;
     content: string;
   }
-  
+
   export function getSegments(sqlString: string): Array<Segment>;
-  export function highlight(sqlString: string, options?: HighlightOptions): string;
+  export function highlight(
+    sqlString: string,
+    options?: HighlightOptions
+  ): string;
   export const DEFAULT_OPTIONS: HighlightOptions;
 }

lib/index.d.ts

@@ -1,7 +1,5 @@
-'use strict'
-
-const keywords = require('./keywords')
-const escapeHtml = require('./escapeHtml')
+const keywords = require('./keywords');
+const escapeHtml = require('./escapeHtml');
 
 const DEFAULT_OPTIONS = {
   html: false,
@@ -18,7 +16,7 @@ const DEFAULT_OPTIONS = {
     comment: '\x1b[2m\x1b[90m',
     clear: '\x1b[0m'
   }
-}
+};
 
 const highlighters = [
   /(?<number>[+-]?(?:\d+\.\d+|\d+|\.\d+)(?:E[+-]?\d+)?)/,
@@ -42,44 +40,46 @@ const highlighters = [
   // https://data-flair.training/blogs/sql-operators/, plus any single character (in particular ,:;.) not matched by
   // the above regexps.
   /(?<special>\^-=|\|\*=|\+=|-=|\*=|\/=|%=|&=|>=|<=|<>|!=|!<|!>|>>|<<|.)/
-]
+];
 
 // Regex of the shape /(?<token1>...)|(?<token2>...)|.../g
 const tokenizer = new RegExp(
   [
-    '\\b(?<keyword>' + keywords.join('|') + ')\\b',
-    ...highlighters.map(regex => regex.source)
+    `\\b(?<keyword>${keywords.join('|')})\\b`,
+    ...highlighters.map((regex) => regex.source)
   ].join('|'),
   'gis'
-)
+);
 
-function getSegments (sqlString) {
-  const segments = Array.from(sqlString.matchAll(tokenizer), match => ({
-    name: Object.keys(match.groups).find(key => match.groups[key]),
+function getSegments(sqlString) {
+  const segments = Array.from(sqlString.matchAll(tokenizer), (match) => ({
+    name: Object.keys(match.groups).find((key) => match.groups[key]),
     content: match[0]
-  }))
-  return segments
+  }));
+  return segments;
 }
 
-function highlight (sqlString, options) {
-  options = Object.assign({}, DEFAULT_OPTIONS, options)
+function highlight(sqlString, options) {
+  const fullOptions = Object.assign({}, DEFAULT_OPTIONS, options);
 
   return getSegments(sqlString)
     .map(({ name, content }) => {
-      if (options.html) {
-        const escapedContent = options.htmlEscaper(content)
-        return name === 'whitespace' ? escapedContent : `<span class="${options.classPrefix}${name}">${escapedContent}</span>`
+      if (fullOptions.html) {
+        const escapedContent = fullOptions.htmlEscaper(content);
+        return name === 'whitespace'
+          ? escapedContent
+          : `<span class="${fullOptions.classPrefix}${name}">${escapedContent}</span>`;
       }
-      if (options.colors[name]) {
-        return options.colors[name] + content + options.colors.clear
+      if (fullOptions.colors[name]) {
+        return fullOptions.colors[name] + content + fullOptions.colors.clear;
       }
-      return content
+      return content;
     })
-    .join('')
+    .join('');
 }
 
 module.exports = {
   getSegments,
   highlight,
   DEFAULT_OPTIONS
-}
+};

lib/index.js

@@ -142,4 +142,4 @@ module.exports = [
   'END',
   'PRINT',
   'OVERLAPS'
-]
+];