/ StyleSheet

Shareable stylelint config for React Native CSS modules

Shareable stylelint config for React Native CSS modules

stylelint-config-react-native-css-modules

Shareable stylelint config for React Native CSS modules.

Installation and usage

Install stylelint-config-react-native-css-modules (and stylelint + stylelint-react-native, if you haven't done so yet):

yarn add stylelint stylelint-react-native stylelint-config-react-native-css-modules --dev

or

npm install stylelint stylelint-react-native stylelint-config-react-native-css-modules --save-dev

Create the .stylelintrc config file (or open the existing one) and extend stylelint-config-react-native-css-modules config.

{
  "extends": "stylelint-config-react-native-css-modules",
  "rules": {
    "selector-class-pattern": "^[a-z][a-zA-Z0-9]*$"
  }
}

Custom settings

The config enables by default warnings for at-rules, units, CSS selectors that are not compatible with React Native CSS modules.

If you want to turn off the warnings, you can use the following config:

{
  "extends": "stylelint-config-react-native-css-modules",
  "rules": {
    "react-native/font-weight-no-ignored-values": null,
    "at-rule-blacklist": null,
    "function-blacklist": null,
    "unit-whitelist": null,
    "selector-pseudo-class-whitelist": null,
    "selector-max-universal": null,
    "selector-max-attribute": null,
    "selector-max-type": null,
    "selector-max-combinators": null,
    "selector-max-id": null
  }
}

If you want to change the at-rule, unit, and CSS selector warnings into stylelint errors (e.g. If you are using React Native only), you can use the following config:

{
  "extends": "stylelint-config-react-native-css-modules",
  "rules": {
    "at-rule-blacklist": [
      ["keyframes", "font-face", "supports", "charset"],
      {
        "severity": "error",
        "message": "the @-rule is ignored by React Native CSS modules."
      }
    ],
    "function-blacklist": [
      [
        "linear-gradient",
        "radial-gradient",
        "repeating-linear-gradient",
        "repeating-radial-gradient",
        "calc",
        "url",
        "translate3d",
        "rotate3d",
        "matrix3d",
        "scale3d"
      ],
      {
        "severity": "error",
        "message": "the function is ignored by React Native CSS modules."
      }
    ],
    "unit-whitelist": [
      ["px", "rem", "deg", "%", "vh", "vw", "vmin", "vmax"],
      {
        "severity": "error",
        "message": "the unit is ignored by React Native CSS modules."
      }
    ],
    "selector-pseudo-class-whitelist": [
      ["export", "root"],
      {
        "severity": "error",
        "message": "pseudo class selectors are ignored by React Native CSS modules."
      }
    ],
    "selector-max-universal": [
      0,
      {
        "severity": "error",
        "message": "universal selectors are ignored by React Native CSS modules."
      }
    ],
    "selector-max-attribute": [
      0,
      {
        "severity": "error",
        "message": "attribute selectors are ignored by React Native CSS modules."
      }
    ],
    "selector-max-type": [
      0,
      {
        "severity": "error",
        "message": "type selectors are ignored by React Native CSS modules."
      }
    ],
    "selector-max-combinators": [
      0,
      {
        "severity": "error",
        "message": "combinator selectors are ignored by React Native CSS modules."
      }
    ],
    "selector-max-id": [
      0,
      {
        "severity": "error",
        "message": "id selectors are ignored by React Native CSS modules."
      }
    ]
  }
}

GitHub