Add dev documentation on how to disable the lint rule for specific pr…

…operties
elastic · Aug 18, 2022 · abaeaa4 · abaeaa4
1 parent b4a1942
commit abaeaa4
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/scripts/eslint-plugin/css_logical_properties.js b/scripts/eslint-plugin/css_logical_properties.js
@@ -32,6 +32,12 @@ module.exports = {
         'Prefer the CSS logical value for {{ property }} - @see src/global_styling/functions/logicals.ts',
     },
     fixable: 'code',
+    // NOTE: To disable this lint rule for a single line/property within a css`` block
+    // your code must use a comment inside a template literal, e.g.:
+    // css`
+    //   color: red;
+    //   height: 40px; ${/* eslint-disable-line local/css-logical-properties */ ''}
+    // `
   },
   create: function (context) {
     return {