123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138 |
- 'use strict';
- const assignDisabledRanges = require('./assignDisabledRanges');
- const getOsEol = require('./utils/getOsEol');
- const reportUnknownRuleNames = require('./reportUnknownRuleNames');
- const rules = require('./rules');
- const getStylelintRule = require('./utils/getStylelintRule');
- /** @typedef {import('stylelint').LinterOptions} LinterOptions */
- /** @typedef {import('stylelint').PostcssResult} PostcssResult */
- /** @typedef {import('stylelint').Config} StylelintConfig */
- /**
- * @param {LinterOptions} stylelintOptions
- * @param {PostcssResult} postcssResult
- * @param {StylelintConfig} config
- * @returns {Promise<any>}
- */
- function lintPostcssResult(stylelintOptions, postcssResult, config) {
- postcssResult.stylelint.ruleSeverities = {};
- postcssResult.stylelint.customMessages = {};
- postcssResult.stylelint.ruleMetadata = {};
- postcssResult.stylelint.stylelintError = false;
- postcssResult.stylelint.stylelintWarning = false;
- postcssResult.stylelint.quiet = config.quiet;
- postcssResult.stylelint.config = config;
- /** @type {string | undefined} */
- let newline;
- const postcssDoc = postcssResult.root;
- if (postcssDoc) {
- if (!('type' in postcssDoc)) {
- throw new Error('Unexpected Postcss root object!');
- }
- const newlineMatch = postcssDoc.source && postcssDoc.source.input.css.match(/\r?\n/);
- newline = newlineMatch ? newlineMatch[0] : getOsEol();
- assignDisabledRanges(postcssDoc, postcssResult);
- }
- const isFileFixCompatible = isFixCompatible(postcssResult);
- if (!isFileFixCompatible) {
- postcssResult.stylelint.disableWritingFix = true;
- }
- const postcssRoots = /** @type {import('postcss').Root[]} */ (
- postcssDoc && postcssDoc.constructor.name === 'Document' ? postcssDoc.nodes : [postcssDoc]
- );
- // Promises for the rules. Although the rule code runs synchronously now,
- // the use of Promises makes it compatible with the possibility of async
- // rules down the line.
- /** @type {Array<Promise<any>>} */
- const performRules = [];
- const rulesOrder = Object.keys(rules);
- const ruleNames = config.rules
- ? Object.keys(config.rules).sort((a, b) => rulesOrder.indexOf(a) - rulesOrder.indexOf(b))
- : [];
- for (const ruleName of ruleNames) {
- const ruleFunction = getStylelintRule(ruleName, config);
- if (ruleFunction === undefined) {
- performRules.push(
- Promise.all(
- postcssRoots.map((postcssRoot) =>
- reportUnknownRuleNames(ruleName, postcssRoot, postcssResult),
- ),
- ),
- );
- continue;
- }
- const ruleSettings = config.rules && config.rules[ruleName];
- if (ruleSettings === null || ruleSettings[0] === null) {
- continue;
- }
- const primaryOption = ruleSettings[0];
- const secondaryOptions = ruleSettings[1];
- // Log the rule's severity in the PostCSS result
- const defaultSeverity = config.defaultSeverity || 'error';
- // disableFix in secondary option
- const disableFix = (secondaryOptions && secondaryOptions.disableFix === true) || false;
- if (disableFix) {
- postcssResult.stylelint.ruleDisableFix = true;
- }
- postcssResult.stylelint.ruleSeverities[ruleName] =
- (secondaryOptions && secondaryOptions.severity) || defaultSeverity;
- postcssResult.stylelint.customMessages[ruleName] = secondaryOptions && secondaryOptions.message;
- postcssResult.stylelint.ruleMetadata[ruleName] = ruleFunction.meta || {};
- performRules.push(
- Promise.all(
- postcssRoots.map((postcssRoot) =>
- ruleFunction(primaryOption, secondaryOptions, {
- fix:
- !disableFix &&
- stylelintOptions.fix &&
- // Next two conditionals are temporary measures until #2643 is resolved
- isFileFixCompatible &&
- !postcssResult.stylelint.disabledRanges[ruleName],
- newline,
- })(postcssRoot, postcssResult),
- ),
- ),
- );
- }
- return Promise.all(performRules);
- }
- /**
- * There are currently some bugs in the autofixer of Stylelint.
- * The autofixer does not yet adhere to stylelint-disable comments, so if there are disabled
- * ranges we can not autofix this document. More info in issue #2643.
- *
- * @param {PostcssResult} postcssResult
- * @returns {boolean}
- */
- function isFixCompatible({ stylelint }) {
- // Check for issue #2643
- if (stylelint.disabledRanges.all && stylelint.disabledRanges.all.length) return false;
- return true;
- }
- module.exports = lintPostcssResult;
|