Documentation ΒΆ
Index ΒΆ
Constants ΒΆ
This section is empty.
Variables ΒΆ
View Source
var Emojis = []EmojiConf{ {"π¨", ":art:", "Improve structure / format of the code.", CommitTypeStyle}, {"β‘οΈ", ":zap:", "Improve performance.", CommitTypeFeat}, {"π₯", ":fire:", "Remove code or files.", CommitTypeRelease}, {"π", ":bug:", "Fix a bug.", CommitTypeFix}, {"ποΈ", ":ambulance:", "Critical hotfix.", CommitTypeHotfix}, {"β¨", ":sparkles:", "Introduce new features.", CommitTypeFeat}, {"π", ":memo:", "Add or update documentation.", CommitTypeDocs}, {"π", ":rocket:", "Deploy stuff.", CommitTypeDeploy}, {"π", ":tada:", "Begin a project.", CommitTypeChore}, {"β ", ":white_check_mark:", "Add, update, or pass tests.", CommitTypeTest}, {"ποΈ", ":lock:", "Fix security issues.", CommitTypeFix}, {"π", ":bookmark:", "Release / Version tags.", CommitTypeRelease}, {"π¨", ":rotating_light:", "Fix compiler / linter warnings.", CommitTypeStyle}, {"π§", ":construction:", "Work in progress.", CommitTypeFeat}, {"π", ":green_heart:", "Fix CI Build.", CommitTypeChore}, {"β¬οΈ", ":arrow_down:", "Downgrade dependencies.", CommitTypeChore}, {"β¬οΈ", ":arrow_up:", "Upgrade dependencies.", CommitTypeChore}, {"π", ":pushpin:", "Pin dependencies to specific versions.", CommitTypeChore}, {"π·", ":construction_worker:", "Add or update CI build system.", CommitTypeChore}, {"π", ":chart_with_upwards_trend:", "Add or update analytics or track code.", CommitTypeFeat}, {"β»οΈ", ":recycle:", "Refactor code.", CommitTypeRefactor}, {"β", ":heavy_plus_sign:", "Add a dependency.", CommitTypeChore}, {"β", ":heavy_minus_sign:", "Remove a dependency.", CommitTypeChore}, {"π§", ":wrench:", "Add or update configuration files.", CommitTypeChore}, {"π¨", ":hammer:", "Add or update development scripts.", CommitTypeChore}, {"π", ":globe_with_meridians:", "Internationalization and localization.", CommitTypeFeat}, {"βοΈ", ":pencil2:", "Fix typos.", CommitTypeFix}, {"π©", ":poop:", "Write bad code that needs to be improved.", CommitTypeFeat}, {"βͺοΈ", ":rewind:", "Revert changes.", CommitTypeRevert}, {"π¦οΈ", ":package:", "Add or update compiled files or packages.", CommitTypeChore}, {"π½οΈ", ":alien:", "Update code due to external API changes.", CommitTypeFeat}, {"π", ":truck:", "Move or rename resources (e.g.: files, paths, routes).", CommitTypeRevert}, {"π", ":page_facing_up:", "Add or update license.", CommitTypeChore}, {"π₯", ":boom:", "Introduce breaking changes.", CommitTypeChore}, {"π±", ":bento:", "Add or update assets.", CommitTypeChore}, {"π‘", ":bulb:", "Add or update comments in source code.", CommitTypeChore}, {"π¬", ":speech_balloon:", "Add or update text and literals.", CommitTypeChore}, {"π", ":loud_sound:", "Add or update logs.", CommitTypeRefactor}, {"π", ":mute:", "Remove logs.", CommitTypeRefactor}, {"π₯", ":busts_in_silhouette:", "Add or update contributor(s).", CommitTypeChore}, {"π€‘", ":clown_face:", "Mock things.", CommitTypeTest}, {"π", ":see_no_evil:", "Add or update a .gitignore file.", CommitTypeChore}, {"πΈ", ":camera_flash:", "Add or update snapshots.", CommitTypeChore}, {"ποΈ", ":wastebasket:", "Deprecate code that needs to be cleaned up.", CommitTypeRefactor}, {"π©Ή", ":adhesive_bandage:", "Simple fix for a non-critical issue.", CommitTypeFix}, {"β°οΈ", ":coffin:", "Remove dead code.", CommitTypeRefactor}, {"π§ͺ", ":test_tube:", "Add a failing test.", CommitTypeTest}, }
Emojis from: https://gitmoji.dev/ CommitType from: https://sparkbox.com/foundry/semantic_commit_messages https://www.conventionalcommits.org/en/v1.0.0/
Functions ΒΆ
func ReadFromArgs ΒΆ added in v0.3.0
Types ΒΆ
type CommitType ΒΆ
type CommitType string
const ( CommitTypeFeat CommitType = "feat" // new feature for the user, not a new feature for build script CommitTypeRevert CommitType = "revert" // revert some feat or test or config CommitTypeFix CommitType = "fix" // bug fix for the user, not a fix to a build script CommitTypeHotfix CommitType = "hotfix" // buf hotfix, may skip code review or test CommitTypeDocs CommitType = "docs" // changes to the documentation CommitTypeStyle CommitType = "style" // formatting, missing semi colons, etc; no production code change CommitTypeRefactor CommitType = "refactor" // refactoring production code, eg. renaming a variable CommitTypeTest CommitType = "test" // adding missing tests, refactoring tests; no production code change CommitTypeChore CommitType = "chore" // updating grunt tasks etc; no production code change CommitTypeRelease CommitType = "release" // release new tag CommitTypeDeploy CommitType = "deploy" // deploy code to test or production env )
type EmojiConf ΒΆ
type EmojiConf struct { Emoji string Text string Desc string CommitType CommitType }
func SelectEmoji ΒΆ
Click to show internal directories.
Click to hide internal directories.