@elastic/eslint-plugin-eui 1.0.0 → 2.0.0

package/README.md

@@ -128,24 +128,6 @@ function MyComponent() {
 
 It's worth pointing out that although the examples provided are specific to EUI components, this rule applies to all JSX elements.
 
-### `@elastic/eui/prefer-css-attributes-for-eui-components`
-
-This rule warns about the use of `style` attribute and encourages to replace it with `css` attribute. Using the `css` attribute ensures better integration with Emotion's styling capabilities.
-
-#### Example
-
-The following code:
-
-```jsx
-<EuiCode style={{ color: '#dd4040' }}>This is a test</EuiCode>
-```
-
-will raise an ESLint report and suggest replacing the `style` attribute with `css`:
-
-```jsx
-<EuiCode css={{ color: '#dd4040' }}>This is a test</EuiCode>
-```
-
 ## Testing
 
 ### Running unit tests

package/lib/cjs/index.js

@@ -3,7 +3,6 @@
 var _href_or_on_click = require("./rules/href_or_on_click");
 var _no_restricted_eui_imports = require("./rules/no_restricted_eui_imports");
 var _no_css_color = require("./rules/no_css_color");
-var _prefer_css_prop_for_static_styles = require("./rules/prefer_css_prop_for_static_styles");
 /*
  * Licensed to Elasticsearch B.V. under one or more contributor
  * license agreements. See the NOTICE file distributed with
@@ -27,8 +26,7 @@ const config = {
   rules: {
     'href-or-on-click': _href_or_on_click.HrefOnClick,
     'no-restricted-eui-imports': _no_restricted_eui_imports.NoRestrictedEuiImports,
-    'no-css-color': _no_css_color.NoCssColor,
-    'prefer-css-prop-for-static-styles': _prefer_css_prop_for_static_styles.PreferCSSPropForStaticStyles
+    'no-css-color': _no_css_color.NoCssColor
   },
   configs: {
     recommended: {
@@ -36,8 +34,7 @@ const config = {
       rules: {
         '@elastic/eui/href-or-on-click': 'warn',
         '@elastic/eui/no-restricted-eui-imports': 'warn',
-        '@elastic/eui/no-css-color': 'warn',
-        '@elastic/eui/prefer-css-prop-for-static-styles': 'warn'
+        '@elastic/eui/no-css-color': 'warn'
       }
     }
   }

package/lib/esm/index.js

@@ -21,13 +21,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const href_or_on_click_1 = require("./rules/href_or_on_click");
 const no_restricted_eui_imports_1 = require("./rules/no_restricted_eui_imports");
 const no_css_color_1 = require("./rules/no_css_color");
-const prefer_css_prop_for_static_styles_1 = require("./rules/prefer_css_prop_for_static_styles");
 const config = {
     rules: {
         'href-or-on-click': href_or_on_click_1.HrefOnClick,
         'no-restricted-eui-imports': no_restricted_eui_imports_1.NoRestrictedEuiImports,
         'no-css-color': no_css_color_1.NoCssColor,
-        'prefer-css-prop-for-static-styles': prefer_css_prop_for_static_styles_1.PreferCSSPropForStaticStyles,
     },
     configs: {
         recommended: {
@@ -36,7 +34,6 @@ const config = {
                 '@elastic/eui/href-or-on-click': 'warn',
                 '@elastic/eui/no-restricted-eui-imports': 'warn',
                 '@elastic/eui/no-css-color': 'warn',
-                '@elastic/eui/prefer-css-prop-for-static-styles': 'warn',
             },
         },
     },

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;AAEH,+DAAuD;AACvD,iFAA2E;AAC3E,uDAAkD;AAClD,iGAAyF;AAEzF,MAAM,MAAM,GAAG;IACb,KAAK,EAAE;QACL,kBAAkB,EAAE,8BAAW;QAC/B,2BAA2B,EAAE,kDAAsB;QACnD,cAAc,EAAE,yBAAU;QAC1B,mCAAmC,EAAE,gEAA4B;KAClE;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,CAAC,4BAA4B,CAAC;YACvC,KAAK,EAAE;gBACL,+BAA+B,EAAE,MAAM;gBACvC,wCAAwC,EAAE,MAAM;gBAChD,2BAA2B,EAAE,MAAM;gBACnC,gDAAgD,EAAE,MAAM;aACzD;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;AAEH,+DAAuD;AACvD,iFAA2E;AAC3E,uDAAkD;AAElD,MAAM,MAAM,GAAG;IACb,KAAK,EAAE;QACL,kBAAkB,EAAE,8BAAW;QAC/B,2BAA2B,EAAE,kDAAsB;QACnD,cAAc,EAAE,yBAAU;KAC3B;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,CAAC,4BAA4B,CAAC;YACvC,KAAK,EAAE;gBACL,+BAA+B,EAAE,MAAM;gBACvC,wCAAwC,EAAE,MAAM;gBAChD,2BAA2B,EAAE,MAAM;aACpC;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/eslint-plugin-eui",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/lib/cjs/rules/prefer_css_prop_for_static_styles.d.ts

@@ -1,3 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const PreferCSSPropForStaticStyles: ESLintUtils.RuleModule<"preferCSSPropForStaticStyles", [], unknown, ESLintUtils.RuleListener>;
-//# sourceMappingURL=prefer_css_prop_for_static_styles.d.ts.map

package/lib/cjs/rules/prefer_css_prop_for_static_styles.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"prefer_css_prop_for_static_styles.d.ts","sourceRoot":"","sources":["../../../src/rules/prefer_css_prop_for_static_styles.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAY,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEjE,eAAO,MAAM,4BAA4B,+FA8DxC,CAAC"}

package/lib/cjs/rules/prefer_css_prop_for_static_styles.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PreferCSSPropForStaticStyles = void 0;
-var _utils = require("@typescript-eslint/utils");
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-const PreferCSSPropForStaticStyles = exports.PreferCSSPropForStaticStyles = _utils.ESLintUtils.RuleCreator.withoutDocs({
-  create(context) {
-    const isNamedEuiComponentRegex = /^Eui[A-Z]*/;
-    return {
-      JSXOpeningElement(node) {
-        if (node.name.type === 'JSXIdentifier' && isNamedEuiComponentRegex.test(node.name.name)) {
-          let styleAttrNode;
-          if (styleAttrNode = node.attributes.filter(attr => attr.type === 'JSXAttribute').find(attr => attr.name.name === 'style')) {
-            context.report({
-              node: styleAttrNode?.parent,
-              messageId: 'preferCSSPropForStaticStyles',
-              fix(fixer) {
-                const cssAttr = node.attributes.find(attr => attr.type === 'JSXAttribute' && attr.name.name === 'css');
-                if (cssAttr) {
-                  return null;
-                }
-                const range = styleAttrNode?.name?.range;
-                if (!range) {
-                  return null;
-                }
-                return fixer.replaceTextRange(range, 'css');
-              }
-            });
-          }
-        }
-      }
-    };
-  },
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Prefer the `css` prop for static styles in EUI components'
-    },
-    messages: {
-      preferCSSPropForStaticStyles: 'Use the `css` prop instead of `style` for static styles in EUI components to ensure better performance and consistency with EUI’s styling approach. Read more: https://emotion.sh/docs/best-practices#use-the-style-prop-for-dynamic-styles'
-    },
-    fixable: 'code',
-    schema: []
-  },
-  defaultOptions: []
-});

