stylelint-config-versett

This config will help us maintain our CSS code style to be cleaner and consistent among different projects. Please read the guidelines below for both usage and development. You can find more info on stylelint here.

Usage

Installation

yarn add --dev @versett/stylelint-config-versett

or

npm install --save-dev @versett/stylelint-config-versett

You must be logged in to you Versett npm account first using npm login.

Peer Dependencies

You have to install the following peer dependency directly in your project:

yarn add --dev stylelint

Configuration

stylelint works with a config file. Here is a sample config file (/.stylelintrc.json)

{
  "extends": "@versett/stylelint-config-versett"
}

We strongly recommend against overriding the rules configured by this package. If you believe you have a good reason for overriding a rule, please create an issue on this repository and post it on the #developers channel on Slack. If the team agrees, we will change the rule in the package so all projects can benefit from it.

Running

Add the following script to your package.json and then run it using yarn lint (or npm run lint):

"lint" : "stylelint \"src/**/*.css\" \"src/**/*.scss\""

(you can change the paths to the paths you use in your project)

Development

To get started on development run these commands:

nvm use
yarn

For testing purposes you can use yarn link (or npm link):

cd stylelint-config-versett
yarn link

then

cd my-project
yarn link @versett/stylelint-config-versett

After that, a symbolic link is added to node_modules of the plugin directory.

References

There are multiple stylelint configurations we have used as references which are listed below.

• stylelint-config-recommended
• stylelint-config-standard
• stylelint-config-sass-guidelines

please refer to their repos for rules and configurations.

Contributing

Please read this Quip Documentation for details on our code of conduct, and the process for submitting pull requests.

Versioning

Versioning is done automatically by versett-devtools when a branch is merged with master and our CI/CD runs.

Need help?

Post on the #internal-tools channel on Slack or create an issue.

Authors

• Soroush Karimi
• Mehran Dabestani
• Hanie Gharedaghi

Acknowledgments

• Thanks to all Versett superheroes!