https://github.com/thierrymichel/cz-ccgls

Commitizen adapter following the Conventional-Changelog with support for Gitmoji and Lerna Scopes
https://github.com/thierrymichel/cz-ccgls

Last synced: 2 months ago
JSON representation

Commitizen adapter following the Conventional-Changelog with support for Gitmoji and Lerna Scopes

• Host: GitHub
• URL: https://github.com/thierrymichel/cz-ccgls
• Owner: thierrymichel
• License: unlicense
• Created: 2018-09-09T21:16:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-10T12:53:47.000Z (4 months ago)
• Last Synced: 2024-10-14T17:16:25.091Z (3 months ago)
• Language: JavaScript
• Size: 240 MB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# cz-ccgls

> Adapter for [commitizen](https://github.com/commitizen/cz-cli), a prompt for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard.


> Support [gitmoji](https://gitmoji.carloscuesta.me/) and [Lerna](https://lernajs.io/) scopes.

[![npm version](https://img.shields.io/npm/v/cz-ccgls.svg?style=flat-square)](https://www.npmjs.org/package/cz-ccgls)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)

[![License](https://img.shields.io/badge/license-UNLICENSE-green.svg?style=flat-square)](https://github.com/thierrymichel/cz-ccgls/blob/master/UNLICENSE)

Inspired by [cz-conventional-changelog](https://www.npmjs.com/package/cz-conventional-changelog) and [cz-emoji](https://github.com/ngryman/cz-emoji)

![Screenshots](screenshots.gif)

## Usage

### [Making your repo Commitizen-friendly](https://github.com/commitizen/cz-cli#making-your-repo-commitizen-friendly)

First, install the Commitizen cli tools:

```sh

npm install commitizen -g

```

Next, initialize your project to use the cz-ccgls adapter by typing:

```sh

commitizen init cz-ccgls --yarn --dev --exact

```

> Or if you are using Npm: `commitizen init cz-ccgls --save-dev --save-exact`

### Locally

```sh

# Install commitizen + adapter

yarn add -D commitizen cz-ccgls

```

Add some `config` information to your `package.json`

```json

"config": {

  "commitizen": {

    "path": "./node_modules/cz-ccgls"

  }

}

```

> [More infos in the `commitizen` documentation](https://github.com/commitizen/cz-cli#optional-install-and-run-commitizen-locally)

### Configuration

Add some `config` information to your `package.json` ([default values](src/index.mjs#L24))

```json

"config": {

  "cz-ccgls": {

    "useScopes": true

  }

},

```

---

### Related

- [commitlint-config-ccgls](https://github.com/thierrymichel/commitlint-config-ccgls), the [`Commitlint`](https://github.com/marionebl/commitlint) companion.