Add TypeScript type definitions

CHANGELOG.md

@@ -20,6 +20,7 @@ All notable changes to this project are documented in this file.
 - Added: `ignoreFunctions: []` to `length-zero-no-unit` ([#5314](https://github.com/stylelint/stylelint/pull/5314)).
 - Added: `ignoreAtRules: []` to `no-invalid-position-at-import` ([#5520](https://github.com/stylelint/stylelint/pull/5520)).
 - Added: `ignoreProperties: []` to `number-max-precision` ([#5421](https://github.com/stylelint/stylelint/pull/5421)).
+- Added: Typescript type definitions ([#5582](https://github.com/stylelint/stylelint/pull/5582)).
 - Fixed: "No files matching the pattern" when using backslash paths on Windows ([#5386](https://github.com/stylelint/stylelint/pull/5386)).
 - Fixed: `function-url-quotes` violation messages to be consistent with other `*-quotes` rules ([#5488](https://github.com/stylelint/stylelint/pull/5488)).
 - Fixed: `length-zero-no-unit` false positives for `flex` property ([#5315](https://github.com/stylelint/stylelint/pull/5315)).

docs/developer-guide/formatters.md

@@ -45,7 +45,7 @@ Where the first argument (`results`) is an array of stylelint result objects (ty
 }
 ```
 
-And the second argument (`returnValue`) is an object (type `StylelintStandaloneReturnValue`) with one or more of the following keys:
+And the second argument (`returnValue`) is an object (type `LinterResult`) with one or more of the following keys:
 
 ```js
 {

lib/augmentConfig.js

@@ -8,14 +8,14 @@ const normalizeAllRuleSettings = require('./normalizeAllRuleSettings');
 const normalizePath = require('normalize-path');
 const path = require('path');
 
-/** @typedef {import('stylelint').StylelintConfigPlugins} StylelintConfigPlugins */
-/** @typedef {import('stylelint').StylelintConfigProcessor} StylelintConfigProcessor */
-/** @typedef {import('stylelint').StylelintConfigProcessors} StylelintConfigProcessors */
-/** @typedef {import('stylelint').StylelintConfigRules} StylelintConfigRules */
-/** @typedef {import('stylelint').StylelintConfigOverride} StylelintConfigOverride */
-/** @typedef {import('stylelint').StylelintInternalApi} StylelintInternalApi */
-/** @typedef {import('stylelint').StylelintConfig} StylelintConfig */
-/** @typedef {import('stylelint').StylelintCosmiconfigResult} StylelintCosmiconfigResult */
+/** @typedef {import('stylelint').ConfigPlugins} StylelintConfigPlugins */
+/** @typedef {import('stylelint').ConfigProcessor} StylelintConfigProcessor */
+/** @typedef {import('stylelint').ConfigProcessors} StylelintConfigProcessors */
+/** @typedef {import('stylelint').ConfigRules} StylelintConfigRules */
+/** @typedef {import('stylelint').ConfigOverride} StylelintConfigOverride */
+/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
+/** @typedef {import('stylelint').Config} StylelintConfig */
+/** @typedef {import('stylelint').CosmiconfigResult} StylelintCosmiconfigResult */
 
 /**
  * - Merges config and stylelint options

lib/createPartialStylelintResult.js

@@ -1,11 +1,11 @@
 'use strict';
 
 /** @typedef {import('stylelint').PostcssResult} PostcssResult */
-/** @typedef {import('stylelint').StylelintResult} StylelintResult */
+/** @typedef {import('stylelint').LintResult} StylelintResult */
 
 /**
  * @param {PostcssResult} [postcssResult]
- * @param {import('stylelint').StylelintCssSyntaxError} [cssSyntaxError]
+ * @param {import('stylelint').CssSyntaxError} [cssSyntaxError]
  * @return {StylelintResult}
  */
 module.exports = function (postcssResult, cssSyntaxError) {

lib/createPlugin.js

@@ -1,15 +1,17 @@
 'use strict';
 
-/** @typedef {import('stylelint').StylelintRule} StylelintRule */
+/** @typedef {import('stylelint').Rule} StylelintRule */
 
 /**
  * @param {string} ruleName
  * @param {StylelintRule} rule
  * @returns {{ruleName: string, rule: StylelintRule}}
  */
-module.exports = function (ruleName, rule) {
+function createPlugin(ruleName, rule) {
 	return {
 		ruleName,
 		rule,
 	};
-};
+}
+
+module.exports = /** @type {typeof import('stylelint').createPlugin} */ (createPlugin);

lib/createStylelint.js

@@ -11,19 +11,19 @@ const { cosmiconfig } = require('cosmiconfig');
 const IS_TEST = process.env.NODE_ENV === 'test';
 const STOP_DIR = IS_TEST ? process.cwd() : undefined;
 
-/** @typedef {import('stylelint').StylelintInternalApi} StylelintInternalApi */
+/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
 
 /**
  * The stylelint "internal API" is passed among functions
  * so that methods on a stylelint instance can invoke
  * each other while sharing options and caches.
  *
- * @param {import('stylelint').StylelintStandaloneOptions} options
+ * @param {import('stylelint').LinterOptions} options
  * @returns {StylelintInternalApi}
  */
-module.exports = function createStylelint(options = {}) {
+function createStylelint(options = {}) {
 	/** @type {StylelintInternalApi} */
-	// @ts-expect-error -- TS2740: Type '{ _options: StylelintStandaloneOptions; }' is missing the following properties from type 'StylelintInternalApi'
+	// @ts-expect-error -- TS2740: Type '{ _options: LinterOptions; }' is missing the following properties from type 'InternalApi'
 	const stylelint = { _options: options };
 
 	stylelint._extendExplorer = cosmiconfig('', {
@@ -41,4 +41,6 @@ module.exports = function createStylelint(options = {}) {
 	stylelint.isPathIgnored = isPathIgnored.bind(null, stylelint);
 
 	return stylelint;
-};
+}
+
+module.exports = /** @type {typeof import('stylelint').createLinter} */ (createStylelint);

lib/createStylelintResult.js

@@ -3,13 +3,13 @@
 const createPartialStylelintResult = require('./createPartialStylelintResult');
 
 /** @typedef {import('stylelint').PostcssResult} PostcssResult */
-/** @typedef {import('stylelint').StylelintResult} StylelintResult */
+/** @typedef {import('stylelint').LintResult} StylelintResult */
 
 /**
- * @param {import('stylelint').StylelintInternalApi} stylelint
+ * @param {import('stylelint').InternalApi} stylelint
  * @param {PostcssResult} [postcssResult]
  * @param {string} [filePath]
- * @param {import('stylelint').StylelintCssSyntaxError} [cssSyntaxError]
+ * @param {import('stylelint').CssSyntaxError} [cssSyntaxError]
  * @return {Promise<StylelintResult>}
  */
 module.exports = async function createStylelintResult(

lib/descriptionlessDisables.js

@@ -6,10 +6,10 @@ const validateDisableSettings = require('./validateDisableSettings');
 /** @typedef {import('postcss').Comment} PostcssComment */
 /** @typedef {import('stylelint').RangeType} RangeType */
 /** @typedef {import('stylelint').DisableReportRange} DisableReportRange */
-/** @typedef {import('stylelint').StylelintDisableOptionsReport} StylelintDisableOptionsReport */
+/** @typedef {import('stylelint').DisableOptionsReport} StylelintDisableOptionsReport */
 
 /**
- * @param {import('stylelint').StylelintResult[]} results
+ * @param {import('stylelint').LintResult[]} results
  */
 module.exports = function descriptionlessDisables(results) {
 	results.forEach((result) => {

lib/formatters/index.js

@@ -2,11 +2,14 @@
 
 const importLazy = require('import-lazy');
 
-module.exports = {
+/** @type {typeof import('stylelint').formatters} */
+const formatters = {
 	compact: importLazy(() => require('./compactFormatter'))('compactFormatter'),
 	json: importLazy(() => require('./jsonFormatter'))('jsonFormatter'),
 	string: importLazy(() => require('./stringFormatter'))('stringFormatter'),
 	tap: importLazy(() => require('./tapFormatter'))('tapFormatter'),
 	unix: importLazy(() => require('./unixFormatter'))('unixFormatter'),
 	verbose: importLazy(() => require('./verboseFormatter'))('verboseFormatter'),
 };
+
+module.exports = formatters;

lib/formatters/stringFormatter.js

@@ -30,7 +30,7 @@ const symbols = {
 };
 
 /**
- * @param {import('stylelint').StylelintResult[]} results
+ * @param {import('stylelint').LintResult[]} results
  * @returns {string}
  */
 function deprecationsFormatter(results) {
@@ -60,7 +60,7 @@ function deprecationsFormatter(results) {
 }
 
 /**
- * @param {import('stylelint').StylelintResult[]} results
+ * @param {import('stylelint').LintResult[]} results
  * @return {string}
  */
 function invalidOptionsFormatter(results) {
@@ -108,7 +108,7 @@ function getMessageWidth(columnWidths) {
 }
 
 /**
- * @param {import('stylelint').StylelintWarning[]} messages
+ * @param {import('stylelint').Warning[]} messages
  * @param {string} source
  * @return {string}
  */
@@ -161,7 +161,7 @@ function formatter(messages, source) {
 	}
 
 	/**
-	 * @param {import('stylelint').StylelintWarning} message
+	 * @param {import('stylelint').Warning} message
 	 * @return {string}
 	 */
 	function formatMessageText(message) {

lib/formatters/verboseFormatter.js

@@ -4,7 +4,7 @@ const stringFormatter = require('./stringFormatter');
 const { underline, red, yellow, dim, green } = require('picocolors');
 
 /** @typedef {import('stylelint').Formatter} Formatter */
-/** @typedef {import('stylelint').StylelintWarning} StylelintWarning */
+/** @typedef {import('stylelint').Warning} StylelintWarning */
 
 /**
  * @type {Formatter}

lib/getConfigForFile.js

@@ -8,9 +8,9 @@ const { cosmiconfig } = require('cosmiconfig');
 const IS_TEST = process.env.NODE_ENV === 'test';
 const STOP_DIR = IS_TEST ? process.cwd() : undefined;
 
-/** @typedef {import('stylelint').StylelintInternalApi} StylelintInternalApi */
-/** @typedef {import('stylelint').StylelintConfig} StylelintConfig */
-/** @typedef {import('stylelint').StylelintCosmiconfigResult} StylelintCosmiconfigResult */
+/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
+/** @typedef {import('stylelint').Config} StylelintConfig */
+/** @typedef {import('stylelint').CosmiconfigResult} StylelintCosmiconfigResult */
 
 /**
  * @param {StylelintInternalApi} stylelint

lib/getPostcssResult.js

@@ -9,7 +9,7 @@ const { promises: fs } = require('fs');
 /** @typedef {import('postcss').Syntax} Syntax */
 /** @typedef {import('stylelint').CustomSyntax} CustomSyntax */
 /** @typedef {import('stylelint').GetPostcssOptions} GetPostcssOptions */
-/** @typedef {import('stylelint').StylelintInternalApi} StylelintInternalApi */
+/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
 
 const postcssProcessor = postcss();
 

lib/index.js

@@ -11,20 +11,19 @@ const rules = require('./rules');
 const standalone = require('./standalone');
 const validateOptions = require('./utils/validateOptions');
 
-/**
- * @type {import('postcss').PluginCreator<import('stylelint').PostcssPluginOptions> & import('stylelint').StylelintPublicAPI}
- */
-module.exports = postcssPlugin;
+/** @type {import('stylelint').PublicApi} */
+const stylelint = Object.assign(postcssPlugin, {
+	lint: standalone,
+	rules,
+	formatters,
+	createPlugin,
+	createLinter: createStylelint,
+	utils: {
+		report,
+		ruleMessages,
+		validateOptions,
+		checkAgainstRule,
+	},
+});
 
-module.exports.utils = {
-	report,
-	ruleMessages,
-	validateOptions,
-	checkAgainstRule,
-};
-
-module.exports.lint = standalone;
-module.exports.rules = rules;
-module.exports.formatters = formatters;
-module.exports.createPlugin = createPlugin;
-module.exports.createLinter = createStylelint;
+module.exports = stylelint;

lib/invalidScopeDisables.js

@@ -6,7 +6,7 @@ const validateDisableSettings = require('./validateDisableSettings');
 /** @typedef {import('stylelint').RangeType} RangeType */
 
 /**
- * @param {import('stylelint').StylelintResult[]} results
+ * @param {import('stylelint').LintResult[]} results
  */
 module.exports = function invalidScopeDisables(results) {
 	results.forEach((result) => {

lib/isPathIgnored.js

@@ -10,7 +10,7 @@ const path = require('path');
  * To find out if a path is ignored, we need to load the config,
  * which may have an ignoreFiles property. We then check the path
  * against these.
- * @param {import('stylelint').StylelintInternalApi} stylelint
+ * @param {import('stylelint').InternalApi} stylelint
  * @param {string} [filePath]
  * @return {Promise<boolean>}
  */

lib/lintPostcssResult.js

@@ -5,12 +5,12 @@ const getOsEol = require('./utils/getOsEol');
 const reportUnknownRuleNames = require('./reportUnknownRuleNames');
 const rulesOrder = require('./rules');
 
-/** @typedef {import('stylelint').StylelintStandaloneOptions} StylelintStandaloneOptions */
+/** @typedef {import('stylelint').LinterOptions} LinterOptions */
 /** @typedef {import('stylelint').PostcssResult} PostcssResult */
-/** @typedef {import('stylelint').StylelintConfig} StylelintConfig */
+/** @typedef {import('stylelint').Config} StylelintConfig */
 
 /**
- * @param {StylelintStandaloneOptions} stylelintOptions
+ * @param {LinterOptions} stylelintOptions
  * @param {PostcssResult} postcssResult
  * @param {StylelintConfig} config
  * @returns {Promise<any>}

lib/lintSource.js

@@ -4,7 +4,7 @@ const isPathNotFoundError = require('./utils/isPathNotFoundError');
 const lintPostcssResult = require('./lintPostcssResult');
 const path = require('path');
 
-/** @typedef {import('stylelint').StylelintInternalApi} StylelintInternalApi */
+/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
 /** @typedef {import('stylelint').GetLintSourceOptions} Options */
 /** @typedef {import('postcss').Result} Result */
 /** @typedef {import('stylelint').PostcssResult} PostcssResult */

lib/needlessDisables.js

@@ -10,7 +10,7 @@ const validateDisableSettings = require('./validateDisableSettings');
 /** @typedef {import('stylelint').DisableReportRange} DisableReportRange */
 
 /**
- * @param {import('stylelint').StylelintResult[]} results
+ * @param {import('stylelint').LintResult[]} results
  */
 module.exports = function needlessDisables(results) {
 	results.forEach((result) => {

lib/normalizeAllRuleSettings.js

@@ -3,8 +3,8 @@
 const normalizeRuleSettings = require('./normalizeRuleSettings');
 const rules = require('./rules');
 
-/** @typedef {import('stylelint').StylelintConfigRules} StylelintConfigRules */
-/** @typedef {import('stylelint').StylelintConfig} StylelintConfig */
+/** @typedef {import('stylelint').ConfigRules} StylelintConfigRules */
+/** @typedef {import('stylelint').Config} StylelintConfig */
 
 /**
  * @param {StylelintConfig} config

lib/normalizeRuleSettings.js

@@ -18,7 +18,7 @@ const { isPlainObject } = require('is-plain-object');
  * null is returned
  * @template T
  * @template {Object} O
- * @param {import('stylelint').StylelintConfigRuleSettings<T, O>} rawSettings
+ * @param {import('stylelint').ConfigRuleSettings<T, O>} rawSettings
  * @param {string} ruleName
  * @param {boolean} [primaryOptionArray] If primaryOptionArray is not provided, we try to get it from the rules themselves, which will not work for plugins
  * @return {[T] | [T, O] | null}

lib/postcssPlugin.js

@@ -4,7 +4,7 @@ const createStylelint = require('./createStylelint');
 const path = require('path');
 
 /** @typedef {import('stylelint').PostcssPluginOptions} PostcssPluginOptions */
-/** @typedef {import('stylelint').StylelintConfig} StylelintConfig */
+/** @typedef {import('stylelint').Config} StylelintConfig */
 
 /**
  * @type {import('postcss').PluginCreator<PostcssPluginOptions>}

lib/prepareReturnValue.js

@@ -6,16 +6,16 @@ const needlessDisables = require('./needlessDisables');
 const reportDisables = require('./reportDisables');
 
 /** @typedef {import('stylelint').Formatter} Formatter */
-/** @typedef {import('stylelint').StylelintResult} StylelintResult */
-/** @typedef {import('stylelint').StylelintStandaloneOptions["maxWarnings"]} maxWarnings */
-/** @typedef {import('stylelint').StylelintStandaloneReturnValue} StylelintStandaloneReturnValue */
+/** @typedef {import('stylelint').LintResult} StylelintResult */
+/** @typedef {import('stylelint').LinterOptions["maxWarnings"]} maxWarnings */
+/** @typedef {import('stylelint').LinterResult} LinterResult */
 
 /**
  * @param {StylelintResult[]} stylelintResults
  * @param {maxWarnings} maxWarnings
  * @param {Formatter} formatter
  *
- * @returns {StylelintStandaloneReturnValue}
+ * @returns {LinterResult}
  */
 function prepareReturnValue(stylelintResults, maxWarnings, formatter) {
 	reportDisables(stylelintResults);
@@ -30,7 +30,7 @@ function prepareReturnValue(stylelintResults, maxWarnings, formatter) {
 			result.warnings.some((warning) => warning.severity === 'error'),
 	);
 
-	/** @type {StylelintStandaloneReturnValue} */
+	/** @type {LinterResult} */
 	const returnValue = {
 		errored,
 		results: [],

lib/printConfig.js

@@ -4,10 +4,10 @@ const createStylelint = require('./createStylelint');
 const globby = require('globby');
 const path = require('path');
 
-/** @typedef {import('stylelint').StylelintConfig} StylelintConfig */
+/** @typedef {import('stylelint').Config} StylelintConfig */
 
 /**
- * @param {import('stylelint').StylelintStandaloneOptions} options
+ * @param {import('stylelint').LinterOptions} options
  * @returns {Promise<StylelintConfig | null>}
  */
 module.exports = function printConfig({

lib/reportDisables.js

@@ -2,8 +2,8 @@
 
 /** @typedef {import('stylelint').RangeType} RangeType */
 /** @typedef {import('stylelint').DisableReportRange} DisabledRange */
-/** @typedef {import('stylelint').StylelintResult} StylelintResult */
-/** @typedef {import('stylelint').StylelintConfigRuleSettings<any, Object>} StylelintConfigRuleSettings */
+/** @typedef {import('stylelint').LintResult} StylelintResult */
+/** @typedef {import('stylelint').ConfigRuleSettings<any, Object>} StylelintConfigRuleSettings */
 
 /**
  * Returns a report describing which `results` (if any) contain disabled ranges

lib/rules/alpha-value-notation/index.js

@@ -21,7 +21,7 @@ const messages = ruleMessages(ruleName, {
 const ALPHA_PROPS = new Set(['opacity', 'shape-image-threshold']);
 const ALPHA_FUNCS = new Set(['hsl', 'hsla', 'hwb', 'lab', 'lch', 'rgb', 'rgba']);
 
-/** @type {import('stylelint').StylelintRule} */
+/** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions, context) => {
 	return (root, result) => {
 		const validOptions = validateOptions(