@kitql/eslint-config 0.8.3 → 0.9.0

package/.oxfmtrc.json

@@ -0,0 +1,33 @@
+{
+	"$schema": "./node_modules/oxfmt/configuration_schema.json",
+	"tabWidth": 1,
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "all",
+	"semi": false,
+	"arrowParens": "always",
+	"printWidth": 100,
+	"sortPackageJson": false,
+	"sortImports": {
+		"groups": [
+			"builtin",
+			{ "newlinesBetween": false },
+			"external",
+			"kitql",
+			"sveltekit",
+			"aliases",
+			["parent", "sibling", "index"],
+			"unknown"
+		],
+		"customGroups": [
+			{ "groupName": "kitql", "elementNamePattern": ["@kitql/**"] },
+			{
+				"groupName": "sveltekit",
+				"elementNamePattern": ["$env", "$env/**", "$app", "$app/**"]
+			},
+			{ "groupName": "aliases", "elementNamePattern": ["$*", "$*/**"] }
+		],
+		"newlinesBetween": true
+	},
+	"ignorePatterns": []
+}

package/.oxlintrc.json

@@ -1,19 +1,62 @@
 {
 	"$schema": "./node_modules/oxlint/configuration_schema.json",
 	"plugins": ["unicorn", "typescript", "oxc"],
-	"jsPlugins": ["eslint-plugin-svelte"],
+	"jsPlugins": ["@e18e/eslint-plugin", "eslint-plugin-svelte"],
+	"ignorePatterns": ["**/test/fixtures/**"],
+	"categories": {
+		"correctness": "error"
+	},
 	"rules": {
-		// "no-unused-vars": [
-		// 	"error",
-		// 	{ "caughtErrors": "none", "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
-		// ],
 		"no-console": [
 			"error",
 			{
 				"allow": ["info", "warn", "error", "time", "timeEnd", "dir"]
 			}
 		],
+		"no-unused-vars": ["error", { "args": "none", "caughtErrors": "none" }],
+		"@typescript-eslint/no-unused-vars": ["error", { "args": "none", "caughtErrors": "none" }],
 		"@typescript-eslint/no-redundant-type-constituents": "off",
-		"no-base-to-string": "off"
-	}
+		"@typescript-eslint/no-unused-expressions": "off",
+		"no-unused-expressions": "off",
+		"no-base-to-string": "off",
+
+		"e18e/prefer-array-at": "error",
+		"e18e/prefer-array-fill": "error",
+		"e18e/prefer-includes": "error",
+		"e18e/prefer-array-to-reversed": "error",
+		"e18e/prefer-array-to-sorted": "error",
+		"e18e/prefer-array-to-spliced": "error",
+		"e18e/prefer-nullish-coalescing": "error",
+		"e18e/prefer-object-has-own": "error",
+		"e18e/prefer-spread-syntax": "error",
+		"e18e/prefer-url-canparse": "error",
+		"e18e/ban-dependencies": "error",
+		"e18e/prefer-array-from-map": "error",
+		"e18e/prefer-timer-args": "error",
+		"e18e/prefer-date-now": "error",
+		"e18e/prefer-regex-test": "error",
+		"e18e/prefer-array-some": "error",
+		"e18e/prefer-static-regex": "error",
+
+		"@typescript-eslint/prefer-find": "error",
+		"@typescript-eslint/prefer-readonly": "error",
+		"@typescript-eslint/prefer-regexp-exec": "error"
+	},
+	"overrides": [
+		{
+			"files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
+			"rules": {
+				"no-var": "error",
+				"prefer-const": "error",
+				"prefer-rest-params": "error",
+				"prefer-spread": "error"
+			}
+		},
+		{
+			"files": ["**/*.test.ts", "**/*.test.js", "**/*.spec.ts", "**/*.spec.js"],
+			"rules": {
+				"e18e/prefer-static-regex": "off"
+			}
+		}
+	]
 }

package/README.md

