Ignore needless disables for the Stylelint Polaris layout category

.changeset/tidy-laws-sit.md

@@ -0,0 +1,5 @@
+---
+'@shopify/stylelint-polaris': patch
+---
+
+Ignored needless disables for layout category and added meta URL to error message

stylelint-polaris/index.js

@@ -472,7 +472,15 @@ const stylelintPolarisCoverageOptions = {
 /** @type {import('stylelint').Config} */
 module.exports = {
   customSyntax: 'postcss-scss',
-  reportDescriptionlessDisables: true,
+  reportNeedlessDisables: [
+    true,
+    {
+      // Report needless disables for all rules except layout coverage rules
+      // Note: This doesn't affect the default Stylelint behavior/reporting
+      // and is only need because we dynamically create these rule names
+      except: /^polaris\/layout\/.+$/,
+    },
+  ],
   reportInvalidScopeDisables: [
     true,
     {

stylelint-polaris/plugins/coverage/index.js

@@ -111,8 +111,8 @@ module.exports = stylelint.createPlugin(
             result.stylelint.ruleMetadata[ruleName] = meta;
 
             const message = appendedMessage
-              ? `${warningText} - ${appendedMessage}`
-              : warningText;
+              ? `${warningText} - ${appendedMessage} - ${meta.url}`
+              : `${warningText} - ${meta.url}`;
 
             stylelint.utils.report({
               result,

stylelint-polaris/plugins/coverage/index.test.js

@@ -41,23 +41,25 @@ testRule({
       code: '.class {color: #bad;}',
       description: 'Overrides appended category rule warning text (string)',
       message:
-        'Unexpected hex color "#bad" - Appended Stylelint rule config message',
+        'Unexpected hex color "#bad" - Appended Stylelint rule config message - https://polaris.shopify.com/tools/stylelint-polaris/rules/colors-color-no-hex',
     },
     {
       code: '.class {color: red;}',
       description: 'Appends message to category rule warning text',
       message:
-        'Unexpected named color "red" - Appended category rule config message',
+        'Unexpected named color "red" - Appended category rule config message - https://polaris.shopify.com/tools/stylelint-polaris/rules/colors-color-named',
     },
     {
       code: '@keyframes foo {}',
       description: 'Uses disallowed at-rule (built-in rule)',
-      message: 'Unexpected at-rule "keyframes"',
+      message:
+        'Unexpected at-rule "keyframes" - https://polaris.shopify.com/tools/stylelint-polaris/rules/motion-at-rule-disallowed-list',
     },
     {
       code: '.class {color: var(--p-legacy-var);}',
       description: 'Uses disallowed legacy variable (custom rule)',
-      message: 'Unexpected disallowed value "--p-legacy-var"',
+      message:
+        'Unexpected disallowed value "--p-legacy-var" - https://polaris.shopify.com/tools/stylelint-polaris/rules/legacy-polaris-global-disallowed-list',
     },
   ],
 });