https://github.com/bird-studio/interactive-message
interactive message tool
https://github.com/bird-studio/interactive-message
cli commit conventional-commits gitmoji semantic-release semantic-version typescript
Last synced: 11 months ago
JSON representation
interactive message tool
- Host: GitHub
- URL: https://github.com/bird-studio/interactive-message
- Owner: bird-studio
- License: mit
- Created: 2021-11-03T10:32:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-05T12:05:12.000Z (over 2 years ago)
- Last Synced: 2025-05-14T20:50:42.399Z (12 months ago)
- Topics: cli, commit, conventional-commits, gitmoji, semantic-release, semantic-version, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@bird-studio/interactive-message
- Size: 32.9 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# interactive-message
## Alternative
https://github.com/bird-studio/hoipoi_capsule
## Overview
Create messages in an interactive format.
https://user-images.githubusercontent.com/92862731/183108755-09c3b60c-f46d-4422-99f7-e6782cdf9ecd.mov
## I need to use it right away.
https://github.com/akira-toriyama/interactive-message-demo
## Usage
```bash
npm i -D @bird-studio/interactive-message
touch interactive-message.config.js
```
example
https://github.com/akira-toriyama/interactive-message-demo/blob/main/interactive-message.config.js
The part that matches `questionDictionary.name` will be replaced.
Change the templates and questions as you like.
This setting is Conventional Commit and gitmoji.
## Commit hook
### githooks
`prepare-commit-msg`
```bash
#!/bin/sh
exec < /dev/tty && yarn interactive-message commit
```
```bash
git commit
```
`package.json`
```json
"scripts": {
"prepare": "git config --local core.hooksPath .githooks"
}
```
### husky
`prepare-commit-msg`
```bash
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
exec < /dev/tty && npx interactive-message commit
```
## Localization
- [grammar](https://github.com/bird-studio/interactive-message/blob/main/src/opt/plugin/grammar.ts)
- [translation](https://github.com/bird-studio/interactive-message/blob/main/src/opt/plugin/translation.ts)