From 10a42b9a5b455ee8577f67d9263a385435778bf6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20=C5=BBupa?= Date: Wed, 10 May 2023 09:42:12 +0200 Subject: [PATCH] chore: update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 502fd56..e56efd1 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ In the `package.json` ``` ## Usage -- run `npm run stylelint-config-selleo init"` +- run `npm run stylelint-config-selleo init` - select appropriate extensions - type (or select default) liter scripts names @@ -32,6 +32,19 @@ In your project root directory `.stylelintrc.json` file will appear with previou In `package.json` selected linter scripts will appear. +## COMMANDS +`init` Initialize the Stylelint Selleo Config by selecting extensions +`husky-init` Init husky pre-commit check +`check-all` Check if some stylelint issues occur for all files +`check-current` Check if some stylelint issues occur for current changes +`fix-all` Run auto fix for all changed files +`fix-current` Run auto fix for currently changed files +`list-all` List all styles issues +`list-current` List styles issues for currently changed files +`help` Display help for stylelint-config-selleo + + + If you use `prettier`: Create or update existing `.prettierignore` following rule - ignore prettier for css, sccs and sass files - use stylelint by default ```