package/lib/esm/rules/prefer_css_prop_for_static_styles.d.ts

@@ -1,2 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const PreferCSSPropForStaticStyles: ESLintUtils.RuleModule<"preferCSSPropForStaticStyles", [], unknown, ESLintUtils.RuleListener>;

package/lib/esm/rules/prefer_css_prop_for_static_styles.js

@@ -1,67 +0,0 @@
-"use strict";
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PreferCSSPropForStaticStyles = void 0;
-const utils_1 = require("@typescript-eslint/utils");
-exports.PreferCSSPropForStaticStyles = utils_1.ESLintUtils.RuleCreator.withoutDocs({
-    create(context) {
-        const isNamedEuiComponentRegex = /^Eui[A-Z]*/;
-        return {
-            JSXOpeningElement(node) {
-                if (node.name.type === 'JSXIdentifier' &&
-                    isNamedEuiComponentRegex.test(node.name.name)) {
-                    let styleAttrNode;
-                    if ((styleAttrNode = node.attributes
-                        .filter((attr) => attr.type === 'JSXAttribute')
-                        .find((attr) => attr.name.name === 'style'))) {
-                        context.report({
-                            node: styleAttrNode?.parent,
-                            messageId: 'preferCSSPropForStaticStyles',
-                            fix(fixer) {
-                                const cssAttr = node.attributes.find((attr) => attr.type === 'JSXAttribute' && attr.name.name === 'css');
-                                if (cssAttr) {
-                                    return null;
-                                }
-                                const range = styleAttrNode?.name?.range;
-                                if (!range) {
-                                    return null;
-                                }
-                                return fixer.replaceTextRange(range, 'css');
-                            },
-                        });
-                    }
-                }
-            },
-        };
-    },
-    meta: {
-        type: 'suggestion',
-        docs: {
-            description: 'Prefer the `css` prop for static styles in EUI components',
-        },
-        messages: {
-            preferCSSPropForStaticStyles: 'Use the `css` prop instead of `style` for static styles in EUI components to ensure better performance and consistency with EUI’s styling approach. Read more: https://emotion.sh/docs/best-practices#use-the-style-prop-for-dynamic-styles',
-        },
-        fixable: 'code',
-        schema: [],
-    },
-    defaultOptions: [],
-});
-//# sourceMappingURL=prefer_css_prop_for_static_styles.js.map

