@kitql/eslint-config 0.8.0-next.2 → 0.8.0-next.4

package/.prettierrc.js

@@ -1,14 +1,14 @@
-import prettierConfig from '@theguild/prettier-config'
-
 const config = {
-	...prettierConfig,
 	tabWidth: 1,
 	useTabs: true,
 	singleQuote: true,
+	trailingComma: 'all',
 	semi: false,
 	arrowParens: 'always',
+	printWidth: 100,
 	plugins: [
-		...prettierConfig.plugins,
+		'@ianvs/prettier-plugin-sort-imports',
+		'prettier-plugin-sh',
 		'prettier-plugin-svelte',
 		'prettier-plugin-tailwindcss', // MUST come last
 	],
@@ -31,15 +31,15 @@ const config = {
 		'',
 		'^[./]', // inside
 	],
-	overrides: [
-		{
-			files: ['README.md', 'packages/**/README.md'],
-			options: {
-				useTabs: false,
-				tabWidth: 2,
-			},
-		},
-	],
+	// overrides: [
+	// 	{
+	// 		files: ['README.md', 'packages/**/README.md'],
+	// 		options: {
+	// 			useTabs: false,
+	// 			tabWidth: 2,
+	// 		},
+	// 	},
+	// ],
 }
 export default config
 

package/cmd.js

@@ -9,34 +9,26 @@ import { bgBlueBright, bgGreen, bgRedBright, gray, green, red } from '@kitql/hel
 
 import { findFileOrUp } from './helper/findFileOrUp.js'
 
