# @alexmarqs/commitlint-config

> Personal shareable commitlint config

Latest version **1.0.0** (published 2021-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @alexmarqs/commitlint-config
pnpm add @alexmarqs/commitlint-config
yarn add @alexmarqs/commitlint-config
bun add @alexmarqs/commitlint-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-08-04 |
| First published | 2021-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=v10 |
| Dependencies | 0 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Alexandre Marques |
| Maintainers | alexmarqs |
| Keywords | commitlint, commitlint-config, config |

## Links

- npm: https://www.npmjs.com/package/@alexmarqs/commitlint-config
- Repository: https://github.com/alexmarqs/commitlint-config
- Homepage: https://github.com/alexmarqs/commitlint-config#readme
- Issues: https://github.com/alexmarqs/commitlint-config/issues
- npm.io page: https://npm.io/package/@alexmarqs/commitlint-config

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2021-08-04

## README

# @alexmarqs/commitlint-config

Shareable [`commitlint`](https://github.com/conventional-changelog/commitlint) config used in personal projects.

[![npm version](https://badge.fury.io/js/%40alexmarqs%2Fcommitlint-config.svg)](https://badge.fury.io/js/%40alexmarqs%2Fcommitlint-config)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

## How to install

```sh
# Install commitlint-config
npm install -D @alexmarqs/commitlint-config @commitlint/cli
# or
yarn add -D @alexmarqs/commitlint-config @commitlint/cli
```

## Usage

After installing it, apply the config to `commitlint` by running the following command:

```sh
# Note: configuration is picked up from commitlint.config.js, .commitlintrc.js, .commitlintrc.json, or .commitlintrc.yml file or a commitlint field in package.json
echo "module.exports = { extends: ['@alexmarqs/commitlint-config'] };" > .commitlintrc.js
```

## Husky integration

To lint commits before they are created you can use install Husky and use the `commit-msg` hook:

```sh
# Install Husky
npm install husky -D
# or
yarn add husky -D

# Activate hooks (you can configure this in the 'prepare' life cycle script)
npx husky install
# or
yarn husky install

# Add hook
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
# or
yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'
```

For version 4 and under of Husky use the following instructions instead in your `package.json`:

```json
// package.json
{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}
```

## License

MIT License © [alexmarqs](https://github.com/alexmarqs)

---
_Source: https://npm.io/package/@alexmarqs/commitlint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._