A collection of React Native specific linting rules for stylelint (in a form of a plugin).
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src fix a comment Dec 9, 2018
.editorconfig
.gitignore
.prettierignore
.travis.yml Drop Node.js 4.x support Jul 19, 2018
CHANGELOG.md Prepare version 2.0.1 Dec 9, 2018
LICENSE Add license file Feb 21, 2018
README.md reformat readme Jul 21, 2018
appveyor.yml Drop Node.js 4.x support Jul 19, 2018
jest-setup.js
package-lock.json
package.json Prepare version 2.0.1 Dec 9, 2018
yarn.lock update lockfiles Dec 9, 2018

README.md

stylelint-react-native

A collection of React Native specific linting rules for stylelint (in a form of a plugin).

NPM version Build Status Build status PRs Welcome Greenkeeper badge

Installation and usage

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

yarn add stylelint stylelint-react-native --dev

or

npm install stylelint stylelint-react-native --save-dev

Create the .stylelintrc config file (or open the existing one), add stylelint-react-native to the plugins array and the rules you need to the rules list. All rules from stylelint-react-native need to be namespaced with react-native.

{
  "plugins": ["stylelint-react-native"],
  "rules": {
    "react-native/css-property-no-unknown": true
  }
}

Please refer to stylelint docs for the detailed info on using this linter plugin.

List of rules

General rules

  • font-weight-no-ignored-values: Disallow valid font-weight values that work on iOS, but are ignored and get mapped to normal or bold weight on Android.

css- rules (for tools like styled-components)

These rules are meant to be used with tools that allow you to write CSS when using React Native, e.g. styled-components, React Native CSS modules, etc.


style- rules (for React Native's built-in styling)

These rules are meant to be used when styling with React Native's built-in styling, or with tools that use React Native's default styling.

Help out

There work on the plugin's rules is still in progress, so if you feel like it, you're welcome to help out in any of these (the plugin follows stylelint guidelines so most part of this is based on its docs):

  • Create, enhance, and debug rules (see stylelint's guide to "Working on rules").
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas on new rules, or for how to improve the existing ones, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Work on improving performance of rules.
  • Contribute to stylelint
  • Spread the word.

We communicate via issues and pull requests.

There is also stackoverflow, which would be the preferred QA forum.