@@ -13,9 +13,41 @@
 npm install @kitql/eslint-config --D
 ```
 
+### tools
+
+`kitql-lint` orchestrates four optional tools - install only what you want to use:
+
+| Tool      | What it does                                              |
+| --------- | --------------------------------------------------------- |
+| eslint    | Linter (svelte rules, pnpm catalog rules, custom rules)   |
+| prettier  | Formatter (every file type, incl. `.svelte`)              |
+| oxlint    | Faster linter (Rust); covers most JS/TS rules             |
+| oxfmt     | Faster formatter (Rust); doesn't speak `.svelte` yet      |
+
+By default `kitql-lint` runs `eslint` + `prettier`. Pick others with `-t`:
+
+```bash
+kitql-lint                                            # eslint + prettier (default)
+kitql-lint -t eslint,prettier,oxlint,tsgolint         # add oxlint + type-aware
+kitql-lint -t oxlint,tsgolint,oxfmt,eslint,prettier   # 🦀 svelte + full oxc (recommended)
+kitql-lint -t oxlint,tsgolint,oxfmt                   # 🦀 pure oxc (no .svelte support)
+```
+
+For the svelte combo, enable oxlint integration in eslint to avoid duplicate work on `.ts/.js`:
+
+```js
+// eslint.config.js
+import { kitql } from '@kitql/eslint-config'
+
+export default [...kitql({ oxlint: { enable: true } })]
+```
+
+When `oxfmt` is in the tool set, `prettier` auto-restricts to `**/*.svelte` (oxfmt can't parse
+svelte yet); `oxfmt` handles every other file type.
+
 ### eslint config
 
-`.eslint.config.js`
+`eslint.config.js`
 
 ```js
 import { kitql } from '@kitql/eslint-config'
@@ -25,10 +57,10 @@ export default [...kitql()]
 
 ### prettier config
 
-`.prettierrc.cjs`
+`.prettierrc.js`
 
 ```js
-import { kitql } from './packages/eslint-config/.prettierrc.cjs'
+import { kitql } from '@kitql/eslint-config/.prettierrc.js'
 
 export default {
   ...kitql(),
@@ -36,6 +68,23 @@ export default {
 }
 ```
 
+### oxlint config
+
+`.oxlintrc.json`
+
+```jsonc
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": ["./node_modules/@kitql/eslint-config/.oxlintrc.json"],
+  "rules": {}
+}
+```
+
+### oxfmt config
+
+`.oxfmtrc.json` - copy from
+[`@kitql/eslint-config/.oxfmtrc.json`](./.oxfmtrc.json) (oxfmt has no `extends` yet).
+
 ### ignore things with
 
 `.prettierignore`

package/cmd.js

@@ -2,46 +2,78 @@
 import { spawn } from 'node:child_process'
 import fs from 'node:fs'
 import path from 'node:path'
-import { Option, program } from 'commander'
 
 import { gray, green, Log } from '@kitql/helpers'
+import { parseCli } from '@kitql/helpers/server'
 
 import { findFileOrUp } from './helper/findFileOrUp.js'
-
-/** @type {('eslint' | 'prettier' | 'oxlint' | 'tsgolint')[]} */
-const TOOLS_ALL = ['eslint', 'prettier', 'oxlint', 'tsgolint']
-const TOOLS_DEFAULT = TOOLS_ALL.slice(0, 2)
-
-program.addOption(new Option('-f, --format', 'format'))
-program.addOption(new Option('-g, --glob <type>', 'file/dir/glob').default('.'))
-program.addOption(
-	new Option('-t, --tools <type>', 'tools to use (eslint, prettier, oxlint, tsgolint)').default(
-		TOOLS_DEFAULT.join(','),
-	),
-)
-program.addOption(new Option('-v, --verbose', 'add more logs').default(false))
-program.addOption(
-	new Option('-d, --diff-only', 'only check files changed against base branch').default(false),
-)
-program.addOption(
-	new Option('-b, --base-branch <type>', 'base branch to compare against').default('main'),
-)
-program.addOption(
-	new Option('-p, --prefix <type>', 'prefix by with "pnpm" or "npm" or "none"').default('none'),
-)
-program.parse(process.argv)
-const options_cli = program.opts()
+import {
+	buildEslintCmd,
+	buildOxfmtCmd,
+	buildOxlintCmd,
+	buildPrettierCmd,
+} from './src/buildCommands.js'
+
+/** @type {('eslint' | 'prettier' | 'oxlint' | 'tsgolint' | 'oxfmt')[]} */
+const TOOLS_ALL = ['eslint', 'prettier', 'oxlint', 'tsgolint', 'oxfmt']
+const TOOLS_DEFAULT = ['eslint', 'prettier']
+
+const { values: options_cli, help } = parseCli({
+	name: 'kitql-lint',
+	options: {
+		format: { type: 'boolean', short: 'f', description: 'format' },
+		glob: { type: 'string', short: 'g', default: '.', description: 'file/dir/glob' },
+		tools: {
+			type: 'string',
+			short: 't',
+			default: TOOLS_DEFAULT.join(','),
+			description: 'tools to use (eslint, prettier, oxlint, tsgolint, oxfmt)',
+		},
+		verbose: { type: 'boolean', short: 'v', default: false, description: 'add more logs' },
+		'diff-only': {
+			type: 'boolean',
+			short: 'd',
+			default: false,
+			description: 'only check files changed against base branch',
+		},
+		'base-branch': {
+			type: 'string',
+			short: 'b',
+			default: 'main',
+			description: 'base branch to compare against',
+		},
+		prefix: {
+			type: 'string',
+			short: 'p',
+			default: 'none',
+			description: 'prefix by with "pnpm" or "npm" or "none"',
+		},
+	},
+})
+
+if (options_cli.help) {
+	console.info(help)
+	process.exit(0)
+}
 
 const pathPrettierIgnore = findFileOrUp('.prettierignore')
 const pathPrettier_js = findFileOrUp('.prettierrc.js')
