index.js 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. 'use strict';
  2. const eachDeclarationBlock = require('../../utils/eachDeclarationBlock');
  3. const isCustomProperty = require('../../utils/isCustomProperty');
  4. const isStandardSyntaxProperty = require('../../utils/isStandardSyntaxProperty');
  5. const optionsMatches = require('../../utils/optionsMatches');
  6. const report = require('../../utils/report');
  7. const ruleMessages = require('../../utils/ruleMessages');
  8. const validateOptions = require('../../utils/validateOptions');
  9. const { isString } = require('../../utils/validateTypes');
  10. const vendor = require('../../utils/vendor');
  11. const ruleName = 'declaration-block-no-duplicate-properties';
  12. const messages = ruleMessages(ruleName, {
  13. rejected: (property) => `Unexpected duplicate "${property}"`,
  14. });
  15. const meta = {
  16. url: 'https://stylelint.io/user-guide/rules/declaration-block-no-duplicate-properties',
  17. fixable: true,
  18. };
  19. /** @type {import('stylelint').Rule} */
  20. const rule = (primary, secondaryOptions, context) => {
  21. return (root, result) => {
  22. const validOptions = validateOptions(
  23. result,
  24. ruleName,
  25. { actual: primary },
  26. {
  27. actual: secondaryOptions,
  28. possible: {
  29. ignore: [
  30. 'consecutive-duplicates',
  31. 'consecutive-duplicates-with-different-values',
  32. 'consecutive-duplicates-with-same-prefixless-values',
  33. ],
  34. ignoreProperties: [isString],
  35. },
  36. optional: true,
  37. },
  38. );
  39. if (!validOptions) {
  40. return;
  41. }
  42. const ignoreDuplicates = optionsMatches(secondaryOptions, 'ignore', 'consecutive-duplicates');
  43. const ignoreDiffValues = optionsMatches(
  44. secondaryOptions,
  45. 'ignore',
  46. 'consecutive-duplicates-with-different-values',
  47. );
  48. const ignorePrefixlessSameValues = optionsMatches(
  49. secondaryOptions,
  50. 'ignore',
  51. 'consecutive-duplicates-with-same-prefixless-values',
  52. );
  53. eachDeclarationBlock(root, (eachDecl) => {
  54. /** @type {import('postcss').Declaration[]} */
  55. const decls = [];
  56. eachDecl((decl) => {
  57. const prop = decl.prop;
  58. const lowerProp = decl.prop.toLowerCase();
  59. const value = decl.value;
  60. const important = decl.important;
  61. if (!isStandardSyntaxProperty(prop)) {
  62. return;
  63. }
  64. if (isCustomProperty(prop)) {
  65. return;
  66. }
  67. // Return early if the property is to be ignored
  68. if (optionsMatches(secondaryOptions, 'ignoreProperties', prop)) {
  69. return;
  70. }
  71. // Ignore the src property as commonly duplicated in at-fontface
  72. if (lowerProp === 'src') {
  73. return;
  74. }
  75. const indexDuplicate = decls.findIndex((d) => d.prop.toLowerCase() === lowerProp);
  76. if (indexDuplicate === -1) {
  77. decls.push(decl);
  78. }
  79. const duplicateDecl = decls[indexDuplicate];
  80. if (!duplicateDecl) {
  81. return;
  82. }
  83. const duplicateValue = duplicateDecl.value || '';
  84. const duplicateImportant = duplicateDecl.important || false;
  85. const duplicateIsMoreImportant = !important && duplicateImportant;
  86. const duplicatesAreConsecutive = indexDuplicate === decls.length - 1;
  87. const unprefixedDuplicatesAreEqual =
  88. vendor.unprefixed(value) === vendor.unprefixed(duplicateValue);
  89. const fixOrReport = () => {
  90. if (!context.fix) {
  91. return report({
  92. message: messages.rejected,
  93. messageArgs: [prop],
  94. node: decl,
  95. result,
  96. ruleName,
  97. word: prop,
  98. });
  99. }
  100. if (duplicateIsMoreImportant) {
  101. return decl.remove();
  102. }
  103. return duplicateDecl.remove();
  104. };
  105. if (ignoreDiffValues || ignorePrefixlessSameValues) {
  106. if (
  107. !duplicatesAreConsecutive ||
  108. (ignorePrefixlessSameValues && !unprefixedDuplicatesAreEqual)
  109. ) {
  110. fixOrReport();
  111. }
  112. if (value !== duplicateValue) {
  113. return;
  114. }
  115. if (context.fix) {
  116. return duplicateDecl.remove();
  117. }
  118. return report({
  119. message: messages.rejected,
  120. messageArgs: [prop],
  121. node: decl,
  122. result,
  123. ruleName,
  124. word: prop,
  125. });
  126. }
  127. if (ignoreDuplicates && duplicatesAreConsecutive) {
  128. return;
  129. }
  130. fixOrReport();
  131. });
  132. });
  133. };
  134. };
  135. rule.ruleName = ruleName;
  136. rule.messages = messages;
  137. rule.meta = meta;
  138. module.exports = rule;