fix: patch new eslint options types (#411)

scagood · web-flow · commit 340312e15f06 · 2025-03-02T16:44:00.000+08:00
diff --git a/.github/release-please/manifest.json b/.github/release-please/manifest.json
@@ -1 +1 @@
-{".":"17.16.0"}
+{ ".": "17.16.0" }
diff --git a/lib/rules/hashbang.js b/lib/rules/hashbang.js
@@ -52,8 +52,9 @@ function isNodeShebang(shebang, executableName) {
  */
 function getExpectedExecutableName(context) {
     const extension = path.extname(context.filename ?? context.getFilename())
-    /** @type {{ executableMap: Record<string, string> }} */
-    const { executableMap = {} } = context.options?.[0] ?? {}
+    const { executableMap = {} } =
+        /** @type {[{ executableMap: Record<string, string> }]} */
+        (context.options)?.[0] ?? {}
 
     return executableMap[extension] ?? "node"
 }
diff --git a/lib/rules/no-deprecated-api.js b/lib/rules/no-deprecated-api.js
@@ -738,7 +738,10 @@ function toName(type, path) {
  * @returns {ParsedOptions} Parsed options
  */
 function parseOptions(context) {
-    const raw = context.options[0] || {}
+    const raw = /** @type {{
+        ignoreModuleItems?: string[];
+        ignoreGlobalItems?: string[];
+    }} */ (context.options[0] || {})
     const version = getConfiguredNodeVersion(context)
     const ignoredModuleItems = new Set(raw.ignoreModuleItems || [])
     const ignoredGlobalItems = new Set(raw.ignoreGlobalItems || [])
diff --git a/lib/util/check-restricted.js b/lib/util/check-restricted.js
@@ -96,7 +96,9 @@ function createRestrictions(defs) {
  * @returns {void}
  */
 exports.checkForRestriction = function checkForRestriction(context, targets) {
-    const restrictions = createRestrictions(context.options[0])
+    const restrictions = createRestrictions(
+        /** @type {string[]} */ (context.options[0])
+    )
 
     for (const target of targets) {
         const restriction = restrictions.find(r => r.match(target))
diff --git a/lib/util/check-unsupported-builtins.js b/lib/util/check-unsupported-builtins.js
@@ -22,7 +22,10 @@ const { getScope } = require("../util/eslint-compat")
  * }>} Parsed value.
  */
 function parseOptions(context) {
-    const raw = context.options[0] || {}
+    const raw = /** @type {{
+     *   ignores?: string[];
+     *   allowExperimental?: boolean;
+     * }} */ (context.options[0] || {})
     const version = getConfiguredNodeVersion(context)
     const ignores = new Set(raw.ignores || [])
     const allowExperimental = raw.allowExperimental ?? false
diff --git a/lib/util/get-allow-modules.js b/lib/util/get-allow-modules.js
@@ -9,10 +9,14 @@
  */
 const DEFAULT_VALUE = []
 
+/**
+ * @typedef {{allowModules:? string[]}|undefined} Option
+ */
+
 /**
  * Gets `allowModules` property from a given option object.
  *
- * @param {{allowModules:? string[]}|undefined} option - An option object to get.
+ * @param {Option} option - An option object to get.
  * @returns {string[]|null} The `allowModules` value, or `null`.
  */
 function get(option) {
@@ -34,9 +38,9 @@ function get(option) {
  */
 module.exports = function getAllowModules(context) {
     return (
-        get(context.options[0]) ??
-        get(context.settings?.n) ??
-        get(context.settings?.node) ??
+        get(/** @type {Option} */ (context.options[0])) ??
+        get(/** @type {Option} */ (context.settings?.n)) ??
+        get(/** @type {Option} */ (context.settings?.node)) ??
         DEFAULT_VALUE
     )
 }
diff --git a/lib/util/get-configured-node-version.js b/lib/util/get-configured-node-version.js
@@ -10,10 +10,14 @@ const getSemverRange = require("./get-semver-range")
 
 const fallbackRange = new Range(">=16.0.0")
 
+/**
+ * @typedef {{ version:? string } | undefined} VersionOption
+ */
+
 /**
  * Gets `version` property from a given option object.
  *
- * @param {Record<string, string>|undefined} option - An option object to get.
+ * @param {VersionOption} option - An option object to get.
  * @returns {import("semver").Range|undefined} The `allowModules` value, or `null`.
  */
 function getVersionRange(option) {
@@ -55,9 +59,11 @@ function getEnginesNode(context) {
  */
 module.exports = function getConfiguredNodeVersion(context) {
     return (
-        getVersionRange(context.options?.[0]) ??
-        getVersionRange(context.settings?.n) ??
-        getVersionRange(context.settings?.node) ??
+        getVersionRange(/** @type {VersionOption} */ (context.options?.[0])) ??
+        getVersionRange(/** @type {VersionOption} */ (context.settings?.n)) ??
+        getVersionRange(
+            /** @type {VersionOption} */ (context.settings?.node)
+        ) ??
         getEnginesNode(context) ??
         fallbackRange
     )
diff --git a/lib/util/get-convert-path.js b/lib/util/get-convert-path.js
@@ -111,10 +111,14 @@ function combine(converters) {
     }
 }
 
+/**
+ * @typedef {{ convertPath?: ConvertPath } | undefined} ConvertPathOption
+ */
+
 /**
  * Parses `convertPath` property from a given option object.
  *
- * @param {{convertPath?: ConvertPath}|undefined} option - An option object to get.
+ * @param {ConvertPathOption} option - An option object to get.
  * @returns {Converter['convert']|null} A function which converts a path., or `null`.
  */
 function parse(option) {
@@ -148,9 +152,9 @@ function parse(option) {
  */
 module.exports = function getConvertPath(context) {
     return (
-        parse(context.options?.[0]) ??
-        parse(context.settings?.n) ??
-        parse(context.settings?.node) ??
+        parse(/** @type {ConvertPathOption} */ (context.options?.[0])) ??
+        parse(/** @type {ConvertPathOption} */ (context.settings?.n)) ??
+        parse(/** @type {ConvertPathOption} */ (context.settings?.node)) ??
         identity
     )
 }
diff --git a/lib/util/get-resolve-paths.js b/lib/util/get-resolve-paths.js
@@ -10,11 +10,16 @@ const DEFAULT_VALUE = []
 /**
  * Gets `resolvePaths` property from a given option object.
  *
- * @param {{ resolvePaths: unknown[] } | undefined} option - An option object to get.
+ * @param {unknown} option - An option object to get.
  * @returns {string[] | undefined} The `allowModules` value, or `null`.
  */
 function get(option) {
-    if (Array.isArray(option?.resolvePaths)) {
+    if (
+        option != null &&
+        typeof option === "object" &&
+        "resolvePaths" in option &&
+        Array.isArray(option?.resolvePaths)
+    ) {
         return option.resolvePaths.map(String)
     }
 }
diff --git a/lib/util/get-resolver-config.js b/lib/util/get-resolver-config.js
@@ -11,10 +11,14 @@
 /** @type {ResolverConfig} */
 const DEFAULT_VALUE = {}
 
+/**
+ * @typedef {{ resolverConfig?: ResolverConfig } | undefined} ResolverConfigOption
+ */
+
 /**
  * Gets `resolverConfig` property from a given option object.
  *
- * @param {{ resolverConfig: ResolverConfig } | undefined} option - An option object to get.
+ * @param {ResolverConfigOption} option - An option object to get.
  * @returns {ResolverConfig | undefined} The `allowModules` value, or `null`.
  */
 function get(option) {
@@ -33,9 +37,11 @@ function get(option) {
  */
 module.exports = function getResolverConfig(context, optionIndex = 0) {
     return (
-        get(context.options?.[optionIndex]) ??
-        get(context.settings?.n) ??
-        get(context.settings?.node) ??
+        get(
+            /** @type {ResolverConfigOption} */ (context.options?.[optionIndex])
+        ) ??
+        get(/** @type {ResolverConfigOption} */ (context.settings?.n)) ??
+        get(/** @type {ResolverConfigOption} */ (context.settings?.node)) ??
         DEFAULT_VALUE
     )
 }
diff --git a/lib/util/get-try-extensions.js b/lib/util/get-try-extensions.js
@@ -24,11 +24,16 @@ const DEFAULT_TS_VALUE = [
 /**
  * Gets `tryExtensions` property from a given option object.
  *
- * @param {{ tryExtensions: unknown[] } | undefined} option - An option object to get.
+ * @param {unknown} option - An option object to get.
  * @returns {string[] | undefined} The `tryExtensions` value, or `null`.
  */
 function get(option) {
-    if (Array.isArray(option?.tryExtensions)) {
+    if (
+        option != null &&
+        typeof option === "object" &&
+        "tryExtensions" in option &&
+        Array.isArray(option?.tryExtensions)
+    ) {
         return option.tryExtensions.map(String)
     }
 }
diff --git a/lib/util/get-typescript-extension-map.js b/lib/util/get-typescript-extension-map.js
@@ -129,8 +129,12 @@ function getFromTSConfigFromFile(context) {
  */
 module.exports = function getTypescriptExtensionMap(context) {
     return (
-        get(context.options?.[0]) ||
-        get(context.settings?.n ?? context.settings?.node) ||
+        get(/** @type {Options} */ (context.options?.[0])) ||
+        get(
+            /** @type {Options} */ (
+                context.settings?.n ?? context.settings?.node
+            )
+        ) ||
         getFromTSConfigFromFile(context) ||
         PRESERVE_MAPPING
     )
diff --git a/lib/util/import-target.js b/lib/util/import-target.js
@@ -345,7 +345,11 @@ module.exports = class ImportTarget {
 
         const requireResolve = resolver.create.sync(this.resolverConfig)
 
-        const cwd = this.context.settings?.cwd ?? process.cwd()
+        const cwd =
+            typeof this.context.settings?.cwd === "string"
+                ? this.context.settings?.cwd
+                : process.cwd()
+
         for (const directory of this.getPaths()) {
             const baseDir = resolve(cwd, directory)
 

Original file line number	Diff line number	Diff line change
`@@ -111,10 +111,14 @@ function combine(converters) {`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`
	`114`	`+/**`
	`115`	`+ * @typedef {{ convertPath?: ConvertPath } \| undefined} ConvertPathOption`
	`116`	`+ */`
	`117`	`+`
`114`	`118`	`/**`
`115`	`119`	* Parses `convertPath` property from a given option object.
`116`	`120`	`*`
`117`		`- * @param {{convertPath?: ConvertPath}\|undefined} option - An option object to get.`
	`121`	`+ * @param {ConvertPathOption} option - An option object to get.`
`118`	`122`	* @returns {Converter['convert']\|null} A function which converts a path., or `null`.
`119`	`123`	`*/`
`120`	`124`	`function parse(option) {`
`@@ -148,9 +152,9 @@ function parse(option) {`
`148`	`152`	`*/`
`149`	`153`	`module.exports = function getConvertPath(context) {`
`150`	`154`	`return (`
`151`		`- parse(context.options?.[0]) ??`
`152`		`- parse(context.settings?.n) ??`
`153`		`- parse(context.settings?.node) ??`
	`155`	`+ parse(/** @type {ConvertPathOption} */ (context.options?.[0])) ??`
	`156`	`+ parse(/** @type {ConvertPathOption} */ (context.settings?.n)) ??`
	`157`	`+ parse(/** @type {ConvertPathOption} */ (context.settings?.node)) ??`
`154`	`158`	`identity`
`155`	`159`	`)`
`156`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,16 @@ const DEFAULT_VALUE = []`
`10`	`10`	`/**`
`11`	`11`	* Gets `resolvePaths` property from a given option object.
`12`	`12`	`*`
`13`		`- * @param {{ resolvePaths: unknown[] } \| undefined} option - An option object to get.`
	`13`	`+ * @param {unknown} option - An option object to get.`
`14`	`14`	* @returns {string[] \| undefined} The `allowModules` value, or `null`.
`15`	`15`	`*/`
`16`	`16`	`function get(option) {`
`17`		`- if (Array.isArray(option?.resolvePaths)) {`
	`17`	`+ if (`
	`18`	`+ option != null &&`
	`19`	`+ typeof option === "object" &&`
	`20`	`+ "resolvePaths" in option &&`
	`21`	`+ Array.isArray(option?.resolvePaths)`
	`22`	`+ ) {`
`18`	`23`	`return option.resolvePaths.map(String)`
`19`	`24`	`}`
`20`	`25`	`}`