Migrate eslint to biome, fix lint errors

Borewit · Aug 8, 2024 · 89ff43a · 89ff43a
1 parent 56b53ea
commit 89ff43a
Show file tree

Hide file tree

Showing 96 changed files with 1,374 additions and 3,481 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.github/workflows/nodejs-ci.yml b/.github/workflows/nodejs-ci.yml
@@ -24,8 +24,11 @@ jobs:
       - name: Yarn install
         run: yarn install
 
-      - name: Static code analysis
-        run: yarn run lint
+      - name: Lint TypeScript
+        run: yarn run lint-ts
+
+      - name: Lint Markdown
+        run: yarn run lint-md
 
       - name: Build
         run: yarn run build

diff --git a/biome.jsonc b/biome.jsonc
@@ -0,0 +1,53 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+	"organizeImports": {
+		"enabled": false
+	},
+	"formatter": {
+		"enabled": false
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"correctness": {
+				"noConstantCondition": "warn"
+			},
+			"style": {
+				"noParameterAssign": "off"
+			},
+			"recommended": true,
+			"complexity": {
+				"noForEach": "off"
+			},
+			"suspicious": {
+				"noEmptyBlockStatements": "error",
+				"noControlCharactersInRegex": "off"
+			},
+			"nursery": {
+				"noRestrictedImports": {
+					"level": "error",
+					"options": {
+						"paths": {
+							"node:buffer": "Use Uint8Array instead of Buffer"
+						}
+					}
+				},
+				"useConsistentBuiltinInstantiation": "error",
+				"useThrowNewError": "error",
+				"useThrowOnlyError": "error",
+				"useErrorMessage": "error"
+			}
+		}
+	},
+	"files": {
+		"ignoreUnknown": true,
+		"ignore": [
+			"./coverage",
+			"./yarn",
+			"./lib/**/*.d.ts",
+			"./lib/**/*.js",
+			"./test/**/*.d.ts",
+			"./test/**/*.js"
+		]
+	}
+}
diff --git a/doc-gen/MarkDown.ts b/doc-gen/MarkDown.ts
@@ -1,4 +1,4 @@
-import * as fs from 'fs';
+import type * as fs from 'node:fs';
 
 export class Row {
   constructor(public values: string[]) {
@@ -7,7 +7,7 @@ export class Row {
 
 export class Table {
 
-  private static padEnd(value: string, size: number, pad: string = ' ') {
+  private static padEnd(value: string, size: number, pad = ' ') {
     while (value.length < size) {
       value += pad;
     }
@@ -20,13 +20,13 @@ export class Table {
       const cellTxt = values.length > ci ? values[ci] : '';
       colValues.push(Table.padEnd(cellTxt, colSizes[ci]));
     }
-    out.write('| ' + colValues.join(' | ') + ' |\n');
+    out.write(`| ${colValues.join(' | ')} |\n`);
   }
 
   private static lineToString(colSizes: number[]): string {
 
     const colValues = colSizes.map(size => Table.padEnd('-', size, '-'));
-    return '|-' + colValues.join('-|-') + '-|\n';
+    return `|-${colValues.join('-|-')}-|\n`;
   }
 
   public rows: Row[] = [];

diff --git a/doc-gen/gen.ts b/doc-gen/gen.ts
@@ -30,8 +30,8 @@ function getNativeSourceTags(nativeType: string, commonTag: string): string[] {
 
 function write(out: fs.WriteStream) {
 
-  const json = fs.readFileSync(path.join(dirname, 'common.json'));
-  const commonDescriptionDict: ITagInfoDict = JSON.parse(json as any);
+  const json = fs.readFileSync(path.join(dirname, 'common.json'), {encoding: 'utf-8'});
+  const commonDescriptionDict: ITagInfoDict = JSON.parse(json);
 
   const table = new markDown.Table();
 

diff --git a/example/javascript/orderTags.js b/example/javascript/orderTags.js
@@ -1,5 +1,5 @@
 import { parseFile, orderTags } from '../../lib/index.js';  // music-metadata
-import { inspect } from 'util';
+import { inspect } from 'node:util';
 
 (async () => {
   try {

diff --git a/example/javascript/parseFile.js b/example/javascript/parseFile.js
@@ -1,5 +1,5 @@
 import { parseFile } from '../../lib/index.js';  // music-metadata
-import { inspect } from 'util';
+import { inspect } from 'node:util';
 
 (async () => {
   try {

diff --git a/example/javascript/stream.js b/example/javascript/stream.js
@@ -1,5 +1,5 @@
-import https from 'https';
-import { inspect } from 'util';
+import https from 'node:https';
+import { inspect } from 'node:util';
 import { parseStream } from '../../lib/index.js';  // music-metadata
 
 const audioUrl = 'https://github.com/Borewit/music-metadata/raw/master/test/samples/MusicBrainz%20-%20Beth%20Hart%20-%20Sinner\'s%20Prayer%20%5Bid3v2.3%5D.V2.mp3';
@@ -15,7 +15,7 @@ function httpGet (url) {
           resolve(httpGet(res.headers.location));
           break;
         default:
-          reject(new Error('Unexpected status-code:' + res.statusCode));
+          reject(new Error(`Unexpected status-code:${res.statusCode}`));
       }
     });
   });