+const pathOxfmtrc = findFileOrUp('.oxfmtrc.json')
 
 const format = /** @type {boolean} */ (options_cli.format ?? false)
 let glob = /** @type {string} */ (options_cli.glob ?? '.')
 const verbose = /** @type {boolean} */ (options_cli.verbose ?? false)
 const pre = /** @type {string} */ (options_cli.prefix ?? 'none')
-const tools = /** @type {typeof TOOLS_ALL} */ (options_cli.tools.split(',') ?? TOOLS_DEFAULT)
-const diffOnly = /** @type {boolean} */ (options_cli.diffOnly ?? false)
-const baseBranch = /** @type {string} */ (options_cli.baseBranch ?? 'main')
+const tools = /** @type {typeof TOOLS_ALL} */ (
+	String(options_cli.tools ?? TOOLS_DEFAULT.join(',')).split(',')
+)
+const unknown = tools.filter((t) => !TOOLS_ALL.includes(t))
+if (unknown.length > 0) {
+	console.error(`Unknown tool(s): ${unknown.join(', ')}. Supported: ${TOOLS_ALL.join(', ')}`)
+	process.exit(2)
+}
+const diffOnly = /** @type {boolean} */ (options_cli['diff-only'] ?? false)
+const baseBranch = /** @type {string} */ (options_cli['base-branch'] ?? 'main')
 
 const log = new Log('kitql-lint')
 // const spinner = new Spinner({ symbolFormatter: (msg) => bgBlueBright(` kitql-lint `) + ' ' + msg })
@@ -269,55 +301,41 @@ async function getDiffFiles() {
 	}
 }
 
-async function runOxc(/** @type {string} */ name) {
-	const cmdLint =
-		`oxlint` +
-		`${tools.includes('tsgolint') ? ' --type-aware' : ''}` +
-		// format or not
-		`${format ? ' --fix' : ''}` +
-		` ${glob}`
+function buildOpts() {
+	return {
+		tools,
+		format,
+		glob,
+		pre: preToUse,
+		pathPrettierIgnore,
+		pathPrettier_js,
+		pathOxfmtrc,
+	}
+}
 
+async function runOxc(/** @type {string} */ name) {
+	const cmdLint = buildOxlintCmd(buildOpts())
 	log.info(gray(`${verbose ? cmdLint : name} `))
-
-	const result_lint = await customSpawn(cmdLint)
-
-	return result_lint
+	return customSpawn(cmdLint)
 }
 
 async function runEslint() {
-	const cmd =
-		preToUse +
-		`eslint --no-warn-ignored` +
-		// format or not
-		`${format ? ' --fix' : ''}` +
-		// exec
-		` ${glob}`
-
+	const cmd = buildEslintCmd(buildOpts())
 	log.info(gray(`${verbose ? cmd : 'eslint'} `))
-	const result_lint = await customSpawn(cmd)
-
-	return result_lint
+	return customSpawn(cmd)
 }
 
 async function runPrettier() {
-	const cmdFormat =
-		preToUse +
-		`prettier` +
-		` --list-different` +
-		// ignore?
-		` --ignore-path ${pathPrettierIgnore}` +
-		// config
-		` --config ${pathPrettier_js}` +
-		// format or not
-		`${format ? ' --write' : ''}` +
-		// exec
-		` ${glob}`
-
-	log.info(gray(`${verbose ? cmdFormat : 'prettier'} `))
-
-	const result_format = await customSpawn(cmdFormat)
-
-	return result_format
+	const cmd = buildPrettierCmd(buildOpts())
+	const svelteOnly = tools.includes('oxfmt')
+	log.info(gray(`${verbose ? cmd : svelteOnly ? 'prettier (svelte)' : 'prettier'} `))
+	return customSpawn(cmd)
+}
+
+async function runOxfmt() {
+	const cmd = buildOxfmtCmd(buildOpts())
+	log.info(gray(`${verbose ? cmd : 'oxfmt'} `))
+	return customSpawn(cmd)
 }
 
 /** @type {string[]} */
@@ -370,11 +388,22 @@ if (tools.includes('eslint') && glob) {
 	}
 }
 
