lint-staged 15.3.0 → 15.4.0

package/README.md

@@ -208,6 +208,28 @@ So, considering you did `git add file1.ext file2.ext`, lint-staged will run the
 
 `your-cmd file1.ext file2.ext`
 
+### TypeScript
+
+_Lint-staged_ provides TypeScript types for the configuration and main Node.js API. You can use the JSDoc syntax in your JS configuration files:
+
+```js
+/**
+ * @filename: lint-staged.config.js
+ * @type {import('lint-staged').Configuration}
+ */
+export default {
+  '*': 'prettier --write',
+}
+```
+
+It's also possible to use the `.ts` file extension for the configuration if your Node.js version supports it. The `--experimental-strip-types` flag was introduced in [Node.js v22.6.0](https://github.com/nodejs/node/releases/tag/v22.6.0) and unflagged in [v23.6.0](https://github.com/nodejs/node/releases/tag/v23.6.0), enabling Node.js to execute TypeScript files without additional configuration.
+
+```shell
+export NODE_OPTIONS="--experimental-strip-types"
+
+npx lint-staged --config lint-staged.config.ts
+```
+
 ### Task concurrency
 
 By default _lint-staged_ will run configured tasks concurrently. This means that for every glob, all the commands will be started at the same time. With the following config, both `eslint` and `prettier` will run at the same time:

package/bin/lint-staged.js

@@ -126,7 +126,13 @@ const options = {
   verbose: !!cliOptions.verbose,
 }
 
-debugLog('Using shell: %s', userInfo().shell)
+try {
+  const { shell } = userInfo()
+  debugLog('Using shell: %s', shell)
+} catch {
+  debugLog('Could not determine current shell')
+}
+
 debugLog('Options parsed from command-line: %o', options)
 
 if (options.configPath === '-') {

package/lib/configFiles.js

@@ -16,9 +16,15 @@ export const CONFIG_FILE_NAMES = [
   '.lintstagedrc.yaml',
   '.lintstagedrc.yml',
   '.lintstagedrc.mjs',
+  '.lintstagedrc.mts',
   '.lintstagedrc.js',
+  '.lintstagedrc.ts',
   '.lintstagedrc.cjs',
+  '.lintstagedrc.cts',
   'lint-staged.config.mjs',
+  '.lint-staged.config.mts',
   'lint-staged.config.js',
+  '.lint-staged.config.ts',
   'lint-staged.config.cjs',
+  '.lint-staged.config.cts',
 ]

package/lib/loadConfig.js

@@ -57,19 +57,21 @@ const NO_EXT = 'noExt'
  * assumption is in `cosmiconfig` as well.
  */
 const loaders = {
+  [NO_EXT]: yamlParse,
+  '.cjs': dynamicImport,
+  '.cts': dynamicImport,
   '.js': dynamicImport,
   '.json': jsonParse,
   '.mjs': dynamicImport,
-  '.cjs': dynamicImport,
+  '.mts': dynamicImport,
+  '.ts': dynamicImport,
   '.yaml': yamlParse,
   '.yml': yamlParse,
-  [NO_EXT]: yamlParse,
 }
 
 const readFile = async (filepath) => {
   const absolutePath = path.resolve(filepath)
-  const file = await fs.readFile(absolutePath)
-  return await file.toString()
+  return fs.readFile(absolutePath, 'utf-8')
 }
 
 const loadConfigByExt = async (filepath) => {

package/lib/types.d.ts

@@ -0,0 +1,101 @@
+type SyncFunctionTask = (stagedFileNames: string[]) => string | string[]
+
+type AsyncFunctionTask = (stagedFileNames: string[]) => Promise<string | string[]>
+
+type FunctionTask = SyncFunctionTask | AsyncFunctionTask
+
+export type Configuration =
+  | Record<string, string | FunctionTask | (string | FunctionTask)[]>
+  | FunctionTask
+
+export type Options = {
+  /**
+   * Allow empty commits when tasks revert all staged changes
+   * @default false
+   */
+  allowEmpty?: boolean
+  /**
+   * The number of tasks to run concurrently, or `false` to run tasks serially
+   * @default true
+   */
+  concurrent?: boolean | number
+  /**
+   * Manual task configuration; disables automatic config file discovery when used
+   */
+  config?: Configuration
+  /**
+   * Path to single configuration file; disables automatic config file discovery when used
+   */
+  configPath?: string
+  /**
+   * Working directory to run all tasks in, defaults to current working directory
+   */
+  cwd?: string
+  /**
+   * Whether or not to enable debug output
+   * @default false
+   */
+  debug?: boolean
+  /**
+   * Override the default `--staged` flag of `git diff` to get list of files.
+   * @warn changing this also implies `stash: false`.
+   * @example HEAD...origin/main
+   */
+  diff?: string
+  /**
+   * Override the default `--diff-filter=ACMR` flag of `git diff` to get list of files
+   * @default "ACMR"
+   */
+  diffFilter?: string
+  /**
+   * Maximum argument string length, by default automatically detected
+   */
+  maxArgLength?: number
+  /**
+   * Disable lint-staged’s own console output
+   * @default false
+   */
+  quiet?: boolean
+  /**
+   * Pass filepaths relative to `CWD` to tasks, instead of absolute
+   * @default false
+   */
+  relative?: boolean
+  /**
+   * Skip parsing of tasks for better shell support
+   * @default false
+   */
+  shell?: boolean
+  /**
+   * Enable the backup stash, and revert in case of errors.
+   * @warn Disabling this also implies `hidePartiallyStaged: false`.
+   * @default true
+   */
+  stash?: boolean
+  /**
+   * Whether to hide unstaged changes from partially staged files before running tasks
+   * @default true
+   */
+  hidePartiallyStaged?: boolean
+  /**
+   * Show task output even when tasks succeed; by default only failed output is shown
+   * @default false
+   */
+  verbose?: boolean
+}
+
+type LogFunction = (...params: any) => void
+
+type Logger = {
+  log: LogFunction
+  warn: LogFunction
+  error: LogFunction
+}
+
+/**
+ * @returns {boolean} `true` when linting was successful, `false` when some tasks failed with errors
+ * @throws {Error} when failed to some other errors
+ */
+type lintStaged = (options: Options, logger?: Logger) => Promise<boolean>
+
+export default lintStaged

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "15.3.0",
+  "version": "15.4.0",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/lint-staged/lint-staged",
@@ -23,6 +23,7 @@
     "./bin": "./bin/lint-staged.js",
     "./package.json": "./package.json"
   },
+  "types": "lib/types.d.ts",
   "files": [
     "bin",
     "lib"
@@ -31,6 +32,7 @@
     "lint": "eslint .",
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
     "test:watch": "npm run test -- --watch",
+    "typecheck": "tsc --noEmit --strict test/unit/types.ts",
     "version": "npx changeset version",
     "postversion": "npm i --package-lock-only && git commit -am \"chore(changeset): release\"",
     "tag": "npx changeset tag"
@@ -66,7 +68,8 @@
     "jest-snapshot-serializer-ansi": "2.1.0",
     "mock-stdin": "1.0.0",
     "prettier": "3.4.2",
-    "semver": "7.6.3"
+    "semver": "7.6.3",
+    "typescript": "5.7.3"
   },
   "keywords": [
     "lint",