@depup/lint-staged 16.3.2-depup.0

package/lib/validateBraces.js

@@ -0,0 +1,95 @@
+import { incorrectBraces } from './messages.js'
+
+/**
+ * A correctly-formed brace expansion must contain unquoted opening and closing braces,
+ * and at least one unquoted comma or a valid sequence expression.
+ * Any incorrectly formed brace expansion is left unchanged.
+ *
+ * @see https://www.gnu.org/software/bash/manual/html_node/Brace-Expansion.html
+ *
+ * Lint-staged uses `micromatch` for brace expansion, and its behavior is to treat
+ * invalid brace expansions as literal strings, which means they (typically) do not match
+ * anything.
+ *
+ * This RegExp tries to match most cases of invalid brace expansions, so that they can be
+ * detected, warned about, and re-formatted by removing the braces and thus hopefully
+ * matching the files as intended by the user. The only real fix is to remove the incorrect
+ * braces from user configuration, but this is left to the user (after seeing the warning).
+ *
+ * @example <caption>Globs with brace expansions</caption>
+ * - *.{js,tx}        // expanded as *.js, *.ts
+ * - *.{{j,t}s,css}   // expanded as *.js, *.ts, *.css
+ * - file_{1..10}.css  // expanded as file_1.css, file_2.css, …, file_10.css
+ *
+ * @example <caption>Globs with incorrect brace expansions</caption>
+ * - *.{js}       // should just be *.js
+ * - *.{js,{ts}}  // should just be *.{js,ts}
+ * - *.\{js\}     // escaped braces, so they're treated literally
+ * - *.${js}      // dollar-sign inhibits expansion, so treated literally
+ * - *.{js\,ts}   // the comma is escaped, so treated literally
+ */
+export const getIncorrectBracesRegexp = () =>
+  /(?<![\\$])({)(?:(?!(?<!\\),|\.\.|\{|\}).)*?(?<!\\)(})/g
+
+/**
+ * @param {string} pattern
+ * @returns {string}
+ */
+const stripIncorrectBraces = (pattern) => {
+  let output = `${pattern}`
+  const regexp = getIncorrectBracesRegexp()
+  let match = regexp.exec(output)
+
+  while (match) {
+    const fullMatch = match[0]
+    const withoutBraces = fullMatch.replace(/{/, '').replace(/}/, '')
+    output = output.replace(fullMatch, withoutBraces)
+    regexp.lastIndex = 0 // restart iteration
+    match = regexp.exec(output)
+  }
+
+  return output
+}
+
+/**
+ * This RegExp matches "duplicate" opening and closing braces, without any other braces
+ * in between, where the duplication is redundant and should be removed.
+ *
+ * @example *.{{js,ts}}  // should just be *.{js,ts}
+ */
+export const DOUBLE_BRACES_REGEXP = /{{[^}{]*}}/
+
+/**
+ * @param {string} pattern
+ * @returns {string}
+ */
+const stripDoubleBraces = (pattern) => {
+  let output = `${pattern}`
+  const match = DOUBLE_BRACES_REGEXP.exec(pattern)?.[0]
+
+  if (match) {
+    const withoutBraces = match.replace('{{', '{').replace('}}', '}')
+    output = output.replace(match, withoutBraces)
+  }
+
+  return output
+}
+
+/**
+ * Validate and remove incorrect brace expansions from glob pattern.
+ * For example `*.{js}` is incorrect because it doesn't contain a `,` or `..`,
+ * and will be reformatted as `*.js`.
+ *
+ * @param {string} pattern the glob pattern
+ * @param {*} logger
+ * @returns {string}
+ */
+export const validateBraces = (pattern, logger) => {
+  const fixedPattern = stripDoubleBraces(stripIncorrectBraces(pattern))
+
+  if (fixedPattern !== pattern) {
+    logger.warn(incorrectBraces(pattern, fixedPattern))
+  }
+
+  return fixedPattern
+}

package/lib/validateConfig.js

@@ -0,0 +1,108 @@
+/** @typedef {import('./index').Logger} Logger */
+
+import { inspect } from 'node:util'
+
+import { createDebug } from './debug.js'
+import { configurationError, failedToParseConfig } from './messages.js'
+import { ConfigEmptyError, ConfigFormatError } from './symbols.js'
+import { validateBraces } from './validateBraces.js'
+
+const debugLog = createDebug('lint-staged:validateConfig')
+
+export const validateConfigLogic = (config, configPath, logger) => {
+  debugLog('Validating config from `%s`...', configPath)
+
+  if (!config || (typeof config !== 'object' && typeof config !== 'function')) {
+    throw ConfigFormatError
+  }
+
+  /**
+   * Function configurations receive all staged files as their argument.
+   * They are not further validated here to make sure the function gets
+   * evaluated only once.
+   *
+   * @see getSpawnedTasks
+   */
+  if (typeof config === 'function') {
+    return { '*': config }
+  }
+
+  if (Object.entries(config).length === 0) {
+    throw ConfigEmptyError
+  }
+
+  const errors = []
+
+  /**
+   * Create a new validated config because the keys (patterns) might change.
+   * Since the Object.reduce method already loops through each entry in the config,
+   * it can be used for validating the values at the same time.
+   */
+  const validatedConfig = Object.entries(config).reduce((collection, [pattern, task]) => {
+    if (Array.isArray(task)) {
+      /** Array with invalid values */
+      if (task.some((item) => typeof item !== 'string' && typeof item !== 'function')) {
+        errors.push(
+          configurationError(pattern, 'Should be an array of strings or functions.', task)
+        )
+      }
+    } else if (typeof task === 'object') {
+      /** Invalid function task */
+      if (typeof task.title !== 'string' || typeof task.task !== 'function') {
+        errors.push(
+          configurationError(
+            pattern,
+            'Function task should contain `title` and `task` fields, where `title` should be a string and `task` should be a function.',
+            task
+          )
+        )
+      }
+    } else if (typeof task !== 'string' && typeof task !== 'function') {
+      /** Singular invalid value */
+      errors.push(
+        configurationError(
+          pattern,
+          'Should be a string, a function, an object or an array of strings and functions.',
+          task
+        )
+      )
+    }
+
+    /**
+     * A typical configuration error is using invalid brace expansion, like `*.{js}`.
+     * These are automatically fixed and warned about.
+     */
+    const fixedPattern = validateBraces(pattern, logger)
+
+    return Object.assign(collection, { [fixedPattern]: task })
+  }, {})
+
+  if (errors.length) {
+    const message = errors.join('\n\n')
+
+    logger.error(failedToParseConfig(configPath, message))
+
+    throw new Error(message)
+  }
+
+  debugLog('Validated config from `%s`:', configPath)
+  debugLog(inspect(config, { compact: false }))
+
+  return validatedConfig
+}
+
+/**
+ * Runs config validation. Throws error if the config is not valid.
+ * @param {Object} config
+ * @param {string} configPath
+ * @param {Logger} logger
+ * @returns {Object} config
+ */
+export const validateConfig = (config, configPath, logger) => {
+  try {
+    return validateConfigLogic(config, configPath, logger)
+  } catch (error) {
+    logger.error(failedToParseConfig(configPath, error))
+    throw error
+  }
+}

