eslint-plugin-ocavue 0.2.0 → 0.3.0

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["rule","noImplicitArrowLinebreak","preferWhileTrue"],"sources":["../package.json","../src/rules/no-implicit-arrow-linebreak.ts","../src/rules/prefer-while-true.ts","../src/index.ts"],"sourcesContent":["","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'layout',\n    fixable: 'code',\n    docs: {\n      description:\n        'disallow a linebreak between `=>` and an implicit arrow function body, fixing it to a block body with `return`',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#no-implicit-arrow-linebreak',\n    },\n    messages: {\n      linebreak:\n        'Implicit arrow body must not start on a new line. Use a block body with `return` instead.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ArrowFunctionExpression(node) {\n        if (node.body.type === 'BlockStatement') {\n          return\n        }\n\n        const arrowToken = sourceCode.getTokenBefore(node.body, {\n          filter: (token) => token.type === 'Punctuator' && token.value === '=>',\n        })\n        if (!arrowToken) {\n          return\n        }\n        const firstBodyToken = sourceCode.getTokenAfter(arrowToken)\n        // The last token of the arrow function. When the body is wrapped in\n        // parentheses, this is the closing `)`, so the fix keeps the parens.\n        const lastToken = sourceCode.getLastToken(node)\n        if (!firstBodyToken || !lastToken) {\n          return\n        }\n        if (arrowToken.loc.end.line === firstBodyToken.loc.start.line) {\n          return\n        }\n\n        // The fix rewrites the region between `=>` and the body, so bail out\n        // of fixing (but still report) if that region contains comments.\n        const canFix = !sourceCode.commentsExistBetween(arrowToken, firstBodyToken)\n\n        context.report({\n          node: node.body,\n          messageId: 'linebreak',\n          fix: canFix\n            ? (fixer) => {\n                const bodyText = sourceCode.text.slice(firstBodyToken.range[0], lastToken.range[1])\n                return fixer.replaceTextRange(\n                  [arrowToken.range[1], lastToken.range[1]],\n                  ` { return ${bodyText} }`,\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    fixable: 'code',\n    docs: {\n      description: 'enforce `while (true)` instead of `for (;;)` for infinite loops',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-while-true',\n    },\n    messages: {\n      preferWhileTrue: 'Use `while (true)` instead of `for (;;)`.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ForStatement(node) {\n        if (node.init || node.test || node.update) {\n          return\n        }\n\n        const forToken = sourceCode.getFirstToken(node)\n        const closingParen = sourceCode.getTokenBefore(node.body)\n        if (!forToken || !closingParen) {\n          return\n        }\n\n        // Bail out of fixing (but still report) if the loop head contains\n        // comments, so the fix never drops a comment.\n        const canFix = !sourceCode.commentsExistBetween(forToken, closingParen)\n\n        context.report({\n          node,\n          loc: { start: forToken.loc.start, end: closingParen.loc.end },\n          messageId: 'preferWhileTrue',\n          fix: canFix\n            ? (fixer) => {\n                return fixer.replaceTextRange(\n                  [forToken.range[0], closingParen.range[1]],\n                  'while (true)',\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { ESLint } from 'eslint'\n\nimport { version } from '../package.json'\n\nimport noImplicitArrowLinebreak from './rules/no-implicit-arrow-linebreak'\nimport preferWhileTrue from './rules/prefer-while-true'\n\nconst plugin = {\n  meta: {\n    name: 'eslint-plugin-ocavue',\n    version,\n  },\n  rules: {\n    'no-implicit-arrow-linebreak': noImplicitArrowLinebreak,\n    'prefer-while-true': preferWhileTrue,\n  },\n} satisfies ESLint.Plugin\n\nexport default plugin\n"],"mappings":";;AGOA,MAAM,SAAS;CACb,MAAM;EACJ,MAAM;EACN;CACF;CACA,OAAO;EACL,+BAA+BC;GFVjC,MAAM;IACJ,MAAM;IACN,SAAS;IACT,MAAM;KACJ,aACE;KACF,KAAK;IACP;IACA,UAAU,EACR,WACE,4FACJ;IACA,QAAQ,CAAC;GACX;GACA,OAAO,SAAS;IACd,MAAM,aAAa,QAAQ;IAC3B,OAAO,EACL,wBAAwB,MAAM;KAC5B,IAAI,KAAK,KAAK,SAAS,kBACrB;KAGF,MAAM,aAAa,WAAW,eAAe,KAAK,MAAM,EACtD,SAAS,UAAU,MAAM,SAAS,gBAAgB,MAAM,UAAU,KACpE,CAAC;KACD,IAAI,CAAC,YACH;KAEF,MAAM,iBAAiB,WAAW,cAAc,UAAU;KAG1D,MAAM,YAAY,WAAW,aAAa,IAAI;KAC9C,IAAI,CAAC,kBAAkB,CAAC,WACtB;KAEF,IAAI,WAAW,IAAI,IAAI,SAAS,eAAe,IAAI,MAAM,MACvD;KAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,YAAY,cAAc;KAE1E,QAAQ,OAAO;MACb,MAAM,KAAK;MACX,WAAW;MACX,KAAK,UACA,UAAU;OACT,MAAM,WAAW,WAAW,KAAK,MAAM,eAAe,MAAM,IAAI,UAAU,MAAM,EAAE;OAClF,OAAO,MAAM,iBACX,CAAC,WAAW,MAAM,IAAI,UAAU,MAAM,EAAE,GACxC,aAAa,SAAS,GACxB;MACF,IACA,KAAA;KACN,CAAC;IACH,EACF;GACF;EEhDiCA;EAC/B,qBAAqBC;GDXvB,MAAM;IACJ,MAAM;IACN,SAAS;IACT,MAAM;KACJ,aAAa;KACb,KAAK;IACP;IACA,UAAU,EACR,iBAAiB,4CACnB;IACA,QAAQ,CAAC;GACX;GACA,OAAO,SAAS;IACd,MAAM,aAAa,QAAQ;IAC3B,OAAO,EACL,aAAa,MAAM;KACjB,IAAI,KAAK,QAAQ,KAAK,QAAQ,KAAK,QACjC;KAGF,MAAM,WAAW,WAAW,cAAc,IAAI;KAC9C,MAAM,eAAe,WAAW,eAAe,KAAK,IAAI;KACxD,IAAI,CAAC,YAAY,CAAC,cAChB;KAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,UAAU,YAAY;KAEtE,QAAQ,OAAO;MACb;MACA,KAAK;OAAE,OAAO,SAAS,IAAI;OAAO,KAAK,aAAa,IAAI;MAAI;MAC5D,WAAW;MACX,KAAK,UACA,UAAU;OACT,OAAO,MAAM,iBACX,CAAC,SAAS,MAAM,IAAI,aAAa,MAAM,EAAE,GACzC,cACF;MACF,IACA,KAAA;KACN,CAAC;IACH,EACF;GACF;EClCuBA;CACvB;AACF"}
+{"version":3,"file":"index.js","names":["rule","rule","rule","rule","noImplicitArrowLinebreak","preferConstantFunction","preferNoop","preferSleep","preferWhileTrue"],"sources":["../package.json","../src/rules/no-implicit-arrow-linebreak.ts","../src/utils/constant-function.ts","../src/utils/has-dependency.ts","../src/utils/package-import.ts","../src/rules/prefer-constant-function.ts","../src/rules/prefer-noop.ts","../src/rules/prefer-sleep.ts","../src/rules/prefer-while-true.ts","../src/index.ts"],"sourcesContent":["","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'layout',\n    fixable: 'code',\n    docs: {\n      description:\n        'disallow a linebreak between `=>` and an implicit arrow function body, fixing it to a block body with `return`',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#no-implicit-arrow-linebreak',\n    },\n    messages: {\n      linebreak:\n        'Implicit arrow body must not start on a new line. Use a block body with `return` instead.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ArrowFunctionExpression(node) {\n        if (node.body.type === 'BlockStatement') {\n          return\n        }\n\n        const arrowToken = sourceCode.getTokenBefore(node.body, {\n          filter: (token) => token.type === 'Punctuator' && token.value === '=>',\n        })\n        if (!arrowToken) {\n          return\n        }\n        const firstBodyToken = sourceCode.getTokenAfter(arrowToken)\n        // The last token of the arrow function. When the body is wrapped in\n        // parentheses, this is the closing `)`, so the fix keeps the parens.\n        const lastToken = sourceCode.getLastToken(node)\n        if (!firstBodyToken || !lastToken) {\n          return\n        }\n        if (arrowToken.loc.end.line === firstBodyToken.loc.start.line) {\n          return\n        }\n\n        // The fix rewrites the region between `=>` and the body, so bail out\n        // of fixing (but still report) if that region contains comments.\n        const canFix = !sourceCode.commentsExistBetween(arrowToken, firstBodyToken)\n\n        context.report({\n          node: node.body,\n          messageId: 'linebreak',\n          fix: canFix\n            ? (fixer) => {\n                const bodyText = sourceCode.text.slice(firstBodyToken.range[0], lastToken.range[1])\n                return fixer.replaceTextRange(\n                  [arrowToken.range[1], lastToken.range[1]],\n                  ` { return ${bodyText} }`,\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { Rule } from 'eslint'\nimport type { ArrowFunctionExpression, Expression, FunctionExpression, Node } from 'estree'\n\nexport type FunctionNode = (ArrowFunctionExpression | FunctionExpression) & Rule.NodeParentExtension\n\n/**\n * The value that a constant function returns.\n */\nexport type ConstantValue = 'undefined' | 'true' | 'false' | 'null'\n\nfunction getConstantValue(node: Expression): ConstantValue | undefined {\n  if (node.type === 'Literal') {\n    switch (node.raw) {\n      case 'true':\n      case 'false':\n      case 'null':\n        return node.raw\n    }\n    return undefined\n  }\n  if (node.type === 'Identifier' && node.name === 'undefined') {\n    return 'undefined'\n  }\n  if (\n    node.type === 'UnaryExpression' &&\n    node.operator === 'void' &&\n    node.argument.type === 'Literal'\n  ) {\n    return 'undefined'\n  }\n  return undefined\n}\n\nfunction getReturnedValue(node: FunctionNode): ConstantValue | undefined {\n  const body = node.body\n  if (body.type !== 'BlockStatement') {\n    return getConstantValue(body)\n  }\n  if (body.body.length === 0) {\n    return 'undefined'\n  }\n  if (body.body.length === 1) {\n    const statement = body.body[0]\n    if (statement.type === 'ReturnStatement') {\n      return statement.argument ? getConstantValue(statement.argument) : 'undefined'\n    }\n  }\n  return undefined\n}\n\n/**\n * Returns true when the function can be swapped with a function reference\n * without changing runtime behavior.\n */\nfunction isReplaceable(node: FunctionNode): boolean {\n  if (node.async || node.generator) {\n    return false\n  }\n  if ((node as { typeParameters?: unknown }).typeParameters) {\n    return false\n  }\n\n  // Every parameter must be a plain identifier. Default values may have side\n  // effects, and destructuring may throw.\n  const hasPlainParams = node.params.every((param) => {\n    return (\n      param.type === 'Identifier' ||\n      (param.type === 'RestElement' && param.argument.type === 'Identifier')\n    )\n  })\n  if (!hasPlainParams) {\n    return false\n  }\n\n  if (node.type === 'FunctionExpression') {\n    if (node.id) {\n      return false\n    }\n    const parent: Node = node.parent\n    if (parent.type === 'Property' && (parent.method || parent.kind !== 'init')) {\n      return false\n    }\n    if (parent.type === 'MethodDefinition') {\n      return false\n    }\n    if (parent.type === 'NewExpression' && parent.callee === node) {\n      return false\n    }\n  }\n\n  return true\n}\n\n/**\n * Returns the value that an inline function always returns, such as\n * `'true'` for `() => true` or `'undefined'` for `() => {}`. Returns\n * `undefined` when the function does more than that, or when replacing it\n * could change runtime behavior.\n */\nexport function getConstantFunctionValue(node: FunctionNode): ConstantValue | undefined {\n  return isReplaceable(node) ? getReturnedValue(node) : undefined\n}\n","import fs from 'node:fs'\nimport path from 'node:path'\n\ninterface PackageJson {\n  name?: string\n  dependencies?: Record<string, string>\n  devDependencies?: Record<string, string>\n  peerDependencies?: Record<string, string>\n}\n\n// Maps a directory to its nearest `package.json`, or `null` when there is none.\nconst cache = new Map<string, PackageJson | null>()\n\nfunction readPackageJson(dir: string): PackageJson | undefined {\n  let text: string\n  try {\n    text = fs.readFileSync(path.join(dir, 'package.json'), 'utf8')\n  } catch {\n    return undefined\n  }\n  try {\n    const json: unknown = JSON.parse(text)\n    return json && typeof json === 'object' ? json : {}\n  } catch {\n    return {}\n  }\n}\n\nfunction findNearestPackageJson(startDir: string): PackageJson | null {\n  const visited: string[] = []\n  let dir = startDir\n  let result: PackageJson | null = null\n\n  while (true) {\n    const cached = cache.get(dir)\n    if (cached !== undefined) {\n      result = cached\n      break\n    }\n    visited.push(dir)\n\n    const pkg = readPackageJson(dir)\n    if (pkg) {\n      result = pkg\n      break\n    }\n\n    const parent = path.dirname(dir)\n    if (parent === dir) {\n      break\n    }\n    dir = parent\n  }\n\n  for (const visitedDir of visited) {\n    cache.set(visitedDir, result)\n  }\n  return result\n}\n\n/**\n * Returns true when the nearest `package.json` of `filename` lists\n * `packageName` in `dependencies`, `devDependencies` or `peerDependencies`.\n *\n * A package never depends on itself, so this returns false inside the\n * package named `packageName`.\n */\nexport function hasDependency(filename: string, packageName: string): boolean {\n  if (!path.isAbsolute(filename)) {\n    return false\n  }\n\n  const pkg = findNearestPackageJson(path.dirname(filename))\n  if (!pkg || pkg.name === packageName) {\n    return false\n  }\n\n  return [pkg.dependencies, pkg.devDependencies, pkg.peerDependencies].some(\n    (deps) => deps != null && typeof deps === 'object' && Object.hasOwn(deps, packageName),\n  )\n}\n","import type { Rule, Scope } from 'eslint'\nimport type { ImportDeclaration, ImportSpecifier, Node, Program } from 'estree'\n\nimport { hasDependency } from './has-dependency'\n\nexport const UTILS_PACKAGE = '@ocavue/utils'\n\ninterface PackageRuleOptions {\n  checkDependency?: boolean\n}\n\nexport const packageRuleSchema: Rule.RuleMetaData['schema'] = [\n  {\n    type: 'object',\n    properties: {\n      checkDependency: { type: 'boolean' },\n    },\n    additionalProperties: false,\n  },\n]\n\nfunction getImportKind(node: ImportDeclaration | ImportSpecifier): string | undefined {\n  return (node as { importKind?: string }).importKind\n}\n\nfunction getImportedName(specifier: ImportSpecifier): string {\n  const imported = specifier.imported\n  return imported.type === 'Identifier' ? imported.name : String(imported.value)\n}\n\n/**\n * Returns the value `import` declarations of `packageName` in the program.\n */\nfunction getPackageImports(program: Program, packageName: string): ImportDeclaration[] {\n  return program.body.filter((statement): statement is ImportDeclaration => {\n    return (\n      statement.type === 'ImportDeclaration' &&\n      statement.source.value === packageName &&\n      getImportKind(statement) !== 'type'\n    )\n  })\n}\n\n/**\n * Returns true when the linted file can import from `packageName`: the\n * nearest `package.json` depends on it, or the file already imports it. The\n * `checkDependency: false` option skips the check.\n */\nexport function isPackageAvailable(context: Rule.RuleContext, packageName: string): boolean {\n  const options = (context.options[0] ?? {}) as PackageRuleOptions\n  if (options.checkDependency === false) {\n    return true\n  }\n  return (\n    hasDependency(context.physicalFilename, packageName) ||\n    getPackageImports(context.sourceCode.ast, packageName).length > 0\n  )\n}\n\nexport function findVariable(scope: Scope.Scope | null, name: string): Scope.Variable | undefined {\n  for (let current = scope; current; current = current.upper) {\n    const variable = current.set.get(name)\n    if (variable) {\n      return variable\n    }\n  }\n  return undefined\n}\n\ninterface ImportFixOptions {\n  context: Rule.RuleContext\n  /** The node to replace. */\n  node: Node\n  /** The named export to import from `packageName`. */\n  name: string\n  packageName: string\n  /** Returns the replacement text, given the local name of the import. */\n  replace: (local: string) => string\n}\n\n/**\n * Creates a fix that replaces `node` and makes sure `name` is imported from\n * `packageName`. Returns `undefined` when the fix is not safe: the file is\n * not an ES module, the node holds comments, or another binding already uses\n * the name.\n */\nexport function createImportFix({\n  context,\n  node,\n  name,\n  packageName,\n  replace,\n}: ImportFixOptions): Rule.ReportFixer | undefined {\n  const sourceCode = context.sourceCode\n  const program = sourceCode.ast as Program\n\n  if (context.languageOptions.sourceType !== 'module') {\n    return undefined\n  }\n  if (sourceCode.getCommentsInside(node).length > 0) {\n    return undefined\n  }\n\n  const scope = sourceCode.getScope(node)\n  const packageImports = getPackageImports(program, packageName)\n\n  // Reuse an existing import, including an aliased one, when it is visible\n  // from the node.\n  for (const declaration of packageImports) {\n    for (const specifier of declaration.specifiers) {\n      if (\n        specifier.type !== 'ImportSpecifier' ||\n        getImportKind(specifier) === 'type' ||\n        getImportedName(specifier) !== name\n      ) {\n        continue\n      }\n      const local = specifier.local.name\n      const variable = findVariable(scope, local)\n      if (variable?.defs[0]?.node === specifier) {\n        return (fixer) => fixer.replaceText(node, replace(local))\n      }\n    }\n  }\n\n  // Another binding with the same name is in scope.\n  if (findVariable(scope, name)) {\n    return undefined\n  }\n  // An undeclared global with the same name is used somewhere in the file.\n  const globalScope = sourceCode.scopeManager.globalScope\n  if (globalScope?.through.some((reference) => reference.identifier.name === name)) {\n    return undefined\n  }\n\n  const replacement = replace(name)\n\n  const namedImport = packageImports.find((declaration) => {\n    return declaration.specifiers.some((specifier) => specifier.type === 'ImportSpecifier')\n  })\n  if (namedImport) {\n    const lastSpecifier = namedImport.specifiers.at(-1)!\n    return (fixer) => [\n      fixer.replaceText(node, replacement),\n      fixer.insertTextAfter(lastSpecifier, `, ${name}`),\n    ]\n  }\n\n  const importText = `import { ${name} } from '${packageName}'`\n  const lastImport = program.body.findLast((statement) => statement.type === 'ImportDeclaration')\n  if (lastImport) {\n    const semicolon = sourceCode.getText(lastImport).endsWith(';') ? ';' : ''\n    return (fixer) => [\n      fixer.replaceText(node, replacement),\n      fixer.insertTextAfter(lastImport, `\\n${importText}${semicolon}`),\n    ]\n  }\n\n  // Insert the import after directives such as 'use client'.\n  const firstStatement = program.body.find((statement) => {\n    // typescript-eslint sets `directive: undefined` on every expression statement.\n    return !(\n      statement.type === 'ExpressionStatement' &&\n      typeof (statement as { directive?: unknown }).directive === 'string'\n    )\n  })\n  if (!firstStatement) {\n    return undefined\n  }\n  return (fixer) => [\n    fixer.replaceText(node, replacement),\n    fixer.insertTextBefore(firstStatement, `${importText}\\n`),\n  ]\n}\n","import type { Rule } from 'eslint'\n\nimport {\n  getConstantFunctionValue,\n  type ConstantValue,\n  type FunctionNode,\n} from '../utils/constant-function'\nimport {\n  createImportFix,\n  isPackageAvailable,\n  packageRuleSchema,\n  UTILS_PACKAGE,\n} from '../utils/package-import'\n\nconst FUNCTION_NAMES: Partial<Record<ConstantValue, string>> = {\n  true: 'returnTrue',\n  false: 'returnFalse',\n  null: 'returnNull',\n}\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    hasSuggestions: true,\n    docs: {\n      description:\n        'enforce `returnTrue`, `returnFalse` and `returnNull` from `@ocavue/utils` instead of inline functions',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-constant-function',\n    },\n    messages: {\n      preferConstantFunction: 'Use `{{name}}` from `@ocavue/utils` instead of an inline function.',\n      replaceWithConstantFunction: 'Replace with `{{name}}` from `@ocavue/utils`.',\n    },\n    schema: packageRuleSchema,\n  },\n  create(context) {\n    if (!isPackageAvailable(context, UTILS_PACKAGE)) {\n      return {}\n    }\n\n    function check(node: FunctionNode): void {\n      const value = getConstantFunctionValue(node)\n      const name = value && FUNCTION_NAMES[value]\n      if (!name) {\n        return\n      }\n\n      // `returnFalse` returns the literal type `false`, while `() => false`\n      // returns `boolean`. The swap can narrow inferred types, for example\n      // `useState(() => false)`, so it is a suggestion and not an autofix.\n      const fix = createImportFix({\n        context,\n        node,\n        name,\n        packageName: UTILS_PACKAGE,\n        replace: (local) => local,\n      })\n      context.report({\n        node,\n        messageId: 'preferConstantFunction',\n        data: { name },\n        suggest: fix ? [{ messageId: 'replaceWithConstantFunction', data: { name }, fix }] : [],\n      })\n    }\n\n    return {\n      ArrowFunctionExpression: check,\n      FunctionExpression: check,\n    }\n  },\n}\n\nexport default rule\n","import type { Rule } from 'eslint'\n\nimport { getConstantFunctionValue, type FunctionNode } from '../utils/constant-function'\nimport {\n  createImportFix,\n  isPackageAvailable,\n  packageRuleSchema,\n  UTILS_PACKAGE,\n} from '../utils/package-import'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    fixable: 'code',\n    docs: {\n      description: 'enforce `noop` from `@ocavue/utils` instead of inline empty functions',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-noop',\n    },\n    messages: {\n      preferNoop: 'Use `noop` from `@ocavue/utils` instead of an inline empty function.',\n    },\n    schema: packageRuleSchema,\n  },\n  create(context) {\n    if (!isPackageAvailable(context, UTILS_PACKAGE)) {\n      return {}\n    }\n\n    function check(node: FunctionNode): void {\n      if (getConstantFunctionValue(node) !== 'undefined') {\n        return\n      }\n      context.report({\n        node,\n        messageId: 'preferNoop',\n        fix: createImportFix({\n          context,\n          node,\n          name: 'noop',\n          packageName: UTILS_PACKAGE,\n          replace: (local) => local,\n        }),\n      })\n    }\n\n    return {\n      ArrowFunctionExpression: check,\n      FunctionExpression: check,\n    }\n  },\n}\n\nexport default rule\n","import type { Rule, Scope } from 'eslint'\nimport type {\n  ArrowFunctionExpression,\n  CallExpression,\n  Expression,\n  FunctionExpression,\n  Node,\n  SpreadElement,\n} from 'estree'\n\nimport {\n  createImportFix,\n  findVariable,\n  isPackageAvailable,\n  packageRuleSchema,\n  UTILS_PACKAGE,\n} from '../utils/package-import'\n\ntype FunctionNode = ArrowFunctionExpression | FunctionExpression\n\nfunction isFunction(node: Node): node is FunctionNode {\n  return node.type === 'ArrowFunctionExpression' || node.type === 'FunctionExpression'\n}\n\n/**\n * Returns true when `name` refers to a global variable, not a local binding.\n */\nfunction isGlobal(scope: Scope.Scope, name: string): boolean {\n  const variable = findVariable(scope, name)\n  return !variable || variable.defs.length === 0\n}\n\n/**\n * Returns the only expression that a function body evaluates, for bodies\n * such as `x`, `{ x }` and `{ return x }`.\n */\nfunction getOnlyExpression(node: FunctionNode): Expression | undefined {\n  const body = node.body\n  if (body.type !== 'BlockStatement') {\n    return body\n  }\n  if (body.body.length !== 1) {\n    return undefined\n  }\n  const statement = body.body[0]\n  if (statement.type === 'ExpressionStatement') {\n    return statement.expression\n  }\n  if (statement.type === 'ReturnStatement' && statement.argument) {\n    return statement.argument\n  }\n  return undefined\n}\n\nfunction isIdentifier(node: Node | SpreadElement, name: string): boolean {\n  return node.type === 'Identifier' && node.name === name\n}\n\n/**\n * Returns true for `setTimeout`, `globalThis.setTimeout` and\n * `window.setTimeout`.\n */\nfunction isSetTimeout(node: Expression, scope: Scope.Scope): boolean {\n  if (node.type === 'Identifier') {\n    return node.name === 'setTimeout' && isGlobal(scope, 'setTimeout')\n  }\n  return (\n    node.type === 'MemberExpression' &&\n    !node.computed &&\n    isIdentifier(node.property, 'setTimeout') &&\n    node.object.type === 'Identifier' &&\n    (node.object.name === 'globalThis' || node.object.name === 'window') &&\n    isGlobal(scope, node.object.name)\n  )\n}\n\n/**\n * Returns true for `resolve` and `() => resolve()`.\n */\nfunction isResolveCallback(node: Expression | SpreadElement, resolve: string): boolean {\n  if (isIdentifier(node, resolve)) {\n    return true\n  }\n  if (!isFunction(node) || node.async || node.generator || node.params.length > 0) {\n    return false\n  }\n  const expression = getOnlyExpression(node)\n  return (\n    expression?.type === 'CallExpression' &&\n    isIdentifier(expression.callee, resolve) &&\n    expression.arguments.length === 0\n  )\n}\n\n/**\n * Returns true for no type argument, `<void>` and `<undefined>`.\n */\nfunction hasVoidTypeArgument(node: Node): boolean {\n  const typeArguments = (node as { typeArguments?: { params: { type: string }[] } }).typeArguments\n  if (!typeArguments) {\n    return true\n  }\n  return (\n    typeArguments.params.length === 1 &&\n    (typeArguments.params[0].type === 'TSVoidKeyword' ||\n      typeArguments.params[0].type === 'TSUndefinedKeyword')\n  )\n}\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    fixable: 'code',\n    docs: {\n      description:\n        'enforce `sleep` from `@ocavue/utils` instead of `new Promise` with `setTimeout`',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-sleep',\n    },\n    messages: {\n      preferSleep: 'Use `sleep` from `@ocavue/utils` instead of `new Promise` with `setTimeout`.',\n    },\n    schema: packageRuleSchema,\n  },\n  create(context) {\n    if (!isPackageAvailable(context, UTILS_PACKAGE)) {\n      return {}\n    }\n\n    const sourceCode = context.sourceCode\n\n    /**\n     * Returns the delay expression of `new Promise((resolve) =>\n     * setTimeout(resolve, delay))`, or `undefined` when the node does not\n     * match.\n     */\n    function getDelay(node: Node): Expression | undefined {\n      if (\n        node.type !== 'NewExpression' ||\n        !isIdentifier(node.callee, 'Promise') ||\n        node.arguments.length !== 1 ||\n        !hasVoidTypeArgument(node)\n      ) {\n        return undefined\n      }\n      if (!isGlobal(sourceCode.getScope(node), 'Promise')) {\n        return undefined\n      }\n\n      const executor = node.arguments[0]\n      if (!isFunction(executor) || executor.async || executor.generator) {\n        return undefined\n      }\n      if (!executor.params.every((param) => param.type === 'Identifier')) {\n        return undefined\n      }\n      const resolveParam = executor.params[0]\n      if (resolveParam?.type !== 'Identifier') {\n        return undefined\n      }\n\n      const call = getOnlyExpression(executor)\n      if (call?.type !== 'CallExpression' || call.optional) {\n        return undefined\n      }\n      const executorScope = sourceCode.getScope(executor)\n      if (!isSetTimeout(call.callee as Expression, executorScope)) {\n        return undefined\n      }\n\n      const [callback, delay] = (call as CallExpression).arguments\n      if (call.arguments.length !== 2 || !delay || delay.type === 'SpreadElement') {\n        return undefined\n      }\n      if (!isResolveCallback(callback, resolveParam.name)) {\n        return undefined\n      }\n\n      // The delay moves out of the executor, so it must not use the\n      // executor's parameters, `this` or `arguments`.\n      const usesExecutorParams = executorScope.variables.some((variable) => {\n        return variable.references.some((reference) => {\n          const range = reference.identifier.range!\n          return range[0] >= delay.range![0] && range[1] <= delay.range![1]\n        })\n      })\n      if (usesExecutorParams) {\n        return undefined\n      }\n      if (\n        executor.type === 'FunctionExpression' &&\n        sourceCode.getTokens(delay).some((token) => {\n          return token.value === 'this' || token.value === 'arguments'\n        })\n      ) {\n        return undefined\n      }\n\n      return delay\n    }\n\n    return {\n      NewExpression(node) {\n        const delay = getDelay(node)\n        if (!delay) {\n          return\n        }\n        const delayText = sourceCode.getText(delay)\n        context.report({\n          node,\n          messageId: 'preferSleep',\n          fix: createImportFix({\n            context,\n            node,\n            name: 'sleep',\n            packageName: UTILS_PACKAGE,\n            replace: (local) => {\n              return delay.type === 'SequenceExpression'\n                ? `${local}((${delayText}))`\n                : `${local}(${delayText})`\n            },\n          }),\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    fixable: 'code',\n    docs: {\n      description: 'enforce `while (true)` instead of `for (;;)` for infinite loops',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-while-true',\n    },\n    messages: {\n      preferWhileTrue: 'Use `while (true)` instead of `for (;;)`.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ForStatement(node) {\n        if (node.init || node.test || node.update) {\n          return\n        }\n\n        const forToken = sourceCode.getFirstToken(node)\n        const closingParen = sourceCode.getTokenBefore(node.body)\n        if (!forToken || !closingParen) {\n          return\n        }\n\n        // Bail out of fixing (but still report) if the loop head contains\n        // comments, so the fix never drops a comment.\n        const canFix = !sourceCode.commentsExistBetween(forToken, closingParen)\n\n        context.report({\n          node,\n          loc: { start: forToken.loc.start, end: closingParen.loc.end },\n          messageId: 'preferWhileTrue',\n          fix: canFix\n            ? (fixer) => {\n                return fixer.replaceTextRange(\n                  [forToken.range[0], closingParen.range[1]],\n                  'while (true)',\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { ESLint } from 'eslint'\n\nimport { version } from '../package.json'\n\nimport noImplicitArrowLinebreak from './rules/no-implicit-arrow-linebreak'\nimport preferConstantFunction from './rules/prefer-constant-function'\nimport preferNoop from './rules/prefer-noop'\nimport preferSleep from './rules/prefer-sleep'\nimport preferWhileTrue from './rules/prefer-while-true'\n\nconst plugin = {\n  meta: {\n    name: 'eslint-plugin-ocavue',\n    version,\n  },\n  rules: {\n    'no-implicit-arrow-linebreak': noImplicitArrowLinebreak,\n    'prefer-constant-function': preferConstantFunction,\n    'prefer-noop': preferNoop,\n    'prefer-sleep': preferSleep,\n    'prefer-while-true': preferWhileTrue,\n  },\n} satisfies ESLint.Plugin\n\nexport default plugin\n"],"mappings":";;;;;;ACEA,MAAMA,SAAwB;CAC5B,MAAM;EACJ,MAAM;EACN,SAAS;EACT,MAAM;GACJ,aACE;GACF,KAAK;EACP;EACA,UAAU,EACR,WACE,4FACJ;EACA,QAAQ,CAAC;CACX;CACA,OAAO,SAAS;EACd,MAAM,aAAa,QAAQ;EAC3B,OAAO,EACL,wBAAwB,MAAM;GAC5B,IAAI,KAAK,KAAK,SAAS,kBACrB;GAGF,MAAM,aAAa,WAAW,eAAe,KAAK,MAAM,EACtD,SAAS,UAAU,MAAM,SAAS,gBAAgB,MAAM,UAAU,KACpE,CAAC;GACD,IAAI,CAAC,YACH;GAEF,MAAM,iBAAiB,WAAW,cAAc,UAAU;GAG1D,MAAM,YAAY,WAAW,aAAa,IAAI;GAC9C,IAAI,CAAC,kBAAkB,CAAC,WACtB;GAEF,IAAI,WAAW,IAAI,IAAI,SAAS,eAAe,IAAI,MAAM,MACvD;GAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,YAAY,cAAc;GAE1E,QAAQ,OAAO;IACb,MAAM,KAAK;IACX,WAAW;IACX,KAAK,UACA,UAAU;KACT,MAAM,WAAW,WAAW,KAAK,MAAM,eAAe,MAAM,IAAI,UAAU,MAAM,EAAE;KAClF,OAAO,MAAM,iBACX,CAAC,WAAW,MAAM,IAAI,UAAU,MAAM,EAAE,GACxC,aAAa,SAAS,GACxB;IACF,IACA,KAAA;GACN,CAAC;EACH,EACF;CACF;AACF;;;ACpDA,SAAS,iBAAiB,MAA6C;CACrE,IAAI,KAAK,SAAS,WAAW;EAC3B,QAAQ,KAAK,KAAb;GACE,KAAK;GACL,KAAK;GACL,KAAK,QACH,OAAO,KAAK;EAChB;EACA;CACF;CACA,IAAI,KAAK,SAAS,gBAAgB,KAAK,SAAS,aAC9C,OAAO;CAET,IACE,KAAK,SAAS,qBACd,KAAK,aAAa,UAClB,KAAK,SAAS,SAAS,WAEvB,OAAO;AAGX;AAEA,SAAS,iBAAiB,MAA+C;CACvE,MAAM,OAAO,KAAK;CAClB,IAAI,KAAK,SAAS,kBAChB,OAAO,iBAAiB,IAAI;CAE9B,IAAI,KAAK,KAAK,WAAW,GACvB,OAAO;CAET,IAAI,KAAK,KAAK,WAAW,GAAG;EAC1B,MAAM,YAAY,KAAK,KAAK;EAC5B,IAAI,UAAU,SAAS,mBACrB,OAAO,UAAU,WAAW,iBAAiB,UAAU,QAAQ,IAAI;CAEvE;AAEF;;;;;AAMA,SAAS,cAAc,MAA6B;CAClD,IAAI,KAAK,SAAS,KAAK,WACrB,OAAO;CAET,IAAK,KAAsC,gBACzC,OAAO;CAWT,IAAI,CANmB,KAAK,OAAO,OAAO,UAAU;EAClD,OACE,MAAM,SAAS,gBACd,MAAM,SAAS,iBAAiB,MAAM,SAAS,SAAS;CAE7D,CACkB,GAChB,OAAO;CAGT,IAAI,KAAK,SAAS,sBAAsB;EACtC,IAAI,KAAK,IACP,OAAO;EAET,MAAM,SAAe,KAAK;EAC1B,IAAI,OAAO,SAAS,eAAe,OAAO,UAAU,OAAO,SAAS,SAClE,OAAO;EAET,IAAI,OAAO,SAAS,oBAClB,OAAO;EAET,IAAI,OAAO,SAAS,mBAAmB,OAAO,WAAW,MACvD,OAAO;CAEX;CAEA,OAAO;AACT;;;;;;;AAQA,SAAgB,yBAAyB,MAA+C;CACtF,OAAO,cAAc,IAAI,IAAI,iBAAiB,IAAI,IAAI,KAAA;AACxD;;;AC1FA,MAAM,wBAAQ,IAAI,IAAgC;AAElD,SAAS,gBAAgB,KAAsC;CAC7D,IAAI;CACJ,IAAI;EACF,OAAO,GAAG,aAAa,KAAK,KAAK,KAAK,cAAc,GAAG,MAAM;CAC/D,QAAQ;EACN;CACF;CACA,IAAI;EACF,MAAM,OAAgB,KAAK,MAAM,IAAI;EACrC,OAAO,QAAQ,OAAO,SAAS,WAAW,OAAO,CAAC;CACpD,QAAQ;EACN,OAAO,CAAC;CACV;AACF;AAEA,SAAS,uBAAuB,UAAsC;CACpE,MAAM,UAAoB,CAAC;CAC3B,IAAI,MAAM;CACV,IAAI,SAA6B;CAEjC,OAAO,MAAM;EACX,MAAM,SAAS,MAAM,IAAI,GAAG;EAC5B,IAAI,WAAW,KAAA,GAAW;GACxB,SAAS;GACT;EACF;EACA,QAAQ,KAAK,GAAG;EAEhB,MAAM,MAAM,gBAAgB,GAAG;EAC/B,IAAI,KAAK;GACP,SAAS;GACT;EACF;EAEA,MAAM,SAAS,KAAK,QAAQ,GAAG;EAC/B,IAAI,WAAW,KACb;EAEF,MAAM;CACR;CAEA,KAAK,MAAM,cAAc,SACvB,MAAM,IAAI,YAAY,MAAM;CAE9B,OAAO;AACT;;;;;;;;AASA,SAAgB,cAAc,UAAkB,aAA8B;CAC5E,IAAI,CAAC,KAAK,WAAW,QAAQ,GAC3B,OAAO;CAGT,MAAM,MAAM,uBAAuB,KAAK,QAAQ,QAAQ,CAAC;CACzD,IAAI,CAAC,OAAO,IAAI,SAAS,aACvB,OAAO;CAGT,OAAO;EAAC,IAAI;EAAc,IAAI;EAAiB,IAAI;CAAgB,CAAC,CAAC,MAClE,SAAS,QAAQ,QAAQ,OAAO,SAAS,YAAY,OAAO,OAAO,MAAM,WAAW,CACvF;AACF;;;AC3EA,MAAa,gBAAgB;AAM7B,MAAa,oBAAiD,CAC5D;CACE,MAAM;CACN,YAAY,EACV,iBAAiB,EAAE,MAAM,UAAU,EACrC;CACA,sBAAsB;AACxB,CACF;AAEA,SAAS,cAAc,MAA+D;CACpF,OAAQ,KAAiC;AAC3C;AAEA,SAAS,gBAAgB,WAAoC;CAC3D,MAAM,WAAW,UAAU;CAC3B,OAAO,SAAS,SAAS,eAAe,SAAS,OAAO,OAAO,SAAS,KAAK;AAC/E;;;;AAKA,SAAS,kBAAkB,SAAkB,aAA0C;CACrF,OAAO,QAAQ,KAAK,QAAQ,cAA8C;EACxE,OACE,UAAU,SAAS,uBACnB,UAAU,OAAO,UAAU,eAC3B,cAAc,SAAS,MAAM;CAEjC,CAAC;AACH;;;;;;AAOA,SAAgB,mBAAmB,SAA2B,aAA8B;CAE1F,KADiB,QAAQ,QAAQ,MAAM,CAAC,EAAA,CAC5B,oBAAoB,OAC9B,OAAO;CAET,OACE,cAAc,QAAQ,kBAAkB,WAAW,KACnD,kBAAkB,QAAQ,WAAW,KAAK,WAAW,CAAC,CAAC,SAAS;AAEpE;AAEA,SAAgB,aAAa,OAA2B,MAA0C;CAChG,KAAK,IAAI,UAAU,OAAO,SAAS,UAAU,QAAQ,OAAO;EAC1D,MAAM,WAAW,QAAQ,IAAI,IAAI,IAAI;EACrC,IAAI,UACF,OAAO;CAEX;AAEF;;;;;;;AAmBA,SAAgB,gBAAgB,EAC9B,SACA,MACA,MACA,aACA,WACiD;CACjD,MAAM,aAAa,QAAQ;CAC3B,MAAM,UAAU,WAAW;CAE3B,IAAI,QAAQ,gBAAgB,eAAe,UACzC;CAEF,IAAI,WAAW,kBAAkB,IAAI,CAAC,CAAC,SAAS,GAC9C;CAGF,MAAM,QAAQ,WAAW,SAAS,IAAI;CACtC,MAAM,iBAAiB,kBAAkB,SAAS,WAAW;CAI7D,KAAK,MAAM,eAAe,gBACxB,KAAK,MAAM,aAAa,YAAY,YAAY;EAC9C,IACE,UAAU,SAAS,qBACnB,cAAc,SAAS,MAAM,UAC7B,gBAAgB,SAAS,MAAM,MAE/B;EAEF,MAAM,QAAQ,UAAU,MAAM;EAE9B,IADiB,aAAa,OAAO,KAC1B,CAAC,EAAE,KAAK,EAAE,EAAE,SAAS,WAC9B,QAAQ,UAAU,MAAM,YAAY,MAAM,QAAQ,KAAK,CAAC;CAE5D;CAIF,IAAI,aAAa,OAAO,IAAI,GAC1B;CAIF,IADoB,WAAW,aAAa,aAC3B,QAAQ,MAAM,cAAc,UAAU,WAAW,SAAS,IAAI,GAC7E;CAGF,MAAM,cAAc,QAAQ,IAAI;CAEhC,MAAM,cAAc,eAAe,MAAM,gBAAgB;EACvD,OAAO,YAAY,WAAW,MAAM,cAAc,UAAU,SAAS,iBAAiB;CACxF,CAAC;CACD,IAAI,aAAa;EACf,MAAM,gBAAgB,YAAY,WAAW,GAAG,EAAE;EAClD,QAAQ,UAAU,CAChB,MAAM,YAAY,MAAM,WAAW,GACnC,MAAM,gBAAgB,eAAe,KAAK,MAAM,CAClD;CACF;CAEA,MAAM,aAAa,YAAY,KAAK,WAAW,YAAY;CAC3D,MAAM,aAAa,QAAQ,KAAK,UAAU,cAAc,UAAU,SAAS,mBAAmB;CAC9F,IAAI,YAAY;EACd,MAAM,YAAY,WAAW,QAAQ,UAAU,CAAC,CAAC,SAAS,GAAG,IAAI,MAAM;EACvE,QAAQ,UAAU,CAChB,MAAM,YAAY,MAAM,WAAW,GACnC,MAAM,gBAAgB,YAAY,KAAK,aAAa,WAAW,CACjE;CACF;CAGA,MAAM,iBAAiB,QAAQ,KAAK,MAAM,cAAc;EAEtD,OAAO,EACL,UAAU,SAAS,yBACnB,OAAQ,UAAsC,cAAc;CAEhE,CAAC;CACD,IAAI,CAAC,gBACH;CAEF,QAAQ,UAAU,CAChB,MAAM,YAAY,MAAM,WAAW,GACnC,MAAM,iBAAiB,gBAAgB,GAAG,WAAW,GAAG,CAC1D;AACF;;;AC/JA,MAAM,iBAAyD;CAC7D,MAAM;CACN,OAAO;CACP,MAAM;AACR;AAEA,MAAMC,SAAwB;CAC5B,MAAM;EACJ,MAAM;EACN,gBAAgB;EAChB,MAAM;GACJ,aACE;GACF,KAAK;EACP;EACA,UAAU;GACR,wBAAwB;GACxB,6BAA6B;EAC/B;EACA,QAAQ;CACV;CACA,OAAO,SAAS;EACd,IAAI,CAAC,mBAAmB,SAAA,eAAsB,GAC5C,OAAO,CAAC;EAGV,SAAS,MAAM,MAA0B;GACvC,MAAM,QAAQ,yBAAyB,IAAI;GAC3C,MAAM,OAAO,SAAS,eAAe;GACrC,IAAI,CAAC,MACH;GAMF,MAAM,MAAM,gBAAgB;IAC1B;IACA;IACA;IACA,aAAa;IACb,UAAU,UAAU;GACtB,CAAC;GACD,QAAQ,OAAO;IACb;IACA,WAAW;IACX,MAAM,EAAE,KAAK;IACb,SAAS,MAAM,CAAC;KAAE,WAAW;KAA+B,MAAM,EAAE,KAAK;KAAG;IAAI,CAAC,IAAI,CAAC;GACxF,CAAC;EACH;EAEA,OAAO;GACL,yBAAyB;GACzB,oBAAoB;EACtB;CACF;AACF;;;AC5DA,MAAMC,SAAwB;CAC5B,MAAM;EACJ,MAAM;EACN,SAAS;EACT,MAAM;GACJ,aAAa;GACb,KAAK;EACP;EACA,UAAU,EACR,YAAY,uEACd;EACA,QAAQ;CACV;CACA,OAAO,SAAS;EACd,IAAI,CAAC,mBAAmB,SAAA,eAAsB,GAC5C,OAAO,CAAC;EAGV,SAAS,MAAM,MAA0B;GACvC,IAAI,yBAAyB,IAAI,MAAM,aACrC;GAEF,QAAQ,OAAO;IACb;IACA,WAAW;IACX,KAAK,gBAAgB;KACnB;KACA;KACA,MAAM;KACN,aAAa;KACb,UAAU,UAAU;IACtB,CAAC;GACH,CAAC;EACH;EAEA,OAAO;GACL,yBAAyB;GACzB,oBAAoB;EACtB;CACF;AACF;;;AC9BA,SAAS,WAAW,MAAkC;CACpD,OAAO,KAAK,SAAS,6BAA6B,KAAK,SAAS;AAClE;;;;AAKA,SAAS,SAAS,OAAoB,MAAuB;CAC3D,MAAM,WAAW,aAAa,OAAO,IAAI;CACzC,OAAO,CAAC,YAAY,SAAS,KAAK,WAAW;AAC/C;;;;;AAMA,SAAS,kBAAkB,MAA4C;CACrE,MAAM,OAAO,KAAK;CAClB,IAAI,KAAK,SAAS,kBAChB,OAAO;CAET,IAAI,KAAK,KAAK,WAAW,GACvB;CAEF,MAAM,YAAY,KAAK,KAAK;CAC5B,IAAI,UAAU,SAAS,uBACrB,OAAO,UAAU;CAEnB,IAAI,UAAU,SAAS,qBAAqB,UAAU,UACpD,OAAO,UAAU;AAGrB;AAEA,SAAS,aAAa,MAA4B,MAAuB;CACvE,OAAO,KAAK,SAAS,gBAAgB,KAAK,SAAS;AACrD;;;;;AAMA,SAAS,aAAa,MAAkB,OAA6B;CACnE,IAAI,KAAK,SAAS,cAChB,OAAO,KAAK,SAAS,gBAAgB,SAAS,OAAO,YAAY;CAEnE,OACE,KAAK,SAAS,sBACd,CAAC,KAAK,YACN,aAAa,KAAK,UAAU,YAAY,KACxC,KAAK,OAAO,SAAS,iBACpB,KAAK,OAAO,SAAS,gBAAgB,KAAK,OAAO,SAAS,aAC3D,SAAS,OAAO,KAAK,OAAO,IAAI;AAEpC;;;;AAKA,SAAS,kBAAkB,MAAkC,SAA0B;CACrF,IAAI,aAAa,MAAM,OAAO,GAC5B,OAAO;CAET,IAAI,CAAC,WAAW,IAAI,KAAK,KAAK,SAAS,KAAK,aAAa,KAAK,OAAO,SAAS,GAC5E,OAAO;CAET,MAAM,aAAa,kBAAkB,IAAI;CACzC,OACE,YAAY,SAAS,oBACrB,aAAa,WAAW,QAAQ,OAAO,KACvC,WAAW,UAAU,WAAW;AAEpC;;;;AAKA,SAAS,oBAAoB,MAAqB;CAChD,MAAM,gBAAiB,KAA4D;CACnF,IAAI,CAAC,eACH,OAAO;CAET,OACE,cAAc,OAAO,WAAW,MAC/B,cAAc,OAAO,EAAE,CAAC,SAAS,mBAChC,cAAc,OAAO,EAAE,CAAC,SAAS;AAEvC;;;AEjGA,MAAM,SAAS;CACb,MAAM;EACJ,MAAM;EACN;CACF;CACA,OAAO;EACL,+BAA+BE;EAC/B,4BAA4BC;EAC5B,eAAeC;EACf,gBAAgBC;GF2FlB,MAAM;IACJ,MAAM;IACN,SAAS;IACT,MAAM;KACJ,aACE;KACF,KAAK;IACP;IACA,UAAU,EACR,aAAa,+EACf;IACA,QAAQ;GACV;GACA,OAAO,SAAS;IACd,IAAI,CAAC,mBAAmB,SAAA,eAAsB,GAC5C,OAAO,CAAC;IAGV,MAAM,aAAa,QAAQ;;;;;;IAO3B,SAAS,SAAS,MAAoC;KACpD,IACE,KAAK,SAAS,mBACd,CAAC,aAAa,KAAK,QAAQ,SAAS,KACpC,KAAK,UAAU,WAAW,KAC1B,CAAC,oBAAoB,IAAI,GAEzB;KAEF,IAAI,CAAC,SAAS,WAAW,SAAS,IAAI,GAAG,SAAS,GAChD;KAGF,MAAM,WAAW,KAAK,UAAU;KAChC,IAAI,CAAC,WAAW,QAAQ,KAAK,SAAS,SAAS,SAAS,WACtD;KAEF,IAAI,CAAC,SAAS,OAAO,OAAO,UAAU,MAAM,SAAS,YAAY,GAC/D;KAEF,MAAM,eAAe,SAAS,OAAO;KACrC,IAAI,cAAc,SAAS,cACzB;KAGF,MAAM,OAAO,kBAAkB,QAAQ;KACvC,IAAI,MAAM,SAAS,oBAAoB,KAAK,UAC1C;KAEF,MAAM,gBAAgB,WAAW,SAAS,QAAQ;KAClD,IAAI,CAAC,aAAa,KAAK,QAAsB,aAAa,GACxD;KAGF,MAAM,CAAC,UAAU,SAAU,KAAwB;KACnD,IAAI,KAAK,UAAU,WAAW,KAAK,CAAC,SAAS,MAAM,SAAS,iBAC1D;KAEF,IAAI,CAAC,kBAAkB,UAAU,aAAa,IAAI,GAChD;KAWF,IAN2B,cAAc,UAAU,MAAM,aAAa;MACpE,OAAO,SAAS,WAAW,MAAM,cAAc;OAC7C,MAAM,QAAQ,UAAU,WAAW;OACnC,OAAO,MAAM,MAAM,MAAM,MAAO,MAAM,MAAM,MAAM,MAAM,MAAO;MACjE,CAAC;KACH,CACqB,GACnB;KAEF,IACE,SAAS,SAAS,wBAClB,WAAW,UAAU,KAAK,CAAC,CAAC,MAAM,UAAU;MAC1C,OAAO,MAAM,UAAU,UAAU,MAAM,UAAU;KACnD,CAAC,GAED;KAGF,OAAO;IACT;IAEA,OAAO,EACL,cAAc,MAAM;KAClB,MAAM,QAAQ,SAAS,IAAI;KAC3B,IAAI,CAAC,OACH;KAEF,MAAM,YAAY,WAAW,QAAQ,KAAK;KAC1C,QAAQ,OAAO;MACb;MACA,WAAW;MACX,KAAK,gBAAgB;OACnB;OACA;OACA,MAAM;OACN,aAAa;OACb,UAAU,UAAU;QAClB,OAAO,MAAM,SAAS,uBAClB,GAAG,MAAM,IAAI,UAAU,MACvB,GAAG,MAAM,GAAG,UAAU;OAC5B;MACF,CAAC;KACH,CAAC;IACH,EACF;GACF;EE7MkBA;EAChB,qBAAqBC;GDjBvB,MAAM;IACJ,MAAM;IACN,SAAS;IACT,MAAM;KACJ,aAAa;KACb,KAAK;IACP;IACA,UAAU,EACR,iBAAiB,4CACnB;IACA,QAAQ,CAAC;GACX;GACA,OAAO,SAAS;IACd,MAAM,aAAa,QAAQ;IAC3B,OAAO,EACL,aAAa,MAAM;KACjB,IAAI,KAAK,QAAQ,KAAK,QAAQ,KAAK,QACjC;KAGF,MAAM,WAAW,WAAW,cAAc,IAAI;KAC9C,MAAM,eAAe,WAAW,eAAe,KAAK,IAAI;KACxD,IAAI,CAAC,YAAY,CAAC,cAChB;KAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,UAAU,YAAY;KAEtE,QAAQ,OAAO;MACb;MACA,KAAK;OAAE,OAAO,SAAS,IAAI;OAAO,KAAK,aAAa,IAAI;MAAI;MAC5D,WAAW;MACX,KAAK,UACA,UAAU;OACT,OAAO,MAAM,iBACX,CAAC,SAAS,MAAM,IAAI,aAAa,MAAM,EAAE,GACzC,cACF;MACF,IACA,KAAA;KACN,CAAC;IACH,EACF;GACF;EC5BuBA;CACvB;AACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-ocavue",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Custom ESLint rules from ocavue",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",
@@ -35,14 +35,16 @@
     "eslint": "^10.0.0"
   },
   "devDependencies": {
-    "@ocavue/eslint-config": "^4.22.0",
+    "@ocavue/eslint-config": "^4.23.0",
     "@ocavue/tsconfig": "^0.7.1",
+    "@types/estree": "^1.0.10",
     "@types/node": "^24.0.0",
     "eslint": "^10.14.0",
-    "knip": "^6.41.0",
+    "knip": "^6.44.2",
     "oxfmt": "^0.73.0",
     "tsdown": "^0.23.1",
     "typescript": "^6.0.3",
+    "typescript-eslint": "^8.72.1",
     "vitest": "^5.0.5"
   },
   "scripts": {

package/src/index.ts

@@ -3,6 +3,9 @@ import type { ESLint } from 'eslint'
 import { version } from '../package.json'
 
 import noImplicitArrowLinebreak from './rules/no-implicit-arrow-linebreak'
+import preferConstantFunction from './rules/prefer-constant-function'
+import preferNoop from './rules/prefer-noop'
+import preferSleep from './rules/prefer-sleep'
 import preferWhileTrue from './rules/prefer-while-true'
 
 const plugin = {
@@ -12,6 +15,9 @@ const plugin = {
   },
   rules: {
     'no-implicit-arrow-linebreak': noImplicitArrowLinebreak,
+    'prefer-constant-function': preferConstantFunction,
+    'prefer-noop': preferNoop,
+    'prefer-sleep': preferSleep,
     'prefer-while-true': preferWhileTrue,
   },
 } satisfies ESLint.Plugin

package/src/rules/prefer-constant-function.test.ts

@@ -0,0 +1,134 @@
+import { RuleTester } from 'eslint'
+import tseslint from 'typescript-eslint'
+import { test } from 'vitest'
+
+import { useUtilsProjects } from '../utils/test-projects'
+
+import rule from './prefer-constant-function'
+
+const js = useUtilsProjects('js')
+const ts = useUtilsProjects('ts')
+
+function suggestion(name: string, output: string) {
+  return {
+    messageId: 'preferConstantFunction',
+    data: { name },
+    suggestions: [{ messageId: 'replaceWithConstantFunction', data: { name }, output }],
+  }
+}
+
+test('prefer-constant-function', () => {
+  const tester = new RuleTester({
+    languageOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  })
+  const filename = js.withUtils
+
+  tester.run('prefer-constant-function', rule, {
+    valid: [
+      // The project does not depend on `@ocavue/utils`.
+      { code: 'f(() => true)', filename: js.withoutUtils },
+      // `@ocavue/utils` itself.
+      { code: 'f(() => true)', filename: js.utilsRepo },
+
+      // `prefer-noop` handles empty functions.
+      { code: 'f(() => {})', filename },
+      { code: 'f(() => undefined)', filename },
+
+      // Other values.
+      { code: 'f(() => 0)', filename },
+      { code: "f(() => '')", filename },
+      { code: 'f(() => !0)', filename },
+
+      // Replacing would change runtime behavior.
+      { code: 'f(async () => true)', filename },
+      { code: 'f(({ a }) => false)', filename },
+      { code: 'const o = { get foo() { return null } }', filename },
+    ],
+    invalid: [
+      {
+        // Suggestions only: `--fix` leaves the code unchanged.
+        code: 'f(() => true)',
+        output: null,
+        filename,
+        errors: [
+          suggestion('returnTrue', "import { returnTrue } from '@ocavue/utils'\nf(returnTrue)"),
+        ],
+      },
+      {
+        code: 'f((_event) => { return false })',
+        output: null,
+        filename,
+        errors: [
+          suggestion('returnFalse', "import { returnFalse } from '@ocavue/utils'\nf(returnFalse)"),
+        ],
+      },
+      {
+        code: 'f(function () { return null })',
+        output: null,
+        filename,
+        errors: [
+          suggestion('returnNull', "import { returnNull } from '@ocavue/utils'\nf(returnNull)"),
+        ],
+      },
+      {
+        code: "import { noop } from '@ocavue/utils'\nf(() => true, () => null)",
+        output: null,
+        filename,
+        errors: [
+          suggestion(
+            'returnTrue',
+            "import { noop, returnTrue } from '@ocavue/utils'\nf(returnTrue, () => null)",
+          ),
+          suggestion(
+            'returnNull',
+            "import { noop, returnNull } from '@ocavue/utils'\nf(() => true, returnNull)",
+          ),
+        ],
+      },
+      {
+        // No suggestion when another binding uses the name.
+        code: 'const returnTrue = 1\nf(() => true)',
+        output: null,
+        filename,
+        errors: [{ messageId: 'preferConstantFunction', suggestions: [] }],
+      },
+      {
+        code: 'f(() => true)',
+        output: null,
+        filename: js.withoutUtils,
+        options: [{ checkDependency: false }],
+        errors: [
+          suggestion('returnTrue', "import { returnTrue } from '@ocavue/utils'\nf(returnTrue)"),
+        ],
+      },
+    ],
+  })
+})
+
+test('prefer-constant-function with TypeScript', () => {
+  const tester = new RuleTester({
+    languageOptions: {
+      parser: tseslint.parser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+  })
+  const filename = ts.withUtils
+
+  tester.run('prefer-constant-function', rule, {
+    valid: [{ code: 'f(<T,>() => null)', filename }],
+    invalid: [
+      {
+        code: 'const isReady = (): boolean => false',
+        output: null,
+        filename,
+        errors: [
+          suggestion(
+            'returnFalse',
+            "import { returnFalse } from '@ocavue/utils'\nconst isReady = returnFalse",
+          ),
+        ],
+      },
+    ],
+  })
+})

package/src/rules/prefer-constant-function.ts

@@ -0,0 +1,73 @@
+import type { Rule } from 'eslint'
+
+import {
+  getConstantFunctionValue,
+  type ConstantValue,
+  type FunctionNode,
+} from '../utils/constant-function'
+import {
+  createImportFix,
+  isPackageAvailable,
+  packageRuleSchema,
+  UTILS_PACKAGE,
+} from '../utils/package-import'
+
+const FUNCTION_NAMES: Partial<Record<ConstantValue, string>> = {
+  true: 'returnTrue',
+  false: 'returnFalse',
+  null: 'returnNull',
+}
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'suggestion',
+    hasSuggestions: true,
+    docs: {
+      description:
+        'enforce `returnTrue`, `returnFalse` and `returnNull` from `@ocavue/utils` instead of inline functions',
+      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-constant-function',
+    },
+    messages: {
+      preferConstantFunction: 'Use `{{name}}` from `@ocavue/utils` instead of an inline function.',
+      replaceWithConstantFunction: 'Replace with `{{name}}` from `@ocavue/utils`.',
+    },
+    schema: packageRuleSchema,
+  },
+  create(context) {
+    if (!isPackageAvailable(context, UTILS_PACKAGE)) {
+      return {}
+    }
+
+    function check(node: FunctionNode): void {
+      const value = getConstantFunctionValue(node)
+      const name = value && FUNCTION_NAMES[value]
+      if (!name) {
+        return
+      }
+
+      // `returnFalse` returns the literal type `false`, while `() => false`
+      // returns `boolean`. The swap can narrow inferred types, for example
+      // `useState(() => false)`, so it is a suggestion and not an autofix.
+      const fix = createImportFix({
+        context,
+        node,
+        name,
+        packageName: UTILS_PACKAGE,
+        replace: (local) => local,
+      })
+      context.report({
+        node,
+        messageId: 'preferConstantFunction',
+        data: { name },
+        suggest: fix ? [{ messageId: 'replaceWithConstantFunction', data: { name }, fix }] : [],
+      })
+    }
+
+    return {
+      ArrowFunctionExpression: check,
+      FunctionExpression: check,
+    }
+  },
+}
+
+export default rule

