https://github.com/devpow112/commitlint-config

:clipboard: Shareable commitlint configuration
https://github.com/devpow112/commitlint-config

commitlint-config dependabot github-actions nodejs semantic-release

Last synced: about 2 months ago
JSON representation

:clipboard: Shareable commitlint configuration

• Host: GitHub
• URL: https://github.com/devpow112/commitlint-config
• Owner: devpow112
• License: mit
• Created: 2022-02-10T16:46:30.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-05T15:05:07.000Z (about 2 months ago)
• Last Synced: 2024-11-13T17:23:35.182Z (about 2 months ago)
• Topics: commitlint-config, dependabot, github-actions, nodejs, semantic-release
• Language: JavaScript
• Homepage: https://npmjs.com/@devpow112/commitlint-config
• Size: 956 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# CommitLint Configuration

[![License][License Badge]](LICENSE)

[![Version][Version Badge]][Version Package]

[![Release][Release Badge]][Release Workflow]

[![Node Version][Node Version Badge]](package.json#L49)

Shareable commitlint configuration.

## Installation

```console

npm i -D @devpow112/commitlint-config

```

## Usage

The shareable config can be configured in the [CommitLint configuration]

file.

```json

{

  "extends": "@devpow112/commitlint-config"

}

```

## Development

Development can be done on any machine that can install **Node.js**. Only the

latest LTS version is tested against.

### Install Dependencies

Install dependencies via `npm`.

```console

npm i

```

### Linting

Execute linters via `npm`.

```console

# git, javascript, markdown and package.json

npm run lint

# git only

npm run lint:git

# javascript only

npm run lint:js

# markdown only

npm run lint:md

# package.json only

npm run lint:pkg

```

### Fixing

Execute automatic fixers via `npm`.

```console

# javascript, markdown and package.json

npm run fix

# javascript only

npm run fix:js

# markdown only

npm run fix:md

# package.json only

npm run fix:pkg

```

[License Badge]: https://img.shields.io/github/license/devpow112/commitlint-config?label=License

[Version Badge]: https://img.shields.io/npm/v/@devpow112/commitlint-config?label=Version

[Version Package]: https://www.npmjs.com/@devpow112/commitlint-config

[Node Version Badge]: https://img.shields.io/node/v/@devpow112/commitlint-config

[Release Badge]: https://github.com/devpow112/commitlint-config/actions/workflows/release.yml/badge.svg?branch=main

[Release Workflow]: https://github.com/devpow112/commitlint-config/actions/workflows/release.yml?query=branch%3Amain

[CommitLint configuration]: https://github.com/conventional-changelog/commitlint/blob/master/docs/concepts-shareable-config.md