@kitql/eslint-config 0.5.3 → 0.5.5-next.0

package/cmd.js

@@ -1,12 +1,15 @@
 #!/usr/bin/env node
 import { spawn } from 'node:child_process'
+import fs from 'node:fs'
+import path from 'node:path'
 import { Option, program } from 'commander'
 import ora from 'ora'
 
-import { bgBlueBright, bgGreen, bgRedBright, gray, red } from '@kitql/helpers'
+import { bgBlueBright, bgGreen, bgRedBright, gray, green, red } from '@kitql/helpers'
 
 import { findFileOrUp } from './helper/findFileOrUp.js'
 
+// df
 const spinner = ora({
   // hideCursor: true,
   prefixText: bgBlueBright(` kitql-lint `),
@@ -16,7 +19,15 @@ 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('-d, --diff-only', 'only check files changed against base branch', false),
+)
+program.addOption(
+  new Option('--base-branch <type>', 'base branch to compare against (default: main)', 'main'),
+)
 program.addOption(
   new Option(
     '-p, --prefix <type>',
@@ -29,12 +40,16 @@ program.parse(process.argv)
 const options_cli = program.opts()
 
 const pathPrettierIgnore = findFileOrUp('.prettierignore')
-const pathPrettierCjs = findFileOrUp('.prettierrc.mjs')
+const pathPrettierMjs = findFileOrUp('.prettierrc.mjs')
 
 const format = options_cli.format ?? false
-const glob = options_cli.glob ?? '.'
+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 diffOnly = options_cli.diffOnly ?? false
+const baseBranch = options_cli.baseBranch ?? 'main'
 
 let preToUse = ''
 if (pre === 'npm') {
@@ -74,10 +89,191 @@ async function customSpawn(cmd) {
   return data
 }
 
+let filesLength = -1
+async function getDiffFiles() {
+  spinner.text = verbose
+    ? 'git diff ' + gray(`(getting changed files against ${baseBranch})`)
+    : 'git diff'
+
+  // First, get the git repository root
+  let gitRootPath = ''
+  try {
+    const gitRootCmd = 'git rev-parse --show-toplevel'
+    const gitRootChild = spawn(gitRootCmd, {
+      shell: true,
+      cwd: process.cwd(),
+    })
+
+    let rootData = ''
+    for await (const chunk of gitRootChild.stdout) {
+      rootData += chunk
+    }
+
+    const gitRootExitCode = await new Promise((resolve) => {
+      gitRootChild.on('close', resolve)
+    })
+
+    if (gitRootExitCode === 0) {
+      gitRootPath = rootData.trim()
+    } else {
+      spinner.warn('Could not determine git repository root')
+      return null
+    }
+  } catch (error) {
+    spinner.warn(`Error getting git root: ${error.message}`)
+    return null
+  }
+
+  // Try to find the best base branch to compare against
+  const possibleBranches = [baseBranch, 'main', 'HEAD~1']
+  let validBranch = null
+
+  for (const branch of possibleBranches) {
+    try {
+      // Check if the branch exists
+      const checkBranchCmd = `git rev-parse --verify ${branch}`
+      const checkBranchChild = spawn(checkBranchCmd, {
+        shell: true,
+        cwd: process.cwd(),
+      })
+
+      const branchExitCode = await new Promise((resolve) => {
+        checkBranchChild.on('close', resolve)
+      })
+
+      if (branchExitCode === 0) {
+        validBranch = branch
+        if (verbose && branch !== baseBranch) {
+          spinner.info(`Using '${branch}' as base branch instead of '${baseBranch}'`)
+        }
+        break
+      }
+    } catch (error) {
+      // Continue to next branch
+    }
+  }
+
+  if (!validBranch) {
+    // If in CI, try to use a different approach
+    if (process.env.CI) {
+      try {
+        // In CI, we can try to get all staged and unstaged changes
+        validBranch = 'HEAD'
+        if (verbose) {
+          spinner.info('In CI environment, checking all changes')
+        }
+      } catch (error) {
+        spinner.warn(`Could not find a valid base branch to compare against`)
+        return null
+      }
+    } else {
+      spinner.warn(`Could not find a valid base branch to compare against`)
+      return null
+    }
+  }
+
+  // Now get the changed files
+  const cmd = `git diff --name-only --diff-filter=ACMR ${validBranch}`
+
+  try {
+    const child = spawn(cmd, {
+      shell: true,
+      cwd: process.cwd(),
+    })
+
+    let data = ''
+    for await (const chunk of child.stdout) {
+      data += chunk
+    }
+
+    let error = ''
+    for await (const chunk of child.stderr) {
+      error += chunk
+    }
+
+    const exitCode = await new Promise((resolve) => {
+      child.on('close', resolve)
+    })
+
+    if (exitCode) {
+      // If the diff command failed, try a fallback approach for CI environments
+      if (process.env.CI) {
+        try {
+          // In CI, we can try to get all tracked files that have changes
+          const fallbackCmd = 'git ls-files --modified --others --exclude-standard'
+          const fallbackChild = spawn(fallbackCmd, {
+            shell: true,
+            cwd: process.cwd(),
+          })
+
+          let fallbackData = ''
+          for await (const chunk of fallbackChild.stdout) {
+            fallbackData += chunk
+          }
+
+          const fallbackExitCode = await new Promise((resolve) => {
+            fallbackChild.on('close', resolve)
+          })
+
+          if (fallbackExitCode === 0 && fallbackData.trim()) {
+            data = fallbackData
+            if (verbose) {
+              spinner.info('Using fallback method to get changed files in CI')
+            }
+          } else {
+            spinner.warn(`Could not get changed files: ${error}`)
+            return null
+          }
+        } catch (fallbackError) {
+          spinner.warn(`Could not get changed files: ${error}`)
+          return null
+        }
+      } else {
+        spinner.warn(`Could not get changed files: ${error}`)
+        return null
+      }
+    }
+
+    // Get the current working directory
+    const cwd = process.cwd()
+
+    // Process the files to make them relative to the current working directory
+    const files = data
+      .trim()
+      .split('\n')
+      .filter(Boolean)
+      .map((file) => {
+        // Convert the git path (relative to git root) to an absolute path
+        const absolutePath = path.join(gitRootPath, file)
+
+        // Convert the absolute path to a path relative to the current working directory
+        const relativePath = path.relative(cwd, absolutePath)
+
+        // Check if the file exists and is at or below the current directory
+        if (fs.existsSync(relativePath) && !relativePath.startsWith('..')) {
+          return relativePath
+        }
+        return null
+      })
+      .filter(Boolean) // Remove null entries (files not at or below current directory)
+
+    filesLength = files.length
+    if (verbose) {
+      spinner.info(`Found ${filesLength} changed files at or below current directory`)
+    }
+
+    // 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}`)
+    return null
+  }
+}
+
 async function eslintRun() {
   const cmdEsLint =
     preToUse +
-    `eslint` +
+    `eslint --no-warn-ignored` +
     // format or not
     `${format ? ' --fix' : ''}` +
     // exec
@@ -98,7 +294,7 @@ async function prettierRun() {
     // ignore?
     ` --ignore-path ${pathPrettierIgnore}` +
     // config
-    ` --config ${pathPrettierCjs}` +
+    ` --config ${pathPrettierMjs}` +
     // format or not
     `${format ? ' --write' : ''}` +
     // exec
@@ -111,21 +307,54 @@ async function prettierRun() {
   return result_prettier
 }
 
-const eslintCode = await eslintRun()
-if (eslintCode.status) {
-  spinner.prefixText = bgRedBright(` kitql-lint `)
-  spinner.fail(red(`eslint failed, check logs above.`))
-  process.exit(eslintCode.status)
+const took = []
+
+const display = (text, time) => {
+  return `${gray(text)} ${green((time / 1000).toFixed(3))}${gray('s')}`
 }
 
-const prettierCode = await prettierRun()
-if (prettierCode.status) {
-  spinner.prefixText = bgRedBright(` kitql-lint `)
-  spinner.fail(red(`prettier failed, check logs above.`))
-  process.exit(prettierCode.status)
+// 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
+  took.push(display('diff', changedFilesTook))
+
+  if (changedFiles) {
+    glob = changedFiles
+  } else {
+    glob = ''
+  }
+}
+
+if (!prettierOnly && glob) {
+  const esLintStart = performance.now()
+  const eslintCode = await eslintRun()
+  const esLintTook = performance.now() - esLintStart
+  took.push(display('eslint', esLintTook))
+  if (eslintCode.status) {
+    spinner.prefixText = bgRedBright(` kitql-lint `)
+    spinner.fail(red(`eslint failed, check logs above.`))
+    process.exit(eslintCode.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) {
+    spinner.prefixText = bgRedBright(` kitql-lint `)
+    spinner.fail(red(`prettier failed, check logs above.`))
+    process.exit(prettierCode.status)
+  }
 }
 
 spinner.prefixText = bgGreen(` kitql-lint `)
-spinner.succeed(`All good, your files looks great!`)
+spinner.succeed(
+  `All good, ${glob === '' ? 'nothing to do!' : filesLength !== -1 ? `your ${filesLength} files looks great!` : 'your files looks great!'} ${gray('(')}${took.join(gray(', '))}${gray(')')}`,
+)
 spinner.stop()
 process.exit(0)

package/eslint.config.js

@@ -1,5 +1,6 @@
 import { includeIgnoreFile } from '@eslint/compat'
 import js from '@eslint/js'
+import pnpmCatalogs from 'eslint-plugin-pnpm-catalogs'
 import svelte from 'eslint-plugin-svelte'
 import unusedImports from 'eslint-plugin-unused-imports'
 import globals from 'globals'
@@ -66,6 +67,16 @@ export const config = [
       'no-empty': ['error', { allowEmptyCatch: true }],
     },
   },
+  {
+    name: '@kitql:pnpmCatalogs',
+    plugins: {
+      pnpmCatalogs,
+    },
+    rules: {
+      'pnpmCatalogs/enforce-catalog': 'error',
+      'pnpmCatalogs/valid-catalog': 'error',
+    },
+  },
   {
     name: '@kitql:rules',
     rules: {
@@ -86,8 +97,11 @@ export const config = [
 
       'no-undef': 'off',
       'no-inner-declarations': 'off',
+
       'svelte/no-at-html-tags': 'off',
       'svelte/no-inner-declarations': 'off',
+
+      'svelte/require-each-key': 'warn',
     },
   },
 ]

package/helper/findFileOrUp.js

@@ -1,5 +1,5 @@
-import { statSync } from 'fs'
-import { resolve } from 'path'
+import { statSync } from 'node:fs'
+import { resolve } from 'node:path'
 
 export const findFileOrUp = (fileName, options) => {
   // Find file recursively 4 levels max up

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitql/eslint-config",
-  "version": "0.5.3",
+  "version": "0.5.5-next.0",
   "type": "module",
   "funding": "https://github.com/sponsors/jycouet",
   "homepage": "https://www.kitql.dev/",
@@ -30,18 +30,19 @@
     "eslint-config"
   ],
   "dependencies": {
-    "@eslint/compat": "^1.1.1",
-    "@eslint/js": "^9.10.0",
+    "@eslint/compat": "1.1.1",
+    "@eslint/js": "9.10.0",
     "@theguild/prettier-config": "3.0.0",
     "@types/eslint": "9.6.1",
-    "@typescript-eslint/parser": "^8.5.0",
-    "commander": "13.0.0",
-    "eslint": "^9.10.0",
-    "eslint-plugin-svelte": "2.46.0",
-    "eslint-plugin-unused-imports": "^4.1.4",
+    "@typescript-eslint/parser": "8.5.0",
+    "commander": "13.1.0",
+    "eslint": "9.10.0",
+    "eslint-plugin-pnpm-catalogs": "0.0.2",
+    "eslint-plugin-svelte": "3.0.3",
+    "eslint-plugin-unused-imports": "4.1.4",
     "globals": "16.0.0",
-    "ora": "^8.1.0",
-    "prettier": "3.4.2",
+    "ora": "8.1.0",
+    "prettier": "3.5.3",
     "prettier-plugin-svelte": "3.3.2",
     "prettier-plugin-tailwindcss": "0.6.6",
     "typescript-eslint": "8.26.0",
@@ -52,7 +53,7 @@
   },
   "sideEffects": false,
   "scripts": {
-    "format": "node ./cmd.js -f",
+    "format": "node ./cmd.js -f -d --verbose",
     "format:example": "kitql-lint --format",
     "lint": "node ./cmd.js --verbose -p none",
     "lint:example": "kitql-lint",