package/src/rules/prefer-noop.test.ts

@@ -0,0 +1,263 @@
+import { RuleTester } from 'eslint'
+import tseslint from 'typescript-eslint'
+import { test } from 'vitest'
+
+import { useUtilsProjects } from '../utils/test-projects'
+
+import rule from './prefer-noop'
+
+const js = useUtilsProjects('jsx')
+const ts = useUtilsProjects('ts')
+
+const IMPORT = "import { noop } from '@ocavue/utils'\n"
+
+test('prefer-noop', () => {
+  const tester = new RuleTester({
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      parserOptions: { ecmaFeatures: { jsx: true } },
+    },
+  })
+  const filename = js.withUtils
+
+  tester.run('prefer-noop', rule, {
+    valid: [
+      // The project does not depend on `@ocavue/utils`.
+      { code: 'f(() => {})', filename: js.withoutUtils },
+      // `@ocavue/utils` itself.
+      { code: 'f(() => {})', filename: js.utilsRepo },
+      // No file on disk.
+      { code: 'f(() => {})' },
+
+      // Not an empty function.
+      { code: 'f(() => true)', filename },
+      { code: 'f(() => null)', filename },
+      { code: 'f(() => 1)', filename },
+      { code: 'f(() => x)', filename },
+      { code: 'f(() => { g() })', filename },
+      { code: 'f(() => { g(); return })', filename },
+
+      // Replacing would change runtime behavior.
+      { code: 'f(async () => {})', filename },
+      { code: 'f(function* () {})', filename },
+      { code: 'f(({ a }) => {})', filename },
+      { code: 'f(([a]) => {})', filename },
+      { code: 'f((x = g()) => {})', filename },
+      { code: 'f(function named() {})', filename },
+      { code: 'new (function () {})()', filename },
+
+      // Methods.
+      { code: 'const o = { foo() {} }', filename },
+      { code: 'const o = { set foo(v) {} }', filename },
+      { code: 'class A { foo() {} }', filename },
+      { code: 'class A { constructor() {} }', filename },
+
+      // Already uses `noop`.
+      { code: `${IMPORT}f(noop)`, filename },
+    ],
+    invalid: [
+      {
+        code: 'f(() => {})',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'const el = <button onClick={() => {}} />',
+        output: `${IMPORT}const el = <button onClick={noop} />`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(function () {})',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(() => undefined)',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(() => void 0)',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(() => { return })',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(() => { return undefined })',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f((_a, ...rest) => {})',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'const o = { foo: () => {} }',
+        output: `${IMPORT}const o = { foo: noop }`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'class A { foo = () => {} }',
+        output: `${IMPORT}class A { foo = noop }`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'function f(cb = () => {}) {}',
+        output: `${IMPORT}function f(cb = noop) {}`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+
+      // Import handling.
+      {
+        code: "import { once } from '@ocavue/utils'\nf(() => {})",
+        output: "import { once, noop } from '@ocavue/utils'\nf(noop)",
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: "import { noop as n } from '@ocavue/utils'\nf(() => {})",
+        output: "import { noop as n } from '@ocavue/utils'\nf(n)",
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: "import a from 'a';\nf(() => {})",
+        output: "import a from 'a';\nimport { noop } from '@ocavue/utils';\nf(noop)",
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: "'use client'\nf(() => {})",
+        output: `'use client'\n${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        // The file imports `@ocavue/utils`, so the rule is on even without
+        // the dependency.
+        code: "import { once } from '@ocavue/utils'\nf(() => {})",
+        output: "import { once, noop } from '@ocavue/utils'\nf(noop)",
+        filename: js.withoutUtils,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        // Only one fix is applied per pass because each fix adds the import.
+        code: 'f(() => {})\ng(() => {})',
+        output: `${IMPORT}f(noop)\ng(() => {})`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }, { messageId: 'preferNoop' }],
+      },
+      {
+        code: `${IMPORT}f(() => {})\ng(() => {})`,
+        output: `${IMPORT}f(noop)\ng(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }, { messageId: 'preferNoop' }],
+      },
+
+      // Reported without a fix.
+      {
+        code: 'const noop = 1\nf(() => {})',
+        output: null,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: `${IMPORT}function g(noop) { f(() => {}) }`,
+        output: null,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'noop()\nf(() => {})',
+        output: null,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(() => { /* intentionally empty */ })',
+        output: null,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f(() => {})',
+        output: null,
+        filename,
+        languageOptions: { sourceType: 'commonjs' },
+        errors: [{ messageId: 'preferNoop' }],
+      },
+
+      // `checkDependency: false` reports in every project.
+      {
+        code: 'f(() => {})',
+        output: `${IMPORT}f(noop)`,
+        filename: js.withoutUtils,
+        options: [{ checkDependency: false }],
+        errors: [{ messageId: 'preferNoop' }],
+      },
+    ],
+  })
+})
+
+test('prefer-noop with TypeScript', () => {
+  const tester = new RuleTester({
+    languageOptions: {
+      parser: tseslint.parser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+  })
+  const filename = ts.withUtils
+
+  tester.run('prefer-noop', rule, {
+    valid: [
+      { code: 'f(<T,>() => {})', filename },
+      { code: 'class A { foo(): void {} }', filename },
+      { code: 'abstract class A { abstract foo(): void }', filename },
+    ],
+    invalid: [
+      {
+        code: 'const f: () => void = (): void => {}',
+        output: `${IMPORT}const f: () => void = noop`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: 'f((event: Event) => {})',
+        output: `${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        code: "'use client'\nf(() => {})",
+        output: `'use client'\n${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+      {
+        // A type-only import is not reused.
+        code: "import type { Counter } from '@ocavue/utils'\nf(() => {})",
+        output: `import type { Counter } from '@ocavue/utils'\n${IMPORT}f(noop)`,
+        filename,
+        errors: [{ messageId: 'preferNoop' }],
+      },
+    ],
+  })
+})

package/src/rules/prefer-noop.ts

@@ -0,0 +1,53 @@
+import type { Rule } from 'eslint'
+
+import { getConstantFunctionValue, type FunctionNode } from '../utils/constant-function'
+import {
+  createImportFix,
+  isPackageAvailable,
+  packageRuleSchema,
+  UTILS_PACKAGE,
+} from '../utils/package-import'
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'suggestion',
+    fixable: 'code',
+    docs: {
+      description: 'enforce `noop` from `@ocavue/utils` instead of inline empty functions',
+      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-noop',
+    },
+    messages: {
+      preferNoop: 'Use `noop` from `@ocavue/utils` instead of an inline empty function.',
+    },
+    schema: packageRuleSchema,
+  },
+  create(context) {
+    if (!isPackageAvailable(context, UTILS_PACKAGE)) {
+      return {}
+    }
+
+    function check(node: FunctionNode): void {
+      if (getConstantFunctionValue(node) !== 'undefined') {
+        return
+      }
+      context.report({
+        node,
+        messageId: 'preferNoop',
+        fix: createImportFix({
+          context,
+          node,
+          name: 'noop',
+          packageName: UTILS_PACKAGE,
+          replace: (local) => local,
+        }),
+      })
+    }
+
+    return {
+      ArrowFunctionExpression: check,
+      FunctionExpression: check,
+    }
+  },
+}
+
+export default rule