# lintush

**Repository Path**: mirrors_google/lintush

## Basic Information

- **Project Name**: lintush
- **Description**: Interactive CLI for conventional commit messages 🦄
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lintush - Commit made easy 🦄

Lintush uses [commitlint](https://github.com/conventional-changelog/commitlint) to help you write standard commit messages


## Quick start

``` shell
npm i -g lintush
-- OR --
npm i -D lintush
```

<p align="center"><img src="https://user-images.githubusercontent.com/4939021/71554157-4ef3a100-2a24-11ea-97a5-bdc2a15292ea.gif?raw=true"/></p>

1. Run ```lintush --init``` in your project root to create a ```lintush-config.js``` file.
1. Edit ```lintush-config.js``` to fit your lint demands.
1. Make sure your project has a ```commitlint.config.js``` file with a ```scope-enum``` [required]
    * You can take a look at [this example](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) if you're not sure.


## Writing commit messages

Run ```lintush``` in your project directory to write your amazing commit message 🦄🦄🦄

You can run ```lintush && git commit -F .git/COMMIT_EDITMSG``` to automatically commit,
or run ```lintush && git commit -F .git/COMMIT_EDITMSG -e``` to edit your commit message after ```Lintush``` is done.