package/lib/esm/rules/prefer_css_prop_for_static_styles.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"prefer_css_prop_for_static_styles.js","sourceRoot":"","sources":["../../../src/rules/prefer_css_prop_for_static_styles.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAEH,oDAAiE;AAEpD,QAAA,4BAA4B,GAAG,mBAAW,CAAC,WAAW,CAAC,WAAW,CAC7E;IACE,MAAM,CAAC,OAAO;QACZ,MAAM,wBAAwB,GAAG,YAAY,CAAC;QAE9C,OAAO;YACL,iBAAiB,CAAC,IAAgC;gBAChD,IACE,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe;oBAClC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAC7C,CAAC;oBACD,IAAI,aAAgD,CAAC;oBAErD,IACE,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU;yBAC7B,MAAM,CACL,CAAC,IAAI,EAAiC,EAAE,CACtC,IAAI,CAAC,IAAI,KAAK,cAAc,CAC/B;yBACA,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,EAC9C,CAAC;wBACD,OAAO,CAAC,MAAM,CAAC;4BACb,IAAI,EAAE,aAAa,EAAE,MAAM;4BAC3B,SAAS,EAAE,8BAA8B;4BACzC,GAAG,CAAC,KAAK;gCACP,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAClC,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,IAAI,KAAK,cAAc,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAC3D,CAAC;gCAEF,IAAI,OAAO,EAAE,CAAC;oCACZ,OAAO,IAAI,CAAC;gCACd,CAAC;gCAED,MAAM,KAAK,GAAG,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC;gCACzC,IAAI,CAAC,KAAK,EAAE,CAAC;oCACX,OAAO,IAAI,CAAC;gCACd,CAAC;gCAED,OAAO,KAAK,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;4BAC9C,CAAC;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,2DAA2D;SAC9D;QACD,QAAQ,EAAE;YACR,4BAA4B,EAC1B,6OAA6O;SAChP;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE;CACnB,CACF,CAAC"}