Refactor Cosmiconfig types (#7543)

Allowing the `CosmiconfigResult` type to receive a type parameter can make the code a bit type-safer
because the `any` type is no longer used.
Ref https://github.com/cosmiconfig/cosmiconfig/blob/v9.0.0/src/types.ts#L11

lib/getConfigForFile.cjs

@@ -11,15 +11,11 @@ const configurationError = require('./utils/configurationError.cjs');
 const IS_TEST = process.env.NODE_ENV === 'test';
 const STOP_DIR = IS_TEST ? process.cwd() : undefined;
 
-/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
-/** @typedef {import('stylelint').Config} StylelintConfig */
-/** @typedef {import('stylelint').CosmiconfigResult} StylelintCosmiconfigResult */
-
 /**
- * @param {StylelintInternalApi} stylelint
+ * @param {import('stylelint').InternalApi} stylelint
  * @param {string} [searchPath]
  * @param {string} [filePath]
- * @returns {Promise<StylelintCosmiconfigResult>}
+ * @returns {Promise<import('stylelint').CosmiconfigResult>}
  */
 async function getConfigForFile(
 	stylelint,

lib/getConfigForFile.mjs

@@ -9,15 +9,11 @@ import configurationError from './utils/configurationError.mjs';
 const IS_TEST = process.env.NODE_ENV === 'test';
 const STOP_DIR = IS_TEST ? process.cwd() : undefined;
 
-/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
-/** @typedef {import('stylelint').Config} StylelintConfig */
-/** @typedef {import('stylelint').CosmiconfigResult} StylelintCosmiconfigResult */
-
 /**
- * @param {StylelintInternalApi} stylelint
+ * @param {import('stylelint').InternalApi} stylelint
  * @param {string} [searchPath]
  * @param {string} [filePath]
- * @returns {Promise<StylelintCosmiconfigResult>}
+ * @returns {Promise<import('stylelint').CosmiconfigResult>}
  */
 export default async function getConfigForFile(
 	stylelint,

lib/standalone.cjs

@@ -350,8 +350,20 @@ async function postProcessStylelintResult(stylelint, stylelintResult, filePath)
 		return;
 	}
 
-	for (let postprocess of config._processorFunctions.values()) {
-		postprocess?.(stylelintResult, stylelintResult._postcssResult?.root);
+	let root = stylelintResult?._postcssResult?.root;
+
+	if (root) {
+		if ('type' in root) {
+			if (root.type !== 'root') {
+				root = undefined;
+			}
+		} else {
+			root = undefined;
+		}
+	}
+
+	for (const postprocess of config._processorFunctions.values()) {
+		postprocess?.(stylelintResult, root);
 	}
 }
 

lib/standalone.mjs

@@ -348,7 +348,19 @@ async function postProcessStylelintResult(stylelint, stylelintResult, filePath)
 		return;
 	}
 
-	for (let postprocess of config._processorFunctions.values()) {
-		postprocess?.(stylelintResult, stylelintResult._postcssResult?.root);
+	let root = stylelintResult?._postcssResult?.root;
+
+	if (root) {
+		if ('type' in root) {
+			if (root.type !== 'root') {
+				root = undefined;
+			}
+		} else {
+			root = undefined;
+		}
+	}
+
+	for (const postprocess of config._processorFunctions.values()) {
+		postprocess?.(stylelintResult, root);
 	}
 }

patches/cosmiconfig+9.0.0.patch

@@ -0,0 +1,15 @@
+diff --git a/node_modules/cosmiconfig/dist/types.d.ts b/node_modules/cosmiconfig/dist/types.d.ts
+index a7ddb91..f59591a 100644
+--- a/node_modules/cosmiconfig/dist/types.d.ts
++++ b/node_modules/cosmiconfig/dist/types.d.ts
+@@ -5,8 +5,8 @@ export type Config = any;
+ /**
+  * @public
+  */
+-export type CosmiconfigResult = {
+-    config: Config;
++export type CosmiconfigResult<T = Config> = {
++    config: T;
+     filepath: string;
+     isEmpty?: boolean;
+ } | null;

types/stylelint/index.d.ts

@@ -1,6 +1,6 @@
 import type * as PostCSS from 'postcss';
 import type { GlobbyOptions } from 'globby';
-import type { cosmiconfig, TransformSync as CosmiconfigTransformSync } from 'cosmiconfig';
+import type * as Cosmiconfig from 'cosmiconfig';
 
 type ConfigExtends = string | string[];
 
@@ -129,9 +129,7 @@ declare namespace stylelint {
 	export type DisablePropertyName = PropertyNamesOfType<Config, DisableSettings>;
 
 	/** @internal */
-	export type CosmiconfigResult =
-		| (ReturnType<CosmiconfigTransformSync> & { config: Config })
-		| null;
+	export type CosmiconfigResult = Cosmiconfig.CosmiconfigResult<Config>;
 
 	/** @internal */
 	export type DisabledRange = {
@@ -770,7 +768,7 @@ declare namespace stylelint {
 	 */
 	export type InternalApi = {
 		_options: LinterOptions & { cwd: string };
-		_extendExplorer: ReturnType<typeof cosmiconfig>;
+		_extendExplorer: Cosmiconfig.PublicExplorer;
 		_specifiedConfigCache: Map<Config, Promise<CosmiconfigResult>>;
 		_postcssResultCache: Map<string, PostCSS.Result>;
 		_fileCache: FileCache;