package/lib/validateOptions.js

@@ -0,0 +1,33 @@
+import { constants } from 'node:fs'
+import fs from 'node:fs/promises'
+import path from 'node:path'
+
+import { createDebug } from './debug.js'
+import { invalidOption } from './messages.js'
+import { InvalidOptionsError } from './symbols.js'
+
+const debugLog = createDebug('lint-staged:validateOptions')
+
+/**
+ * Validate lint-staged options, either from the Node.js API or the command line flags.
+ * @param {*} options
+ * @param {boolean|string} [options.cwd] - Current working directory
+ * @throws {InvalidOptionsError}
+ */
+export const validateOptions = async (options = {}, logger) => {
+  debugLog('Validating options...')
+
+  /** Ensure the passed cwd option exists; it might also be relative */
+  if (typeof options.cwd === 'string') {
+    try {
+      const resolved = path.resolve(options.cwd)
+      await fs.access(resolved, constants.F_OK)
+    } catch (error) {
+      debugLog('Failed to validate options: %o', options)
+      logger.error(invalidOption('cwd', options.cwd, error.message))
+      throw InvalidOptionsError
+    }
+  }
+
+  debugLog('Validated options: %o', options)
+}

package/lib/version.js

@@ -0,0 +1,6 @@
+import fs from 'node:fs/promises'
+
+export const getVersion = async () => {
+  const packageJson = JSON.parse(await fs.readFile(new URL('../package.json', import.meta.url)))
+  return packageJson.version
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@depup/lint-staged",
+  "version": "16.3.2-depup.0",
+  "description": "Lint files staged by git",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lint-staged/lint-staged.git"
+  },
+  "homepage": "https://github.com/lint-staged/lint-staged#readme",
+  "bugs": {
+    "url": "https://github.com/lint-staged/lint-staged/issues"
+  },
+  "author": "Andrey Okonetchnikov <andrey@okonet.ru>",
+  "maintainers": [
+    "Iiro Jäppinen <iiro@jappinen.fi> (https://iiro.fi)"
+  ],
+  "funding": {
+    "url": "https://opencollective.com/lint-staged"
+  },
+  "engines": {
+    "node": ">=20.17"
+  },
+  "type": "module",
+  "bin": {
+    "lint-staged": "bin/lint-staged.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./bin": "./bin/lint-staged.js",
+    "./package.json": "./package.json"
+  },
+  "types": "./lib/index.d.ts",
+  "files": [
+    "bin/",
+    "lib/",
+    "MIGRATION.md"
+  ],
+  "scripts": {
+    "lint": "eslint",
+    "test": "vitest",
+    "typecheck": "tsc",
+    "version": "npx changeset version",
+    "postversion": "npm i --package-lock-only && git commit -am \"chore(changeset): release\"",
+    "tag": "npx changeset tag"
+  },
+  "dependencies": {
+    "commander": "^14.0.3",
+    "listr2": "^10.2.1",
+    "micromatch": "^4.0.8",
+    "string-argv": "^0.3.2",
+    "tinyexec": "^1.0.2",
+    "yaml": "^2.8.2"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "0.5.2",
+    "@changesets/cli": "2.29.8",
+    "@commitlint/cli": "20.4.2",
+    "@commitlint/config-conventional": "20.4.2",
+    "@eslint/js": "10.0.1",
+    "@vitest/coverage-v8": "4.0.18",
+    "@vitest/eslint-plugin": "1.6.9",
+    "consolemock": "1.1.0",
+    "cross-env": "10.1.0",
+    "eslint": "10.0.2",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-n": "17.24.0",
+    "eslint-plugin-prettier": "5.5.5",
+    "eslint-plugin-simple-import-sort": "12.1.1",
+    "husky": "9.1.7",
+    "mock-stdin": "1.0.0",
+    "prettier": "3.8.1",
+    "semver": "7.7.4",
+    "typescript": "5.9.3",
+    "vitest": "4.0.18"
+  },
+  "keywords": [
+    "lint",
+    "git",
+    "staged",
+    "eslint",
+    "prettier",
+    "stylelint",
+    "code",
+    "quality",
+    "check",
+    "format",
+    "validate"
+  ]
+}