@forsakringskassan/commitlint-config 2.0.4 → 3.0.0

package/README.md

@@ -26,8 +26,8 @@ This package bundles `@commitlint/cli` so it does not have to be installed separ
 
 This package provides two variants:
 
--   `@forsakringskassan/commitlint-config/default`
--   `@forsakringskassan/commitlint-config/no-jira`
+- `@forsakringskassan/commitlint-config/default`
+- `@forsakringskassan/commitlint-config/no-jira`
 
 The default configuration enforces a JIRA reference at the end of the header.
 The `no-jira` variant does not enforce it.
@@ -46,26 +46,22 @@ or manually edit `package.json`:
 }
 ```
 
-## Usage
+## Git hooks
 
-As a husky hook:
+This package will by an postinstall script add needed git hooks, so by default you dont need to add anything in your application (more than adding this package as a depedency)
 
-```bash
-echo 'npm exec commitlint -- --edit "$1"' > .husky/commit-msg
-```
-
-### Lint staged
-
-This package bundles `lint-staged` and can be used with a preconfigured setup.
-Assuming husky is used add `.husky/pre-commit` with:
+If you already have `husky`, `simple-git-hooks` or `lint-staged` in your `package.json` you need uninstall them first:
 
 ```bash
-configfile=$(node -p 'require.resolve("@forsakringskassan/commitlint-config/lint-staged")')
-npm exec lint-staged -- --config "${configfile}" "$@"
+npm rm lint-staged husky simple-git-hooks
 ```
 
-If you already have `lint-staged` in your `package.json` you should remove it:
+### Disable hooks
+
+To disable Git hooks from this repo, you can use environment `FK_COMMITLINT_SKIP` variable before installing.
+Hooks will never be added in a CI environment such as Jenkins.
 
 ```bash
-npm rm lint-staged
+export FK_COMMITLINT_SKIP=1
+npm install --save-dev @forsakringskassan/commitlint-config
 ```