@kitql/eslint-config 0.7.3 → 0.8.0-next.0

package/.oxlintrc.json

@@ -0,0 +1,19 @@
+{
+	"$schema": "./node_modules/oxlint/configuration_schema.json",
+	"plugins": ["unicorn", "typescript", "oxc"],
+	"jsPlugins": ["eslint-plugin-svelte", "eslint-plugin-unused-imports"],
+	"rules": {
+		"no-unused-vars": [
+			"error",
+			{ "caughtErrors": "none", "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
+		],
+		"no-console": [
+			"error",
+			{
+				"allow": ["info", "warn", "error", "time", "timeEnd", "dir"]
+			}
+		],
+		"@typescript-eslint/no-redundant-type-constituents": "off",
+		"no-base-to-string": "off"
+	}
+}

package/cmd.js

@@ -18,24 +18,25 @@ const spinner = ora({
 spinner.start()
 
 program.addOption(new Option('-f, --format', 'format'))
-program.addOption(new Option('-g, --glob <type>', 'file/dir/glob (. by default)', '.'))
-program.addOption(new Option('--eslint-only', 'only run eslint', false))
-program.addOption(new Option('--prettier-only', 'only run prettier', false))
-program.addOption(new Option('--verbose', 'add more logs', false))
+program.addOption(new Option('-g, --glob <type>', 'file/dir/glob (. by default)').default('.'))
+program.addOption(new Option('--lint-only', 'only run lint').default(false))
+program.addOption(new Option('--format-only', 'only run format').default(false))
+program.addOption(new Option('--verbose', 'add more logs').default(false))
+program.addOption(new Option('--ox', 'using oxc tooling').default(false))
 program.addOption(
-	new Option('-d, --diff-only', 'only check files changed against base branch', false),
+	new Option('-d, --diff-only', 'only check files changed against base branch').default(false),
 )
 program.addOption(
-	new Option('--base-branch <type>', 'base branch to compare against (default: main)', 'main'),
+	new Option('--base-branch <type>', 'base branch to compare against (default: main)').default(
+		'main',
+	),
 )
 program.addOption(
 	new Option(
 		'-p, --prefix <type>',
 		'prefix by with "pnpm" or "npm" or "none" ("none" by default)',
-		'none',
-	),
+	).default('none'),
 )
-
 program.parse(process.argv)
 const options_cli = program.opts()
 
@@ -46,10 +47,11 @@ const format = options_cli.format ?? false
 let glob = options_cli.glob ?? '.'
 const verbose = options_cli.verbose ?? false
 const pre = options_cli.prefix ?? 'none'
-const eslintOnly = options_cli.eslintOnly ?? false
-const prettierOnly = options_cli.prettierOnly ?? false
+const lintOnly = options_cli.lintOnly ?? false
+const formatOnly = options_cli.formatOnly ?? false
 const diffOnly = options_cli.diffOnly ?? false
 const baseBranch = options_cli.baseBranch ?? 'main'
+const using_ox = options_cli.ox ?? false
 
 let preToUse = ''
 if (pre === 'npm') {
@@ -60,7 +62,7 @@ if (pre === 'npm') {
 	preToUse = ''
 }
 
-async function customSpawn(cmd) {
+async function customSpawn(/** @type {string} */ cmd) {
 	const child = spawn(cmd, {
 		shell: true,
 		cwd: process.cwd(),
@@ -80,6 +82,7 @@ async function customSpawn(cmd) {
 	// }
 	const exitCode = await new Promise((resolve, reject) => {
 		child.on('close', resolve)
+		child.on('error', reject)
 	})
 
 	if (exitCode) {
@@ -120,7 +123,7 @@ async function getDiffFiles() {
 			return null
 		}
 	} catch (error) {
-		spinner.warn(`Error getting git root: ${error.message}`)
+		if (error instanceof Error) spinner.warn(`Error getting git root: ${error.message}`)
 		return null
 	}
 
@@ -224,7 +227,7 @@ async function getDiffFiles() {
 						spinner.warn(`Could not get changed files: ${error}`)
 						return null
 					}
-				} catch (fallbackError) {
+				} catch {
 					spinner.warn(`Could not get changed files: ${error}`)
 					return null
 				}
@@ -265,13 +268,34 @@ async function getDiffFiles() {
 		// Format the files for the command line, wrapping each in quotes and joining with spaces
 		return files.length > 0 ? files.map((f) => `'${f}'`).join(' ') : null
 	} catch (error) {
-		spinner.warn(`Error getting changed files: ${error.message}`)
+		if (error instanceof Error) spinner.warn(`Error getting changed files: ${error.message}`)
 		return null
 	}
 }
 
-async function eslintRun() {
-	const cmdEsLint =
+async function lintRunOx() {
+	const cmdLint =
+		`oxlint --type-aware` +
+		// format or not
+		`${format ? ' --fix' : ''}` +
+		` ${glob}`
+
+	spinner.text = verbose ? 'lint ' + gray(`(${cmdLint}) `) : 'lint '
+
+	const result_lint = await customSpawn(cmdLint)
+
+	return result_lint
+}
+
+async function lintRun() {
+	if (using_ox) {
+		const result_lint = await lintRunOx()
+		if (typeof result_lint === 'object' && 'status' in result_lint && result_lint.status) {
+			return result_lint
+		}
+	}
+
+	const cmdLint =
 		preToUse +
 		`eslint --no-warn-ignored` +
 		// format or not
@@ -279,15 +303,15 @@ async function eslintRun() {
 		// exec
 		` ${glob}`
 
-	spinner.text = verbose ? 'eslint ' + gray(`(${cmdEsLint})`) : 'eslint'
+	spinner.text = verbose ? 'lint ' + gray(`(${cmdLint}) `) : 'lint '
 
-	const result_eslint = await customSpawn(cmdEsLint)
+	const result_lint = await customSpawn(cmdLint)
 
-	return result_eslint
+	return result_lint
 }
 
-async function prettierRun() {
-	const cmdPrettier =
+async function formatRun() {
+	const cmdFormat =
 		preToUse +
 		`prettier` +
 		` --list-different` +
@@ -300,15 +324,20 @@ async function prettierRun() {
 		// exec
 		` ${glob}`
 
-	spinner.text = verbose ? 'prettier ' + gray(`(${cmdPrettier})`) : 'prettier'
+	spinner.text = verbose ? 'format ' + gray(`(${cmdFormat}) `) : 'format '
 
-	const result_prettier = await customSpawn(cmdPrettier)
+	const result_format = await customSpawn(cmdFormat)
 
-	return result_prettier
+	return result_format
 }
 
+/** @type {string[]} */
 const took = []
 
+/**
+ * @param {string} text
+ * @param {number} time
+ */
 const display = (text, time) => {
 	return `${gray(text)} ${green((time / 1000).toFixed(3))}${gray('s')}`
 }
@@ -329,27 +358,27 @@ if (diffOnly) {
 	}
 }
 
-if (!prettierOnly && glob) {
-	const esLintStart = performance.now()
-	const eslintCode = await eslintRun()
-	const esLintTook = performance.now() - esLintStart
-	took.push(display('eslint', esLintTook))
-	if (eslintCode.status) {
+if (!formatOnly && glob) {
+	const lintStart = performance.now()
+	const lintCode = await lintRun()
+	const lintTook = performance.now() - lintStart
+	took.push(display('lint', lintTook))
+	if (typeof lintCode === 'object' && 'status' in lintCode && lintCode.status) {
 		spinner.prefixText = bgRedBright(` kitql-lint `)
-		spinner.fail(red(`eslint failed, check logs above. ${displayTook()}`))
-		process.exit(eslintCode.status)
+		spinner.fail(red(`lint failed, check logs above. ${displayTook()}`))
+		process.exit(lintCode.status)
 	}
 }
 
-if (!eslintOnly && glob) {
-	const prettierStart = performance.now()
-	const prettierCode = await prettierRun()
-	const prettierTook = performance.now() - prettierStart
-	took.push(display('prettier', prettierTook))
-	if (prettierCode.status) {
+if (!lintOnly && glob) {
+	const formatStart = performance.now()
+	const formatCode = await formatRun()
+	const formatTook = performance.now() - formatStart
+	took.push(display('format', formatTook))
+	if (typeof formatCode === 'object' && 'status' in formatCode && formatCode.status) {
 		spinner.prefixText = bgRedBright(` kitql-lint `)
-		spinner.fail(red(`prettier failed, check logs above. ${displayTook()}`))
-		process.exit(prettierCode.status)
+		spinner.fail(red(`format failed, check logs above. ${displayTook()}`))
+		process.exit(formatCode.status)
 	}
 }
 

package/eslint.config.js

@@ -1,6 +1,7 @@
 import { includeIgnoreFile } from '@eslint/compat'
 import js from '@eslint/js'
 import prettier from 'eslint-config-prettier'
+import oxlint from 'eslint-plugin-oxlint'
 import pluginPnpm from 'eslint-plugin-pnpm'
 import svelte from 'eslint-plugin-svelte'
 import unusedImports from 'eslint-plugin-unused-imports'
@@ -89,7 +90,7 @@ const othersRules = () => {
 		},
 		...ts.configs.recommended,
 		...svelte.configs.recommended,
-		prettier,
+		{ name: 'eslint/prettier', ...prettier },
 		...svelte.configs.prettier,
 		{
 			name: '@kitql:languages',
@@ -168,16 +169,6 @@ const othersRules = () => {
 	]
 }
 
-/** @type {import('eslint').Linter.Config[]} */
-const config = [
-	//
-	rulePrettierIgnore({ pnpmCatalogsEnabled: true }),
-	...othersRules(),
-	...rulePnpmCatalogs(),
-]
-
-export default config
-
 /**
  * @typedef {Object} KitqlOptions
  * @property {PnpmCatalogsConfig} [pnpmCatalogs] - Configuration object for pnpm catalogs
@@ -191,10 +182,18 @@ export const kitql = (options = {}) => {
 	const pnpmCatalogsConfig = options?.pnpmCatalogs ?? { enable: false }
 	const pnpmCatalogsEnabled = pnpmCatalogsConfig.enable !== false
 
+	const pathOxlintrc = findFileOrUp('.oxlintrc.json') ?? './.oxlintrc.json'
+
 	return [
 		//
 		rulePrettierIgnore({ pnpmCatalogsEnabled }),
 		...othersRules(),
 		...(pnpmCatalogsEnabled ? rulePnpmCatalogs(pnpmCatalogsConfig) : []),
+		...oxlint.buildFromOxlintConfigFile(pathOxlintrc),
 	]
 }
+
+/** @type {import('eslint').Linter.Config[]} */
+const config = kitql({ pnpmCatalogs: { enable: true } })
+
+export default config

package/helper/findFileOrUp.js

@@ -1,7 +1,10 @@
 import { statSync } from 'node:fs'
 import { resolve } from 'node:path'
 
-export const findFileOrUp = (fileName, options) => {
+export const findFileOrUp = (
+	/** @type {string} */ fileName,
+	/** @type {{absolute?: boolean}} */ options = { absolute: false },
+) => {
 	// Find file recursively 4 levels max up
 	for (let i = 0; i < 4; i++) {
 		try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitql/eslint-config",
-  "version": "0.7.3",
+  "version": "0.8.0-next.0",
   "type": "module",
   "description": "opinionated linting and formatting for projects",
   "repository": {
@@ -17,6 +17,7 @@
   },
   "main": "eslint.config.js",
   "files": [
+    ".oxlintrc.json",
     ".prettierrc.js",
     "cmd.js",
     "eslint.config.js",
@@ -28,27 +29,37 @@
     "eslint-config"
   ],
   "peerDependencies": {
+    "oxlint": "1.23.0",
+    "oxlint-tsgolint": "0.2.0",
     "prettier": "^3.6.1"
   },
+  "peerDependenciesMeta": {
+    "oxlint": {
+      "optional": true
+    },
+    "oxlint-tsgolint": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@eslint/compat": "1.3.1",
     "@eslint/js": "9.31.0",
     "@theguild/prettier-config": "3.0.0",
     "@types/eslint": "9.6.1",
-    "@typescript-eslint/parser": "8.37.0",
+    "@typescript-eslint/parser": "8.46.1",
     "commander": "14.0.0",
     "eslint": "9.31.0",
     "eslint-config-prettier": "10.1.5",
+    "eslint-plugin-oxlint": "1.23.0",
     "eslint-plugin-pnpm": "1.1.0",
     "eslint-plugin-svelte": "3.11.0",
     "eslint-plugin-unused-imports": "4.1.4",
     "globals": "16.3.0",
     "jsonc-eslint-parser": "2.4.0",
     "ora": "8.2.0",
-    "prettier": "^3.6.1",
     "prettier-plugin-svelte": "3.4.0",
     "prettier-plugin-tailwindcss": "0.6.14",
-    "typescript-eslint": "8.37.0",
+    "typescript-eslint": "8.46.1",
     "yaml-eslint-parser": "1.3.0",
     "@kitql/helpers": "0.8.13"
   },
@@ -57,10 +68,10 @@
   },
   "sideEffects": false,
   "scripts": {
-    "format": "node ./cmd.js -f -d --verbose",
+    "format": "node ./cmd.js -f -d --verbose --ox",
     "format:example": "kitql-lint --format",
-    "lint": "node ./cmd.js --verbose -p none",
-    "lint:example": "kitql-lint",
-    "inspector": "npx @eslint/config-inspector"
+    "inspector": "npx @eslint/config-inspector",
+    "lint": "node ./cmd.js --verbose -p none --ox",
+    "lint:example": "kitql-lint"
   }
 }