kitty

README

kitty

Modern native Git hooks made easy

Kitty improves your commits!

Install

If you have installed Homebrew, run:

brew tag ImSingee/kitty
brew install kitty

Or you can visit the release page to download the latest version. The downloaded archive contains a single executable file, you can put it the system PATH.

Or you can install it from source (this requires Go1.21+):

go install github.com/ImSingee/kitty@latest

Usage

After cloning a project:

kitty install

Add a hook:

kitty add pre-commit "go test"
git add .kitty/pre-commit

Make a commit:

git commit -m "Keep calm and commit"
# `go test` will run

Config

There's no kitty configurations at the moment. But some extensions may need configurations, and it can be configured in kitty configuration file(s).

The configuration file will be read from the following locations:

• .kittyrc
• .kittyrc.json
• kitty.config.json

In most cases, the configuration file should be placed inside the root directory of your project. But in some cases, you can place the config file inside the subdirectory of the project to override some configs.

Extension: lint-staged

kitty ships extension lint-staged to allow you to run commands on staged files.

In most cases, you can use lint-staged in the hook pre-commit:

kitty add pre-commit '@lint-staged'
git add .kitty/pre-commit

Or you can manually run

kitty lint-staged

Configuration

lint-staged can be configured in many ways:

• lint-staged object in your kitty config
• .lintstagedrc or .lintstagedrc.json file (in JSON format)
• lint-staged.config.js or .lintstagedrc.js file (Comping Soon)

If a configuration file exists but not added to git, it will be ignored.

You can also place multiple configuration files in different directories inside a project. For a given staged file, the closest configuration file will always be used. But you can't have multiple configuration files in the same directory.

Configuration can be an object in two formats:

{
  "files": {
    "*": "your-cmd"
  }
}

or simply (if you do not want to specify any advanced options):

{
  "*": "your-cmd"
}

Inside the files object in format 1 or for whole object of format 2, each value is a command to run and its key is a glob pattern to use for this command.

.kittyrc.json example:

{
  "lint-staged": {
    "*": "your-cmd"
  }
}

.lintstagedrc.json example:

{
  "*": "your-cmd"
}

This config will execute your-cmd with the list of currently staged files passed as arguments.

So, considering you did git add file1.ext file2.ext, lint-staged will run the following command:

your-cmd file1.ext file2.ext

Note Apart from node.js lint-staged, we do not pass absolute paths to the commands. Instead, we pass the relative path to the working directory (where lint-staged config is placed) to the command. If you want we pass absolute paths to the commands, you can prepend [absolute] (note: space is required) before the command.

Example:

{
  "*": "[absolute] your-cmd"
}

Then we will run your-cmd /absolute/path/to/file1.ext /absolute/path/to/file2.ext

Concurrency

We do not run commands in parallels now, but we plan to support it (and make it default) in the future.

Platform Support

Unfortunately, kitty is not supported Windows platform now, please use it on Linux or macOS.

We will start working on it after our features are stable. If you are a Windows user, consider using WSL.

If you really want to use kitty on Windows, PR is welcome.

Credits

• husky
• lint-staged
• go-git

License

MIT