Merge pull request #41 from EmbeddedEnterprises/lint

aminya · web-flow · commit 10d3d2eb5727 · 2025-03-29T19:20:11.000-07:00
fix: add Biome for linting + fix issues
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,9 +1,9 @@
 {
   "extends": "eslint-config-atomic",
-  "ignorePatterns": ["build/", "dist/", "node_modules/", "coverage/"],
+  "ignorePatterns": ["build/", "dist/", "node_modules/", "coverage/", "stats.html", ".cache/", ".turbo/"],
   "overrides": [
     {
-      "files": ["*.ts"],
+      "files": ["**/*.ts"],
       "rules": {
         "no-empty-function": "off",
         "@typescript-eslint/no-empty-function": "error",
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,5 @@
+# line endings
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+*.{vcxproj,vcxproj.filters} text eol=crlf
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ stats.html
 .tmp/
 coverage/
 .turbo/
+.cache/
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,5 @@
 pnpm-lock.yaml
 node_modules
 package.json
+.cache/
+.turbo/
diff --git a/biome.jsonc b/biome.jsonc
@@ -7,6 +7,7 @@
       "**/dist/**",
       "**/build/**",
       "**/.*cache/",
+      "**/.turbo/**",
       "coverage/",
       "**/coverage/"
     ],
diff --git a/package.json b/package.json
@@ -37,16 +37,18 @@
   "bin": "build/main.js",
   "scripts": {
     "clean": "shx rm -rf build",
-    "lint": "turbo run lint.turbo",
-    "lint.turbo": "eslint . --cache \"./**/*.{js,ts,mjs,mts,cjs,cts,json,yaml,yml}\" --fix",
-    "test.lint": "turbo run test.turbo",
-    "test.lint.turbo": "eslint . --cache \"./**/*.{js,ts,mjs,mts,cjs,cts,json,yaml,yml}\"",
-    "format.prettier": "prettier -l --write --cache ./**/*.{yaml,yml,md}",
+    "lint.eslint": "eslint . --cache --cache-location ./.cache/.eslintcache \"./**/*.{js,ts,mjs,mts,cjs,cts,json,yaml,yml}\" --fix",
+    "lint.biome": "biome check --write --unsafe .",
+    "lint": "turbo run lint.eslint lint.biome",
+    "test.lint.eslint": "eslint . --cache --cache-location ./.cache/.eslintcache \"./**/*.{js,ts,mjs,mts,cjs,cts,json,yaml,yml}\"",
+    "test.lint.biome": "biome check .",
+    "test.lint": "turbo run test.lint.eslint test.lint.biome",
+    "format.prettier": "prettier -l --write --cache --cache-location ./.cache/.prettiercache \"./**/*.{yaml,yml,md}\"",
     "format.biome": "biome format --write .",
-    "format": "run-p format.prettier format.biome",
-    "test.format.prettier": "prettier -l --check --cache ./**/*.{yaml,yml,md}",
+    "format": "turbo run format.prettier format.biome",
+    "test.format.prettier": "prettier -l --check --cache --cache-location ./.cache/.prettiercache \"./**/*.{yaml,yml,md}\"",
     "test.format.biome": "biome format --check .",
-    "test.format": "run-p test.format.prettier test.format.biome",
+    "test.format": "turbo run test.format.prettier test.format.biome",
     "dev.tsc": "tsc -w --pretty",
     "dev.legacy-main": "vite --mode legacy-main",
     "dev.legacy-lib": "vite --mode legacy-lib",
@@ -58,8 +60,7 @@
     "build.legacy-lib": "vite build --mode legacy-lib",
     "build.modern-main": "vite build --mode modern-main",
     "build.modern-lib": "vite build --mode modern-lib",
-    "build": "turbo run build.turbo",
-    "build.turbo": "",
+    "build": "turbo run build.tsc build.legacy-main build.legacy-lib build.modern-main build.modern-lib",
     "test": "cross-env NODE_OPTIONS=--enable-source-maps pnpx vitest --watch false",
     "coverage": "pnpm test --coverage"
   },
diff --git a/src/argumentBuilder.ts b/src/argumentBuilder.ts
@@ -1,8 +1,8 @@
-import { BuildConfigurationDefaulted, BuildOptionsDefaulted } from "./lib"
-import { RuntimeDistribution } from "./runtimeDistribution"
 import { join, resolve } from "path"
-import { getPathsForConfig } from "./urlRegistry"
-import { getNodeApiInclude } from "./nodeAPIInclude"
+import type { BuildConfigurationDefaulted, BuildOptionsDefaulted } from "./lib.js"
+import { getNodeApiInclude } from "./nodeAPIInclude/index.js"
+import type { RuntimeDistribution } from "./runtimeDistribution.js"
+import { getPathsForConfig } from "./urlRegistry.js"
 
 export class ArgumentBuilder {
   constructor(
@@ -48,7 +48,7 @@ export class ArgumentBuilder {
       }
     } else if (this.config.os === "darwin") {
       // Darwin can't link against node, so skip it.
-      retVal.push(["CMAKE_JS_CXX_FLAGS", `-undefined dynamic_lookup`])
+      retVal.push(["CMAKE_JS_CXX_FLAGS", "-undefined dynamic_lookup"])
     }
 
     // Search headers, modern node versions have those in /include/node
@@ -100,14 +100,14 @@ export class ArgumentBuilder {
     retVal.push(["CMAKE_JS_DEFINES", this.config.additionalDefines.join(";")])
 
     if (this.options.globalCMakeOptions && this.options.globalCMakeOptions.length > 0) {
-      this.options.globalCMakeOptions.forEach((j) => {
+      for (const j of this.options.globalCMakeOptions) {
         retVal.push([j.name, j.value.replace(/\$ROOT\$/g, resolve(this.options.packageDirectory))])
-      })
+      }
     }
     if (this.config.CMakeOptions && this.config.CMakeOptions.length > 0) {
-      this.config.CMakeOptions.forEach((j) => {
+      for (const j of this.config.CMakeOptions) {
         retVal.push([j.name, j.value.replace(/\$ROOT\$/g, resolve(this.options.packageDirectory))])
-      })
+      }
     }
     return retVal
   }
diff --git a/src/download.ts b/src/download.ts
@@ -1,10 +1,10 @@
-import { DownloaderHelper } from "node-downloader-helper"
 import crypto from "crypto"
+import { tmpdir } from "os"
+import { basename, dirname, join } from "path"
 import { ensureDir, readFile, remove } from "fs-extra"
+import { DownloaderHelper } from "node-downloader-helper"
+import type { ExtractOptions as TarExtractOptions } from "tar"
 import extractTar from "tar/lib/extract.js"
-import { basename, dirname, join } from "path"
-import { tmpdir } from "os"
-import { ExtractOptions as TarExtractOptions } from "tar"
 
 export type HashType = "sha256" | "sha512" | "sha1" | "md5" | "sha384" | "sha224"
 
diff --git a/src/lib.ts b/src/lib.ts
@@ -1,6 +1,6 @@
 import which from "which"
-import { getCmakeGenerator } from "./util"
-import { BuildMode } from "./buildMode"
+import type { BuildMode } from "./buildMode.js"
+import { getCmakeGenerator } from "./util.js"
 
 export type ArrayOrSingle<T> = T | T[]
 
@@ -57,8 +57,7 @@ export function defaultBuildConfiguration(config: BuildConfiguration): BuildConf
   if (config.CMakeOptions === undefined) {
     config.CMakeOptions = []
   }
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  if ((config as any).cmakeOptions !== undefined) {
+  if ("cmakeOptions" in config && config.cmakeOptions !== undefined) {
     console.warn("cmakeOptions was specified which was disabled in the 0.3.0 release. Please rename it to CMakeOptions")
   }
 
@@ -142,7 +141,7 @@ export async function defaultBuildOptions(configs: BuildOptions, buildmode: Buil
     }
     configs.configurations = configs.configurations.filter((j) => j.os === process.platform)
     if (configs.configurations.length === 0) {
-      console.error(`No configuration left to build!`)
+      console.error("No configuration left to build!")
       process.exit(1)
     }
     for (const config of configs.configurations) {
@@ -174,12 +173,12 @@ export async function defaultBuildOptions(configs: BuildOptions, buildmode: Buil
       console.error("No `configurations` entry was found in the package.json")
       process.exit(1)
     }
-    //unnamed configs are always filtered out
-    configs.configurations = configs.configurations.filter((config) =>
-      config.name !== undefined ? buildmode.configsToBuild.includes(config.name) : false,
-    )
+    // unnamed configs are always filtered out
+    configs.configurations = configs.configurations.filter((config) => {
+      return config.name !== undefined ? buildmode.configsToBuild.includes(config.name) : false
+    })
     if (configs.configurations.length === 0) {
-      console.error(`No configuration left to build!`)
+      console.error("No configuration left to build!")
       process.exit(1)
     }
   }
@@ -270,9 +269,11 @@ export async function defaultBuildOptions(configs: BuildOptions, buildmode: Buil
     console.warn("`buildType` was missing. Considering 'Release'")
   }
 
-  configs.configurations?.forEach((v) => {
-    v.additionalDefines = []
-  })
+  if (configs.configurations) {
+    for (const v of configs.configurations) {
+      v.additionalDefines = []
+    }
+  }
 
   // TODO move the code related to globalCMakeOptions
   // TODO move the code related to nodeAPI
diff --git a/src/main.ts b/src/main.ts
@@ -2,20 +2,20 @@
 
 /* eslint-disable node/shebang */
 
-import { BuildOptions, defaultBuildOptions, defaultBuildConfiguration } from "./lib"
 import { join, resolve } from "path"
-import { RuntimeDistribution } from "./runtimeDistribution"
-import { ArgumentBuilder } from "./argumentBuilder"
-import { getEnvVar, run } from "./util"
-import { ensureDir, remove, copy, pathExists, readJson } from "fs-extra"
-import { applyOverrides } from "./override"
-import { determineBuildMode } from "./buildMode"
+import { copy, ensureDir, pathExists, readJson, remove } from "fs-extra"
+import { ArgumentBuilder } from "./argumentBuilder.js"
+import { determineBuildMode } from "./buildMode.js"
+import { type BuildOptions, defaultBuildConfiguration, defaultBuildOptions } from "./lib.js"
+import { applyOverrides } from "./override.js"
+import { RuntimeDistribution } from "./runtimeDistribution.js"
+import { getEnvVar, run } from "./util.js"
 
 const DEBUG_LOG = getEnvVar("CMAKETSDEBUG")
 
 async function main(): Promise<void> {
   const argv = process.argv.slice(2) //Yeah, we don't need advanced command line handling yet
-  let packJson: { "cmake-ts": BuildOptions | undefined } & Record<string, any> // eslint-disable-line @typescript-eslint/no-explicit-any
+  let packJson: { "cmake-ts": BuildOptions | undefined } & Record<string, unknown>
   try {
     // TODO getting the path from the CLI
     const packageJsonPath = resolve(join(process.cwd(), "package.json"))
@@ -129,7 +129,7 @@ async function main(): Promise<void> {
     await ensureDir(targetDir)
     if (configs.generatorToUse.includes("Visual Studio")) {
       if (DEBUG_LOG !== undefined) {
-        console.log(`Applying copy fix for MSVC projects`)
+        console.log("Applying copy fix for MSVC projects")
       }
       await copy(
         join(stagingDir, configs.buildType, `${configs.projectName}.node`),
diff --git a/src/nodeAPIInclude/index.ts b/src/nodeAPIInclude/index.ts
@@ -1,6 +1,6 @@
 import { pathExists } from "fs-extra"
-import { resolvePackage, requireInclude } from "./resolve"
-import { searchPackage } from "./search"
+import { requireInclude, resolvePackage } from "./resolve.js"
+import { searchPackage } from "./search.js"
 
 export async function getNodeApiInclude(projectRoot: string, nodeAPI: string): Promise<string | null> {
   // first check if the given nodeAPI is a include path
diff --git a/src/nodeAPIInclude/search.ts b/src/nodeAPIInclude/search.ts
@@ -1,5 +1,5 @@
-import { join as joinPath, sep as pathSeparator, normalize as normalizePath } from "path"
-import { stat } from "../util"
+import { join as joinPath, normalize as normalizePath, sep as pathSeparator } from "path"
+import { stat } from "../util.js"
 
 export async function searchPackage(projectRoot: string, packageName: string): Promise<string | null> {
   const isNode = await isNodeProject(projectRoot)
diff --git a/src/override.ts b/src/override.ts
@@ -1,5 +1,5 @@
-import { ArrayOrSingle, BuildConfigurationDefaulted, OverrideConfig } from "./lib"
 import satisfies from "semver/functions/satisfies.js"
+import type { ArrayOrSingle, BuildConfigurationDefaulted, OverrideConfig } from "./lib.js"
 
 const knownOverrides: OverrideConfig[] = [
   {
diff --git a/src/runtimeDistribution.ts b/src/runtimeDistribution.ts
@@ -1,11 +1,11 @@
-import { join as joinPath, extname } from "path"
+import { extname, join as joinPath } from "path"
+import glob from "fast-glob"
 import { ensureDir, readFile } from "fs-extra"
-import { stat } from "./util"
 import urlJoin from "url-join"
-import { BuildConfigurationDefaulted } from "./lib"
-import { HOME_DIRECTORY, getPathsForConfig } from "./urlRegistry"
-import { downloadToString, downloadTgz, downloadFile } from "./download"
-import glob from "fast-glob"
+import { downloadFile, downloadTgz, downloadToString } from "./download.js"
+import type { BuildConfigurationDefaulted } from "./lib.js"
+import { HOME_DIRECTORY, getPathsForConfig } from "./urlRegistry.js"
+import { stat } from "./util.js"
 
 export type HashSum = { getPath: string; sum: string }
 function testHashSum(sums: HashSum[], sum: string | undefined, fPath: string) {
@@ -107,8 +107,8 @@ export class RuntimeDistribution {
     if (!match) {
       return Promise.reject(new Error("Failed to find NODE_MODULE_VERSION macro"))
     }
-    const version = parseInt(match[1], 10)
-    if (isNaN(version)) {
+    const version = Number.parseInt(match[1], 10)
+    if (Number.isNaN(version)) {
       return Promise.reject(new Error("Invalid version specified by NODE_MODULE_VERSION macro"))
     }
     this._abi = version
diff --git a/src/urlRegistry.ts b/src/urlRegistry.ts
@@ -1,8 +1,8 @@
-import { BuildConfigurationDefaulted } from "./lib"
+import os from "os"
 import gte from "semver/functions/gte"
 import lt from "semver/functions/lt"
-import os from "os"
-import { getEnvVar } from "./util"
+import type { BuildConfigurationDefaulted } from "./lib.js"
+import { getEnvVar } from "./util.js"
 
 const NODE_MIRROR = getEnvVar("NVM_NODEJS_ORG_MIRROR") ?? "https://nodejs.org/dist"
 const IOJS_MIRROR = getEnvVar("NVM_IOJS_ORG_MIRROR") ?? "https://iojs.org/dist"
diff --git a/src/util.ts b/src/util.ts
@@ -1,6 +1,6 @@
 import * as cp from "child_process"
+import { type PathLike, type StatOptions, Stats, stat as rawStat } from "fs-extra"
 import splitargs from "splitargs2"
-import { PathLike, stat as rawStat, StatOptions, Stats } from "fs-extra"
 
 export function getEnvVar(name: string) {
   const value = process.env[name]
diff --git a/test/download.test.ts b/test/download.test.ts
@@ -1,8 +1,8 @@
-import { suite, expect, test, beforeEach } from "vitest"
-import { downloadToString, downloadFile, downloadTgz, calculateHash } from "../src/download"
-import * as fs from "fs-extra"
 import * as path from "path"
 import { fileURLToPath } from "url"
+import * as fs from "fs-extra"
+import { beforeEach, expect, suite, test } from "vitest"
+import { calculateHash, downloadFile, downloadTgz, downloadToString } from "../src/download.js"
 
 const dirname = typeof __dirname === "string" ? __dirname : path.dirname(fileURLToPath(import.meta.url))
 const root = path.dirname(dirname)
diff --git a/test/zeromq.test.ts b/test/zeromq.test.ts
@@ -1,11 +1,11 @@
 import { execFileSync } from "child_process"
+import path, { join } from "path"
+import { fileURLToPath } from "url"
 import { isCI } from "ci-info"
 import glob from "fast-glob"
 import { existsSync, remove } from "fs-extra"
-import path, { join } from "path"
-import { fileURLToPath } from "url"
 import { beforeAll, beforeEach, expect, suite, test } from "vitest"
-import { HOME_DIRECTORY } from "../src/urlRegistry"
+import { HOME_DIRECTORY } from "../src/urlRegistry.js"
 const dirname = typeof __dirname === "string" ? __dirname : path.dirname(fileURLToPath(import.meta.url))
 const root = path.dirname(dirname)
 
diff --git a/turbo.json b/turbo.json
@@ -17,15 +17,28 @@
     "build.modern-lib": {
       "outputs": ["build/lib.mjs", "build/lib.mjs.map"]
     },
-    "build.turbo": {
-      "dependsOn": ["build.tsc", "build.legacy-main", "build.legacy-lib", "build.modern-main", "build.modern-lib"],
-      "outputs": ["build/*.js", "build/*.js.map", "build/*.mjs", "build/*.mjs.map"]
+    "lint.eslint": {},
+    "lint.biome": {
+      "cache": false
     },
     "lint.turbo": {
-      "outputs": ["./.eslintcache"]
+      "dependsOn": ["lint.eslint", "lint.biome"]
     },
-    "test.lint.turbo": {
-      "outputs": ["./.eslintcache"]
+    "test.lint.eslint": {},
+    "test.lint.biome": {
+      "cache": false
+    },
+    "format.prettier": {
+      "inputs": ["**/*.{yaml,yml,md}", "package.json", "pnpm-lock.yaml", "prettier.config.mjs", ".prettierignore"]
+    },
+    "format.biome": {
+      "cache": false
+    },
+    "test.format.prettier": {
+      "inputs": ["**/*.{yaml,yml,md}", "package.json", "pnpm-lock.yaml", "prettier.config.mjs", ".prettierignore"]
+    },
+    "test.format.biome": {
+      "cache": false
     }
   },
   "ui": "stream"
diff --git a/vite.config.mts b/vite.config.mts
@@ -1,5 +1,5 @@
 import module from "module"
-import { defineConfig, type UserConfig } from "vite"
+import { type UserConfig, defineConfig } from "vite"
 import babel from "vite-plugin-babel"
 import babelConfig from "./babel.config.mts"
 
diff --git a/vitest.config.mts b/vitest.config.mts
@@ -1,4 +1,4 @@
-import { defineConfig, mergeConfig, type ViteUserConfig } from "vitest/config"
+import { type ViteUserConfig, defineConfig, mergeConfig } from "vitest/config"
 import viteConfig from "./vite.config.mjs"
 
 export default defineConfig(async (configEnv) => {

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "eslint-config-atomic",`
`3`		`- "ignorePatterns": ["build/", "dist/", "node_modules/", "coverage/"],`
	`3`	`+ "ignorePatterns": ["build/", "dist/", "node_modules/", "coverage/", "stats.html", ".cache/", ".turbo/"],`
`4`	`4`	`"overrides": [`
`5`	`5`	`{`
`6`		`- "files": ["*.ts"],`
	`6`	`+ "files": ["*/.ts"],`
`7`	`7`	`"rules": {`
`8`	`8`	`"no-empty-function": "off",`
`9`	`9`	`"@typescript-eslint/no-empty-function": "error",`
-Original file line number
+Diff line change
 .tmp/
 coverage/
 .turbo/
 +.cache/