Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add gitmoji type #273

Closed
wants to merge 1 commit into from
+83 −1
Closed

feat: Add gitmoji type #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/utils/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { TiktokenModel } from '@dqbd/tiktoken';
import { fileExists } from './fs.js';
import { KnownError } from './error.js';

const commitTypes = ['', 'conventional'] as const;
const commitTypes = ['', 'conventional', 'gitmoji'] as const;

export type CommitType = (typeof commitTypes)[number];

Expand Down
82 changes: 82 additions & 0 deletions src/utils/prompt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import type { CommitType } from './config.js';
const commitTypeFormats: Record<CommitType, string> = {
'': '<commit message>',
conventional: '<type>(<optional scope>): <commit message>',
gitmoji: '<type>(<optional scope>) <commit message>',
};
const specifyCommitFormat = (type: CommitType) =>
`The output response must be in format:\n${commitTypeFormats[type]}`;
Expand Down Expand Up @@ -36,6 +37,87 @@ const commitTypes: Record<CommitType, string> = {
null,
2
)}`,
gitmoji: `Choose a type from the type-to-description JSON below that best describes the git diff:\n${JSON.stringify(
{
':art:': 'Improve structure / format of the code.',
':zap:': 'Improve performance.',
':fire:': 'Remove code or files.',
':bug:': 'Fix a bug.',
':ambulance:': 'Critical hotfix.',
':sparkles:': 'Introduce new features.',
':memo:': 'Add or update documentation.',
':rocket:': 'Deploy stuff.',
':lipstick:': 'Add or update the UI and style files.',
':tada:': 'Begin a project.',
':white_check_mark:': 'Add, update, or pass tests.',
':lock:': 'Fix security or privacy issues.',
':closed_lock_with_key:': 'Add or update secrets.',
':bookmark:': 'Release / Version tags.',
':rotating_light:': 'Fix compiler / linter warnings.',
':construction:': 'Work in progress.',
':green_heart:': 'Fix CI Build.',
':arrow_down:': 'Downgrade dependencies.',
':arrow_up:': 'Upgrade dependencies.',
':pushpin:': 'Pin dependencies to specific versions.',
':construction_worker:': 'Add or update CI build system.',
':chart_with_upwards_trend:': 'Add or update analytics or track code.',
':recycle:': 'Refactor code.',
':heavy_plus_sign:': 'Add a dependency.',
':heavy_minus_sign:': 'Remove a dependency.',
':wrench:': 'Add or update configuration files.',
':hammer:': 'Add or update development scripts.',
':globe_with_meridians:': 'Internationalization and localization.',
':pencil2:': 'Fix typos.',
':poop:': 'Write bad code that needs to be improved.',
':rewind:': 'Revert changes.',
':twisted_rightwards_arrows:': 'Merge branches.',
':package:': 'Add or update compiled files or packages.',
':alien:': 'Update code due to external API changes.',
':truck:': 'Move or rename resources (e.g.: files, paths, routes).',
':page_facing_up:': 'Add or update license.',
':boom:': 'Introduce breaking changes.',
':bento:': 'Add or update assets.',
':wheelchair:': 'Improve accessibility.',
':bulb:': 'Add or update comments in source code.',
':beers:': 'Write code drunkenly.',
':speech_balloon:': 'Add or update text and literals.',
':card_file_box:': 'Perform database related changes.',
':loud_sound:': 'Add or update logs.',
':mute:': 'Remove logs.',
':busts_in_silhouette:': 'Add or update contributor(s).',
':children_crossing:': 'Improve user experience / usability.',
':building_construction:': 'Make architectural changes.',
':iphone:': 'Work on responsive design.',
':clown_face:': 'Mock things.',
':egg:': 'Add or update an easter egg.',
':see_no_evil:': 'Add or update a .gitignore file.',
':camera_flash:': 'Add or update snapshots.',
':alembic:': 'Perform experiments.',
':mag:': 'Improve SEO.',
':label:': 'Add or update types.',
':seedling:': 'Add or update seed files.',
':triangular_flag_on_post:': 'Add, update, or remove feature flags.',
':goal_net:': 'Catch errors.',
':dizzy:': 'Add or update animations and transitions.',
':wastebasket:': 'Deprecate code that needs to be cleaned up.',
':passport_control:':
'Work on code related to authorization, roles and permissions.',
':adhesive_bandage:': 'Simple fix for a non-critical issue.',
':monocle_face:': 'Data exploration/inspection.',
':coffin:': 'Remove dead code.',
':test_tube:': 'Add a failing test.',
':necktie:': 'Add or update business logic.',
':stethoscope:': 'Add or update healthcheck.',
':bricks:': 'Infrastructure related changes.',
':technologist:': 'Improve developer experience.',
':money_with_wings:': 'Add sponsorships or money related infrastructure.',
':thread:':
'Add or update code related to multithreading or concurrency.',
':safety_vest:': 'Add or update code related to validation.',
},
null,
2
)}`,
};

export const generatePrompt = (
Expand Down