fix(hashbang): Add missing types

Author: scagood

lib/rules/hashbang.js

@@ -5,7 +5,7 @@
 "use strict"
 
 const path = require("path")
-const matcher = require("ignore")
+const matcher = require("ignore").default
 
 const getConvertPath = require("../util/get-convert-path")
 const getPackageJson = require("../util/get-package-json")
@@ -16,6 +16,11 @@ const SHEBANG_PATTERN = /^(#!.+?)?(\r)?\n/u
 const NODE_SHEBANG_PATTERN =
     /^#!\/usr\/bin\/env(?: -\S+)*(?: [^\s=-]+=\S+)* node(?: [^\r\n]+?)?\n/u
 
+/**
+ * @param {string} filePath
+ * @param {string} binField
+ * @returns {boolean}
+ */
 function simulateNodeResolutionAlgorithm(filePath, binField) {
     const possibilities = [filePath]
     let newFilePath = filePath.replace(/\.js$/u, "")
@@ -29,32 +34,42 @@ function simulateNodeResolutionAlgorithm(filePath, binField) {
  * Checks whether or not a given path is a `bin` file.
  *
  * @param {string} filePath - A file path to check.
- * @param {string|object|undefined} binField - A value of the `bin` field of `package.json`.
+ * @param {unknown} binField - A value of the `bin` field of `package.json`.
  * @param {string} basedir - A directory path that `package.json` exists.
  * @returns {boolean} `true` if the file is a `bin` file.
  */
 function isBinFile(filePath, binField, basedir) {
     if (!binField) {
         return false
     }
+
     if (typeof binField === "string") {
         return simulateNodeResolutionAlgorithm(
             filePath,
             path.resolve(basedir, binField)
         )
     }
-    return Object.keys(binField).some(key =>
-        simulateNodeResolutionAlgorithm(
-            filePath,
-            path.resolve(basedir, binField[key])
-        )
-    )
+
+    if (binField instanceof Object) {
+        for (const [value] of Object.values(binField)) {
+            if (typeof value !== "string") {
+                continue
+            }
+
+            const resolvedPath = path.resolve(basedir, value)
+            if (simulateNodeResolutionAlgorithm(filePath, resolvedPath)) {
+                return true
+            }
+        }
+    }
+
+    return false
 }
 
 /**
  * Gets the shebang line (includes a line ending) from a given code.
  *
- * @param {SourceCode} sourceCode - A source code object to check.
+ * @param {import('eslint').SourceCode} sourceCode - A source code object to check.
  * @returns {{length: number, bom: boolean, shebang: string, cr: boolean}}
  *      shebang's information.
  *      `retv.shebang` is an empty string if shebang doesn't exist.
@@ -128,6 +143,7 @@ module.exports = {
             convertedRelativePath
         )
 
+        /** @type {{ additionalExecutables: string[] }} */
         const { additionalExecutables = [] } = context.options?.[0] ?? {}
 
         const executable = matcher()
@@ -155,7 +171,10 @@ module.exports = {
             Program() {
                 const loc = {
                     start: { line: 1, column: 0 },
-                    end: { line: 1, column: sourceCode.lines.at(0).length },
+                    end: {
+                        line: 1,
+                        column: sourceCode.lines.at(0)?.length ?? 0,
+                    },
                 }
 
                 if (

lib/rules/shebang.js

@@ -12,7 +12,7 @@ module.exports = {
         ...hashbang.meta,
         deprecated: true,
         replacedBy: ["n/hashbang"],
-        docs: { ...hashbang.meta.docs, recommended: false },
+        docs: { ...hashbang.meta?.docs, recommended: false },
     },
     create: hashbang.create,
 }