English | 简体ä¸æ–‡
git commit -m "🦄"
Commit like the flow in Git. 🌊
This is a CLI tool that helps you stage changes, generate the commit message in a flow, and commit them in one go.
npm install -g flowmit
// or install in your project:
npm install -D flowmit
Just run the alias fm
in your terminal, then follow the instructions and you're good to go!
fm
If you installed it in your project, you can run it with:
npx flowmit
Or add it to your package.json
scripts:
{
"scripts": {
"commit": "flowmit"
}
}
If you only want to see the commit message without committing it, you can use the --dry
option.
fm --dry
You can configure flowmit
by adding a flowmit.config.ts
/flowmit.config.js
file in the root of everywhere within your project. It means that, if you are in a monorepo, you can have multiple flowmit.config.ts
/flowmit.config.js
files in different packages to customize the commit message for each package.
// flowmit.config.ts
import { defineConfig } from './src/config'
export default defineConfig({
// the types of commit messages you can choose from
types: [
{ title: 'feat', value: 'feat', description: 'new features' },
{ title: 'fix', value: 'fix', description: 'fix a bug' },
],
// the scopes of the commit messages you can choose from
scopes: [
'core',
'cli',
],
// like --dry option
dry: true,
})
flow + commit = flowmit
A simple equation names a tool! 😎