stylelint · ybiquitous · Nov 9, 2023 · Nov 7, 2023 · Nov 9, 2023 · Mouvedia
diff --git a/.changeset/sixty-lions-build.md b/.changeset/sixty-lions-build.md
@@ -0,0 +1,5 @@
+---
+"stylelint": major
+---
+
+Changed: TypeScript definitions for ESM
diff --git a/lib/augmentConfig.cjs b/lib/augmentConfig.cjs
@@ -12,7 +12,6 @@ const getModulePath = require('./utils/getModulePath.cjs');
 const normalizeAllRuleSettings = require('./normalizeAllRuleSettings.cjs');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
 const require$1 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('lib/augmentConfig.cjs', document.baseURI).href)));
 
 /** @typedef {import('stylelint').InternalApi} StylelintInternalApi */

diff --git a/lib/augmentConfig.mjs b/lib/augmentConfig.mjs
@@ -1,5 +1,5 @@
 import { createRequire } from 'node:module';
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+
 const require = createRequire(import.meta.url);
 
 import { dirname, isAbsolute } from 'node:path';
@@ -81,8 +81,8 @@
 export function augmentConfigExtended(cwd) {
 	return async (cosmiconfigResult) => {
 		if (!cosmiconfigResult) {
 			return null;
 		}

 		const configDir = dirname(cosmiconfigResult.filepath || '');
 		const { config } = cosmiconfigResult;
@@ -253,16 +253,16 @@
 	const overridesMerger = {};

 	if (a.overrides || b.overrides) {
 		overridesMerger.overrides = [];

 		if (a.overrides) {
 			overridesMerger.overrides = overridesMerger.overrides.concat(a.overrides);
 		}

 		if (b.overrides) {
 			overridesMerger.overrides = [...new Set(overridesMerger.overrides.concat(b.overrides))];
 		}
 	}

 	/** @type {Pick<StylelintConfig, 'extends'>} */
 	const extendsMerger = {};
@@ -334,10 +334,10 @@

 		for (const pluginRuleDefinition of normalizedPluginImport) {
 			if (!pluginRuleDefinition.ruleName) {
 				throw configurationError(
 					`stylelint requires plugins to expose a ruleName. The plugin "${pluginLookup}" is not doing this, so will not work with stylelint. Please file an issue with the plugin.`,
 				);
 			}

 			if (!pluginRuleDefinition.ruleName.includes('/')) {
 				throw configurationError(

diff --git a/lib/cli.mjs b/lib/cli.mjs
@@ -3,7 +3,7 @@
 import process from 'node:process';
 
 import { createRequire } from 'node:module';
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+
 const require = createRequire(import.meta.url);
 
 import picocolors from 'picocolors';
@@ -421,13 +421,13 @@
 				return;
 			}

 			throw error;
 		}
 	}

 	if (isString(stdinFilename)) {
 		options.codeFilename = stdinFilename;
 	}

 	if (Array.isArray(ignorePath)) {
 		options.ignorePath = ignorePath;
@@ -450,12 +450,12 @@
 	}

 	if (isString(cacheLocation)) {
 		options.cacheLocation = cacheLocation;
 	}

 	if (isString(cacheStrategy)) {
 		options.cacheStrategy = cacheStrategy;
 	}

 	if (isBoolean(fix)) {
 		options.fix = fix;
@@ -519,8 +519,8 @@
 			}

 			if (isString(outputFile)) {
 				writeOutputFile(report, outputFile).catch(handleError);
 			}

 			if (errored) {
 				process.exitCode = EXIT_CODE_LINT_PROBLEM;
@@ -544,8 +544,8 @@
 */
 function handleError(err) {
 	if (!isObject(err)) {
 		throw err;
 	}

 	if ('stack' in err && isString(err.stack)) {
 		process.stderr.write(err.stack + EOL);
@@ -577,7 +577,7 @@
 		return Promise.resolve(options);
 	}

 	return Promise.reject(errorMessage());
 }

 /**
@@ -620,7 +620,6 @@
 		// See also https://github.com/sindresorhus/meow/blob/v12.0.1/source/validate.js#L75
 		allowUnknownFlags: true,
 
-		// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
 		importMeta: import.meta,
 	});
 }
diff --git a/lib/createPlugin.cjs b/lib/createPlugin.cjs
@@ -3,7 +3,7 @@
 'use strict';
 
 /**
- * @type {import('stylelint')['createPlugin']}
+ * @type {import('stylelint').PublicApi['createPlugin']}
  */
 function createPlugin(ruleName, rule) {
 	return {

diff --git a/lib/createPlugin.mjs b/lib/createPlugin.mjs
@@ -1,5 +1,5 @@
 /**
- * @type {import('stylelint')['createPlugin']}
+ * @type {import('stylelint').PublicApi['createPlugin']}
  */
 export default function createPlugin(ruleName, rule) {
 	return {

diff --git a/lib/createStylelint.cjs b/lib/createStylelint.cjs
@@ -11,7 +11,7 @@ const IS_TEST = process.env.NODE_ENV === 'test';
 const STOP_DIR = IS_TEST ? process.cwd() : undefined;
 
 /**
- * @type {import('stylelint')['_createLinter']}
+ * @type {import('stylelint').PublicApi['_createLinter']}
  */
 function createStylelint(options = {}) {
 	const cwd = options.cwd || process.cwd();

diff --git a/lib/createStylelint.mjs b/lib/createStylelint.mjs
@@ -9,7 +9,7 @@ const IS_TEST = process.env.NODE_ENV === 'test';
 const STOP_DIR = IS_TEST ? process.cwd() : undefined;
 
 /**
- * @type {import('stylelint')['_createLinter']}
+ * @type {import('stylelint').PublicApi['_createLinter']}
  */
 export default function createStylelint(options = {}) {
 	const cwd = options.cwd || process.cwd();

diff --git a/lib/formatters/index.cjs b/lib/formatters/index.cjs
@@ -4,7 +4,7 @@
 
 const _interopNamespaceDefaultOnly = e => Object.freeze({ __proto__: null, default: e });
 
-/** @type {import('stylelint').Formatters} */
+/** @type {import('stylelint').PublicApi['formatters']} */
 const formatters = {
 	get compact() {
 		return Promise.resolve().then(() => /*#__PURE__*/_interopNamespaceDefaultOnly(require('./compactFormatter.cjs'))).then((m) => m.default);

diff --git a/lib/formatters/index.mjs b/lib/formatters/index.mjs
@@ -1,4 +1,4 @@
-/** @type {import('stylelint').Formatters} */
+/** @type {import('stylelint').PublicApi['formatters']} */
 const formatters = {
 	get compact() {
 		return import('./compactFormatter.mjs').then((m) => m.default);

diff --git a/lib/getPostcssResult.cjs b/lib/getPostcssResult.cjs
@@ -10,7 +10,6 @@ const postcss = require('postcss');
 const getModulePath = require('./utils/getModulePath.cjs');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
 const require$1 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('lib/getPostcssResult.cjs', document.baseURI).href)));
 
 /** @typedef {import('postcss').Result} Result */

diff --git a/lib/getPostcssResult.mjs b/lib/getPostcssResult.mjs
@@ -1,5 +1,5 @@
 import { createRequire } from 'node:module';
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+
 const require = createRequire(import.meta.url);
 
 import { extname } from 'node:path';
@@ -28,8 +28,8 @@
 	const cached = options.filePath ? stylelint._postcssResultCache.get(options.filePath) : undefined;

 	if (cached) {
 		return cached;
 	}

 	const syntax = options.customSyntax
 		? getCustomSyntax(options.customSyntax, stylelint._options.configBasedir)
@@ -50,8 +50,8 @@
 	}

 	if (getCode === undefined) {
 		return Promise.reject(new Error('code or filePath required'));
 	}

 	const postcssResult = await new LazyResult(postcssProcessor, getCode, postcssOptions);

@@ -90,8 +90,8 @@
 				);
 			}

 			throw error;
 		}

 		/*
 		 * PostCSS allows for syntaxes that only contain a parser, however,

diff --git a/lib/index.cjs b/lib/index.cjs
@@ -15,7 +15,7 @@ const index = require('./rules/index.cjs');
 const standalone = require('./standalone.cjs');
 const validateOptions = require('./utils/validateOptions.cjs');
 
-/** @type {import('stylelint')} */
+/** @type {import('stylelint').PublicApi} */
 const stylelint = Object.assign(postcssPlugin, {
 	lint: standalone,
 	rules: index,

diff --git a/lib/index.mjs b/lib/index.mjs
@@ -11,7 +11,7 @@ import rules from './rules/index.mjs';
 import standalone from './standalone.mjs';
 import validateOptions from './utils/validateOptions.mjs';
 
-/** @type {import('stylelint')} */
+/** @type {import('stylelint').PublicApi} */
 const stylelint = Object.assign(postcssPlugin, {
 	lint: standalone,
 	rules,

diff --git a/lib/resolveConfig.cjs b/lib/resolveConfig.cjs
@@ -8,7 +8,7 @@ const createStylelint = require('./createStylelint.cjs');
 const getConfigForFile = require('./getConfigForFile.cjs');
 
 /**
- * @type {import('stylelint')['resolveConfig']}
+ * @type {import('stylelint').PublicApi['resolveConfig']}
  */
 async function resolveConfig(
 	filePath,

diff --git a/lib/resolveConfig.mjs b/lib/resolveConfig.mjs
@@ -5,7 +5,7 @@ import createStylelint from './createStylelint.mjs';
 import getConfigForFile from './getConfigForFile.mjs';
 
 /**
- * @type {import('stylelint')['resolveConfig']}
+ * @type {import('stylelint').PublicApi['resolveConfig']}
  */
 export default async function resolveConfig(
 	filePath,

diff --git a/lib/resolveCustomFormatter.cjs b/lib/resolveCustomFormatter.cjs
@@ -7,7 +7,6 @@ const node_fs = require('node:fs');
 const node_path = require('node:path');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
 const require$1 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('lib/resolveCustomFormatter.cjs', document.baseURI).href)));
 
 /**

diff --git a/lib/resolveCustomFormatter.mjs b/lib/resolveCustomFormatter.mjs
@@ -1,5 +1,5 @@
 import { createRequire } from 'node:module';
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+
 const require = createRequire(import.meta.url);
 
 import { existsSync } from 'node:fs';

diff --git a/lib/rules/color-named/colordUtils.cjs b/lib/rules/color-named/colordUtils.cjs
@@ -33,7 +33,8 @@ const colord = colord$1.colord;
 /**
  * Parses a valid hwb with comma CSS color function
  * https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb()#syntax
- * @type {import('colord/types').ParseFunction<string>}
+ * @param {string} input
+ * @returns {import('colord').RgbaColor | null}
  */
 function parseHwbWithCommaString(input) {
 	input = input.toLowerCase();
@@ -62,7 +63,8 @@ function parseHwbWithCommaString(input) {
 
 /**
  * Parses a valid gray() CSS color function
- * @type {import('colord/types').ParseFunction<string>}
+ * @param {string} input
+ * @returns {import('colord').RgbaColor | null}
  */
 function parseGrayString(input) {
 	input = input.toLowerCase();
@@ -84,7 +86,7 @@ function parseGrayString(input) {
 	}
 
 	/**
-	 * @type {import('colord/types').LabColor | import('colord/types').LabaColor}
+	 * @type {import('colord').LabColor | import('colord').LabaColor}
 	 */
 	let colorObject = {
 		l: Number(lightnessWithUnit.number),

diff --git a/lib/rules/color-named/colordUtils.mjs b/lib/rules/color-named/colordUtils.mjs
@@ -31,7 +31,8 @@ export const colord = colord_;
 /**
  * Parses a valid hwb with comma CSS color function
  * https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb()#syntax
- * @type {import('colord/types').ParseFunction<string>}
+ * @param {string} input
+ * @returns {import('colord').RgbaColor | null}
  */
 function parseHwbWithCommaString(input) {
 	input = input.toLowerCase();
@@ -60,7 +61,8 @@ function parseHwbWithCommaString(input) {
 
 /**
  * Parses a valid gray() CSS color function
- * @type {import('colord/types').ParseFunction<string>}
+ * @param {string} input
+ * @returns {import('colord').RgbaColor | null}
  */
 function parseGrayString(input) {
 	input = input.toLowerCase();
@@ -82,7 +84,7 @@ function parseGrayString(input) {
 	}
 
 	/**
-	 * @type {import('colord/types').LabColor | import('colord/types').LabaColor}
+	 * @type {import('colord').LabColor | import('colord').LabaColor}
 	 */
 	let colorObject = {
 		l: Number(lightnessWithUnit.number),

diff --git a/lib/rules/index.cjs b/lib/rules/index.cjs
@@ -4,7 +4,7 @@
 
 const _interopNamespaceDefaultOnly = e => Object.freeze({ __proto__: null, default: e });
 
-/** @type {import('stylelint').BuiltInRules} */
+/** @type {import('stylelint').PublicApi['rules']} */
 const rules = {
 	get 'alpha-value-notation'() {
 		return Promise.resolve().then(() => /*#__PURE__*/_interopNamespaceDefaultOnly(require('./alpha-value-notation/index.cjs'))).then((m) => m.default);

diff --git a/lib/rules/index.mjs b/lib/rules/index.mjs
@@ -1,4 +1,4 @@
-/** @type {import('stylelint').BuiltInRules} */
+/** @type {import('stylelint').PublicApi['rules']} */
 const rules = {
 	get 'alpha-value-notation'() {
 		return import('./alpha-value-notation/index.mjs').then((m) => m.default);

diff --git a/lib/standalone.cjs b/lib/standalone.cjs
@@ -31,7 +31,7 @@ const ALWAYS_IGNORED_GLOBS = ['**/node_modules/**'];
 /** @typedef {import('stylelint').FormatterType} FormatterType */
 
 /**
- * @type {import('stylelint')['lint']}
+ * @type {import('stylelint').PublicApi['lint']}
  */
 async function standalone({
 	allowEmptyInput,

diff --git a/lib/standalone.mjs b/lib/standalone.mjs
@@ -29,7 +29,7 @@ const ALWAYS_IGNORED_GLOBS = ['**/node_modules/**'];
 /** @typedef {import('stylelint').FormatterType} FormatterType */
 
 /**
- * @type {import('stylelint')['lint']}
+ * @type {import('stylelint').PublicApi['lint']}
  */
 export default async function standalone({
 	allowEmptyInput,

diff --git a/lib/utils/FileCache.cjs b/lib/utils/FileCache.cjs
@@ -13,7 +13,7 @@ const hash = require('./hash.cjs');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 const debug = createDebug('stylelint:file-cache');
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+
 const pkg = JSON.parse(node_fs.readFileSync(new URL('../../package.json', (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('lib/utils/FileCache.cjs', document.baseURI).href))), 'utf8'));
 
 /** @typedef {import('file-entry-cache').FileDescriptor["meta"] & { hashOfConfig?: string }} CacheMetadata */

diff --git a/lib/utils/FileCache.mjs b/lib/utils/FileCache.mjs
@@ -15,7 +15,7 @@ import getCacheFile from './getCacheFile.mjs';
 import hash from './hash.mjs';
 
 const debug = createDebug('stylelint:file-cache');
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+
 const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url), 'utf8'));
 
 /** @typedef {import('file-entry-cache').FileDescriptor["meta"] & { hashOfConfig?: string }} CacheMetadata */

diff --git a/lib/utils/mathMLTags.cjs b/lib/utils/mathMLTags.cjs
@@ -5,14 +5,14 @@
 const node_module = require('node:module');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'
 const require$1 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('lib/utils/mathMLTags.cjs', document.baseURI).href)));
 
 // NOTE: mathml-tag-names v3 is a pure ESM package,
 // so we cannot update it while supporting both ESM and CJS.
 //
 // In addition, mathml-tag-names v2 provides only a JSON file,
 // so ESM cannot import it (raises the "ERR_IMPORT_ASSERTION_TYPE_MISSING" error).
+// @ts-expect-error -- mathml-tag-names v2 doesn't have type declarations.
 const mathMLTags = require$1('mathml-tag-names');
 
 module.exports = mathMLTags;
diff --git a/lib/utils/mathMLTags.mjs b/lib/utils/mathMLTags.mjs
@@ -1,13 +1,13 @@
 import { createRequire } from 'node:module';
 
-// @ts-expect-error -- TS1343: The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'
 const require = createRequire(import.meta.url);
 
 // NOTE: mathml-tag-names v3 is a pure ESM package,
 // so we cannot update it while supporting both ESM and CJS.
 //
 // In addition, mathml-tag-names v2 provides only a JSON file,
 // so ESM cannot import it (raises the "ERR_IMPORT_ASSERTION_TYPE_MISSING" error).
+// @ts-expect-error -- mathml-tag-names v2 doesn't have type declarations.
 const mathMLTags = require('mathml-tag-names');
 
 export default mathMLTags;
diff --git a/package.json b/package.json
@@ -24,7 +24,10 @@
   "author": "stylelint",
   "exports": {
     ".": {
-      "import": "./lib/index.mjs",
+      "import": {
+        "types": "./types/stylelint/index.d.ts",
+        "default": "./lib/index.mjs"
+      },
       "require": "./lib/index.cjs"
     },
     "./package.json": "./package.json",

diff --git a/patches/is-plain-object+5.0.0.patch b/patches/is-plain-object+5.0.0.patch
@@ -0,0 +1,16 @@
+diff --git a/node_modules/is-plain-object/package.json b/node_modules/is-plain-object/package.json
+index 3ea169a..622dff4 100644
+--- a/node_modules/is-plain-object/package.json
++++ b/node_modules/is-plain-object/package.json
+@@ -25,7 +25,10 @@
+   ],
+   "exports": {
+     ".": {
+-      "import": "./dist/is-plain-object.mjs",
++      "import": {
++        "types": "./is-plain-object.d.ts",
++        "default": "./dist/is-plain-object.mjs"
++      },
+       "require": "./dist/is-plain-object.js"
+     },
+     "./package.json": "./package.json"
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,8 +1,9 @@
 {
 	"compilerOptions": {
-		"target": "ES2021",
-		"module": "commonjs",
-		"lib": ["ES2021", "DOM"],
+		"module": "Node16",
+		"moduleResolution": "Node16",
+		"target": "ES2022",
+		"lib": ["ES2022"],
 		"checkJs": true,
 		"noEmit": true,
 		"strict": true,
@@ -12,13 +13,13 @@
 		"noImplicitReturns": false,
 		"noUnusedParameters": true,
 		"noUncheckedIndexedAccess": true,
-		"resolveJsonModule": true,
+		"resolveJsonModule": false,
 		"esModuleInterop": true,
 		"skipLibCheck": false,
 		"paths": {
-			"*": ["./node_modules/@types/*", "./types/*"]
+			"stylelint": ["./types/stylelint/index.d.ts"]
 		}
 	},
-	"include": ["lib", "types", "package.json"],
-	"exclude": ["**/*.test.{js,mjs}", "**/__tests__/", "lib/**/*.cjs"]
+	"include": ["lib/**/*.mjs", "types/**/*.ts"],
+	"exclude": ["**/__tests__/**"]
 }