sui-precommit

sui-precommit

Effortless SUI precommit rules integration in your project

Installs commit hook to ensure quality rules are executed before any commit (test, linting, consistent commit, etc).

It provides:

• Assurance that all code is compliant with Adevinta's standards.
• Centralize precommit rule: quality rules can be improved and seemlessly inherited by all projects.

Installation

$ npm install @s-ui/precommit --save-dev

CLI

$ sui-precommit run

Executes all rules:

• sui-lint for both js and sass
• Your own test command from package.json and your own "test" command.

⚠️ Caution!

Only staged files will be linted, for performance purpose.

$ sui-precommit install

Installs sui-precommit as git pre-commit hook.

Executes 4 actions:

1. Install husky (if not installed yet) to your project.
2. If you already have a husky deprecated config, migrate it to the new one.
3. Add sui-precommit run as husky's precommit script.
4. Add sui-lint as npm lint script command so you can execute linting separately. Note: If lint script is already present, it doesn't overwrite it (as some packages might not need executing sui-lint sass or sui-lint js).

Your package.json might be altered like that:

{
  "scripts": {
    "lint": "sui-lint js && sui-lint sass"
  },
  "husky": {
    "hooks": {
      "pre-commit": "sui-precommit run"
    }
  },
  "devDependencies": {
    "husky": "4.3.0"
  }
}