-// df
-const spinner = ora({
-	// hideCursor: true,
-	prefixText: bgBlueBright(` kitql-lint `),
-	text: 'check config',
-})
-spinner.start()
+/** @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 (. 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('--oxt', 'using oxc & type aware').default(false))
+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('--base-branch <type>', 'base branch to compare against (default: main)').default(
-		'main',
-	),
+	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" ("none" by default)',
-	).default('none'),
+	new Option('-p, --prefix <type>', 'prefix by with "pnpm" or "npm" or "none"').default('none'),
 )
 program.parse(process.argv)
 const options_cli = program.opts()
@@ -44,16 +36,23 @@ const options_cli = program.opts()
 const pathPrettierIgnore = findFileOrUp('.prettierignore')
 const pathPrettier_js = findFileOrUp('.prettierrc.js')
 
-const format = options_cli.format ?? false
-let glob = options_cli.glob ?? '.'
-const verbose = options_cli.verbose ?? false
-const pre = options_cli.prefix ?? 'none'
-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
-const using_oxt = options_cli.oxt ?? false
+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 spinner = ora({
+	prefixText: bgBlueBright(` kitql-lint `),
+})
+
+function updateSpinnerText(/** @type {string} */ msg) {
+	spinner.text = msg
+	spinner.start()
+}
+updateSpinnerText('Action: ' + green(format ? 'formatting' : 'linting'))
 
 let preToUse = ''
 if (pre === 'npm') {
@@ -96,9 +95,9 @@ async function customSpawn(/** @type {string} */ cmd) {
 
 let filesLength = -1
 async function getDiffFiles() {
-	spinner.text = verbose
-		? 'git diff ' + gray(`(getting changed files against ${baseBranch})`)
-		: 'git diff'
+	updateSpinnerText(
+		verbose ? 'git diff ' + gray(`(getting changed files against ${baseBranch})`) : 'git diff',
+	)
 
 	// First, get the git repository root
 	let gitRootPath = ''
@@ -275,30 +274,23 @@ async function getDiffFiles() {
 	}
 }
 
-async function lintRunOx() {
+async function runOxc(/** @type {string} */ name) {
 	const cmdLint =
 		`oxlint` +
-		`${using_oxt ? ' --type-aware' : ''}` +
+		`${tools.includes('tsgolint') ? ' --type-aware' : ''}` +
 		// format or not
 		`${format ? ' --fix' : ''}` +
 		` ${glob}`
 
-	spinner.text = verbose ? 'lint ' + gray(`(${cmdLint}) `) : 'lint '
+	updateSpinnerText(gray(`${verbose ? cmdLint : name} `))
 
 	const result_lint = await customSpawn(cmdLint)
 
 	return result_lint
 }
 
-async function lintRun() {
-	if (using_ox || using_oxt) {
-		const result_lint = await lintRunOx()
-		if (typeof result_lint === 'object' && 'status' in result_lint && result_lint.status) {
-			return result_lint
-		}
-	}
-
-	const cmdLint =
+async function runEslint() {
+	const cmd =
 		preToUse +
 		`eslint --no-warn-ignored` +
 		// format or not
@@ -306,14 +298,14 @@ async function lintRun() {
 		// exec
 		` ${glob}`
 
-	spinner.text = verbose ? 'lint ' + gray(`(${cmdLint}) `) : 'lint '
+	updateSpinnerText(gray(`${verbose ? cmd : 'eslint'} `))
 
-	const result_lint = await customSpawn(cmdLint)
+	const result_lint = await customSpawn(cmd)
 
 	return result_lint
 }
 
-async function formatRun() {
+async function runPrettier() {
 	const cmdFormat =
 		preToUse +
 		`prettier` +
@@ -327,7 +319,7 @@ async function formatRun() {
 		// exec
 		` ${glob}`
 
-	spinner.text = verbose ? 'format ' + gray(`(${cmdFormat}) `) : 'format '
+	updateSpinnerText(gray(`${verbose ? cmdFormat : 'prettier'} `))
 
 	const result_format = await customSpawn(cmdFormat)
 
@@ -348,7 +340,6 @@ const displayTook = () => `${gray('(')}${took.join(gray(', '))}${gray(')')}`
 
 // If changed-only flag is set, get the list of changed files
 if (diffOnly) {
-	spinner.text = 'Checking for changed files'
 	const changedFilesStart = performance.now()
 	const changedFiles = await getDiffFiles()
 	const changedFilesTook = performance.now() - changedFilesStart
@@ -361,27 +352,41 @@ if (diffOnly) {
 	}
 }
 
-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) {
+// yes, when we have tsgolint, we need to run oxlint too...
+if ((tools.includes('oxlint') || tools.includes('tsgolint')) && glob) {
+	const start = performance.now()
+	const name = tools.includes('tsgolint') ? 'oxlint (+type)' : 'oxlint'
+	const code = await runOxc(name)
+	const stepTook = performance.now() - start
+	took.push(display(name, stepTook))
+	if (typeof code === 'object' && 'status' in code && code.status) {
+		spinner.prefixText = bgRedBright(` kitql-lint `)
+		spinner.fail(red(`lint failed, check logs above. ${displayTook()}`))
+		process.exit(code.status)
+	}
+}
+
+if (tools.includes('eslint') && glob) {
+	const start = performance.now()
+	const code = await runEslint()
+	const stepTook = performance.now() - start
+	took.push(display('eslint', stepTook))
+	if (typeof code === 'object' && 'status' in code && code.status) {
 		spinner.prefixText = bgRedBright(` kitql-lint `)
 		spinner.fail(red(`lint failed, check logs above. ${displayTook()}`))
-		process.exit(lintCode.status)
+		process.exit(code.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) {
+if (tools.includes('prettier') && glob) {
+	const start = performance.now()
+	const code = await runPrettier()
+	const stepTook = performance.now() - start
+	took.push(display('prettier', stepTook))
+	if (typeof code === 'object' && 'status' in code && code.status) {
 		spinner.prefixText = bgRedBright(` kitql-lint `)
 		spinner.fail(red(`format failed, check logs above. ${displayTook()}`))
-		process.exit(formatCode.status)
+		process.exit(code.status)
 	}
 }
 

package/eslint.config.js

@@ -173,9 +173,15 @@ const othersRules = () => {
 	]
 }
 
+/**
+ * @typedef {Object} OxlintConfig
+ * @property {boolean} [enable] - Whether to enable oxlint
+ */
+
 /**
  * @typedef {Object} KitqlOptions
  * @property {PnpmCatalogsConfig} [pnpmCatalogs] - Configuration object for pnpm catalogs
+ * @property {OxlintConfig} [oxlint] - Configuration object for oxlint
  */
 
 /**
@@ -186,18 +192,27 @@ export const kitql = (options = {}) => {
 	const pnpmCatalogsConfig = options?.pnpmCatalogs ?? { enable: false }
 	const pnpmCatalogsEnabled = pnpmCatalogsConfig.enable !== false
 
-	const pathOxlintrc = findFileOrUp('.oxlintrc.json') ?? './.oxlintrc.json'
-
-	return [
-		//
+	const arr = [
+		// default rules
 		rulePrettierIgnore({ pnpmCatalogsEnabled }),
 		...othersRules(),
-		...(pnpmCatalogsEnabled ? rulePnpmCatalogs(pnpmCatalogsConfig) : []),
-		...oxlint.buildFromOxlintConfigFile(pathOxlintrc),
 	]
+
+	if (pnpmCatalogsEnabled) {
+		arr.push(...rulePnpmCatalogs(pnpmCatalogsConfig))
+	}
+
+	const oxlintConfig = options?.oxlint ?? { enable: false }
+	const oxlintEnabled = oxlintConfig.enable !== false
+	if (oxlintEnabled) {
+		const pathOxlintrc = findFileOrUp('.oxlintrc.json') ?? './.oxlintrc.json'
+		arr.push(...oxlint.buildFromOxlintConfigFile(pathOxlintrc))
+	}
+
+	return arr
 }
 
 /** @type {import('eslint').Linter.Config[]} */
-const config = kitql({ pnpmCatalogs: { enable: true } })
+const config = kitql()
 
 export default config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitql/eslint-config",
-  "version": "0.8.0-next.2",
+  "version": "0.8.0-next.4",
   "type": "module",
   "description": "opinionated linting and formatting for projects",
   "repository": {
@@ -26,29 +26,38 @@
   "keywords": [
     "cli",
     "eslint",
-    "eslint-config"
+    "eslint-config",
+    "oxc",
+    "lint",
+    "format"
   ],
   "peerDependencies": {
+    "eslint": "9.37.0",
     "oxlint": "1.23.0",
     "oxlint-tsgolint": "0.2.0",
     "prettier": "^3.6.1"
   },
   "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
     "oxlint": {
       "optional": true
     },
     "oxlint-tsgolint": {
       "optional": true
+    },
+    "prettier": {
+      "optional": true
     }
   },
   "dependencies": {
     "@eslint/compat": "1.4.0",
     "@eslint/js": "9.37.0",
-    "@theguild/prettier-config": "3.0.0",
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.0",
     "@types/eslint": "9.6.1",
     "@typescript-eslint/parser": "8.46.1",
     "commander": "14.0.0",
-    "eslint": "9.37.0",
     "eslint-config-prettier": "10.1.5",
     "eslint-plugin-oxlint": "1.23.0",
     "eslint-plugin-pnpm": "1.2.0",
@@ -57,8 +66,9 @@
     "globals": "16.4.0",
     "jsonc-eslint-parser": "2.4.0",
     "ora": "9.0.0",
-    "prettier-plugin-svelte": "3.4.0",
-    "prettier-plugin-tailwindcss": "0.7.0",
+    "prettier-plugin-sh": "^0.18.0",
+    "prettier-plugin-svelte": "^3.4.0",
+    "prettier-plugin-tailwindcss": "^0.7.0",
     "typescript-eslint": "8.46.1",
     "yaml-eslint-parser": "1.3.0",
     "@kitql/helpers": "0.8.13"
@@ -68,10 +78,10 @@
   },
   "sideEffects": false,
   "scripts": {
-    "format": "node ./cmd.js -f -d --verbose --oxt",
+    "format": "node ./cmd.js -f -t eslint,prettier,oxlint",
     "format:example": "kitql-lint --format",
     "inspector": "npx @eslint/config-inspector",
-    "lint": "node ./cmd.js --verbose -p none --oxt",
+    "lint": "node ./cmd.js --verbose -p none",
     "lint:example": "kitql-lint"
   }
 }