+if (tools.includes('oxfmt') && glob) {
+	const start = performance.now()
+	const code = await runOxfmt()
+	const stepTook = performance.now() - start
+	took.push(display('oxfmt', stepTook))
+	if (typeof code === 'object' && 'status' in code && code.status) {
+		log.error(`format failed, check logs above. ${displayTook()}`)
+		process.exit(Number(code.status))
+	}
+}
+
 if (tools.includes('prettier') && glob) {
 	const start = performance.now()
 	const code = await runPrettier()
 	const stepTook = performance.now() - start
-	took.push(display('prettier', stepTook))
+	took.push(display(tools.includes('oxfmt') ? 'prettier (svelte)' : 'prettier', stepTook))
 	if (typeof code === 'object' && 'status' in code && code.status) {
 		log.error(`format failed, check logs above. ${displayTook()}`)
 		process.exit(Number(code.status))

package/eslint.config.js

@@ -119,7 +119,15 @@ const othersRules = ({ svelteConfig } = {}) => {
 		},
 		{
 			name: '@kitql:ignores',
-			ignores: ['build/', '.svelte-kit/', 'dist/', '**/build/', '**/.svelte-kit/', '**/dist/'],
+			ignores: [
+				'build/',
+				'.svelte-kit/',
+				'dist/',
+				'**/build/',
+				'**/.svelte-kit/',
+				'**/dist/',
+				'**/test/fixtures/**',
+			],
 		},
 		{
 			name: '@kitql:tests',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitql/eslint-config",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "type": "module",
   "description": "opinionated linting and formatting for projects",
   "repository": {
@@ -18,12 +18,14 @@
   "main": "eslint.config.js",
   "types": "eslint.config.d.ts",
   "files": [
+    ".oxfmtrc.json",
     ".oxlintrc.json",
     ".prettierrc.js",
     "cmd.js",
     "eslint.config.js",
     "eslint.config.d.ts",
-    "helper/findFileOrUp.js"
+    "helper/findFileOrUp.js",
+    "src/buildCommands.js"
   ],
   "keywords": [
     "cli",
@@ -34,15 +36,19 @@
     "format"
   ],
   "peerDependencies": {
-    "eslint": "10.3.0",
-    "oxlint": "1.64.0",
-    "oxlint-tsgolint": "0.22.1",
-    "prettier": "^3.6.1"
+    "eslint": "10.4.0",
+    "oxfmt": "0.51.0",
+    "oxlint": "1.66.0",
+    "oxlint-tsgolint": "0.23.0",
+    "prettier": "^3.8.3"
   },
   "peerDependenciesMeta": {
     "eslint": {
       "optional": true
     },
+    "oxfmt": {
+      "optional": true
+    },
     "oxlint": {
       "optional": true
     },
@@ -53,26 +59,29 @@
       "optional": true
     }
   },
+  "devDependencies": {
+    "@vitest/coverage-v8": "4.1.4",
+    "vitest": "4.1.4"
+  },
   "dependencies": {
-    "@e18e/eslint-plugin": "^0.4.0",
+    "@e18e/eslint-plugin": "^0.5.0",
     "@eslint/compat": "2.1.0",
     "@eslint/js": "10.0.1",
     "@ianvs/prettier-plugin-sort-imports": "^4.7.0",
     "@types/eslint": "9.6.1",
     "@typescript-eslint/parser": "8.59.3",
-    "commander": "14.0.0",
     "eslint-config-prettier": "10.1.5",
-    "eslint-plugin-oxlint": "1.64.0",
+    "eslint-plugin-oxlint": "1.66.0",
     "eslint-plugin-pnpm": "1.6.0",
     "eslint-plugin-svelte": "3.17.1",
     "globals": "17.6.0",
     "jsonc-eslint-parser": "3.1.0",
     "prettier-plugin-sh": "^0.18.0",
-    "prettier-plugin-svelte": "^3.4.0",
-    "prettier-plugin-tailwindcss": "^0.7.2",
+    "prettier-plugin-svelte": "^4.0.0",
+    "prettier-plugin-tailwindcss": "^0.8.0",
     "typescript-eslint": "8.59.3",
     "yaml-eslint-parser": "2.0.0",
-    "@kitql/helpers": "0.8.14"
+    "@kitql/helpers": "0.8.15"
   },
   "publishConfig": {
     "access": "public"
@@ -83,6 +92,9 @@
     "format:example": "kitql-lint --format",
     "inspector": "npx @eslint/config-inspector",
     "lint": "node ./cmd.js --verbose -p none",
-    "lint:example": "kitql-lint"
+    "lint:oxc": "node ./cmd.js -p none -t oxlint,oxfmt,prettier",
+    "lint:example": "kitql-lint",
+    "test": "vitest",
+    "test:ci": "vitest run --coverage"
   }
 }

package/src/buildCommands.js

@@ -0,0 +1,75 @@
+/**
+ * Pure helpers that build the shell commands `kitql-lint` runs.
+ * Extracted so they can be unit-tested without spawning processes.
+ */
+
+/**
+ * @typedef {Object} BuildOptions
+ * @property {string[]} tools - selected tools
+ * @property {boolean} format - format vs lint
+ * @property {string} glob - target glob/files
+ * @property {string} [pre] - prefix to prepend to commands ('', 'pnpm ', 'npm exec ')
+ * @property {string} [pathPrettierIgnore]
+ * @property {string} [pathPrettier_js]
+ * @property {string} [pathOxfmtrc]
+ */
+
+/**
+ * @param {BuildOptions} opts
+ */
+export function buildOxlintCmd(opts) {
+	const { tools, format, glob, pre = '' } = opts
+	return (
+		pre +
+		`oxlint` +
+		`${tools.includes('tsgolint') ? ' --type-aware' : ''}` +
+		`${format ? ' --fix' : ''}` +
+		` ${glob}`
+	)
+}
+
+/**
+ * @param {BuildOptions} opts
+ */
+export function buildEslintCmd(opts) {
+	const { format, glob, pre = '' } = opts
+	return pre + `eslint --no-warn-ignored` + `${format ? ' --fix' : ''}` + ` ${glob}`
+}
+
+/**
+ * @param {BuildOptions} opts
+ */
+export function buildPrettierCmd(opts) {
+	const { tools, format, glob, pre = '', pathPrettierIgnore, pathPrettier_js } = opts
+	// When oxfmt is in the tool set, oxfmt formats every file type it supports
+	// and prettier only handles .svelte (oxfmt can't parse it yet) - regardless of mode.
+	const svelteOnly = tools.includes('oxfmt')
+	const target = svelteOnly ? `'**/*.svelte'` : glob
+
+	return (
+		pre +
+		`prettier` +
+		` --list-different` +
+		` --ignore-path ${pathPrettierIgnore}` +
+		` --config ${pathPrettier_js}` +
+		`${svelteOnly ? ' --no-error-on-unmatched-pattern' : ''}` +
+		`${format ? ' --write' : ''}` +
+		` ${target}`
+	)
+}
+
+/**
+ * @param {BuildOptions} opts
+ */
+export function buildOxfmtCmd(opts) {
+	const { format, glob, pre = '', pathPrettierIgnore, pathOxfmtrc } = opts
+	return (
+		pre +
+		`oxfmt` +
+		(pathPrettierIgnore ? ` --ignore-path ${pathPrettierIgnore}` : '') +
+		(pathOxfmtrc ? ` --config ${pathOxfmtrc}` : '') +
+		`${format ? ' --write' : ' --check'}` +
+		` --no-error-on-unmatched-pattern` +
+		` ${glob}`
+	)
+}