Gathering detailed insights and metrics for commitlint-plugin-semantic-commit-emoji
Gathering detailed insights and metrics for commitlint-plugin-semantic-commit-emoji
Prepend emoji to matching semantic commit messages
Installations
npm install commitlint-plugin-semantic-commit-emojiDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=18
Score
51.9
Supply Chain
52.6
Quality
77.7
Maintenance
50
Vulnerability
79.3
License
Releases
43
commitlint-config-semantic-commit-emoji-v3.0.1
commitlint-config-semantic-commit-emoji-v3.0.1
Updated on Sep 17, 2024
commitlint-plugin-semantic-commit-emoji-v3.0.1
commitlint-plugin-semantic-commit-emoji-v3.0.1
Updated on Sep 17, 2024
semantic-commit-emoji-v2.0.0
semantic-commit-emoji-v2.0.0
Updated on Sep 16, 2024
semantic-commit-emoji-config-v3.0.0
semantic-commit-emoji-config-v3.0.0
Updated on Sep 16, 2024
commitlint-config-semantic-commit-emoji-v3.0.0
commitlint-config-semantic-commit-emoji-v3.0.0
Updated on Sep 16, 2024
commitlint-plugin-semantic-commit-emoji-v3.0.0
commitlint-plugin-semantic-commit-emoji-v3.0.0
Updated on Sep 16, 2024
Languages
3
TypeScript
JavaScript
Shell
TypeScript (75.18%)
JavaScript (22.69%)
Shell (2.13%)
Developer
adambullmer
Download Statistics
Total Downloads
42,532
Last Day
11
Last Week
362
Last Month
1,636
Last Year
21,974
GitHub Statistics
GPL-3.0 License
4 Stars
279 Commits
3 Forks
2 Watchers
7 Branches
2 Contributors
Updated on Feb 20, 2025
Bundle Size
184.00 B
Minified
153.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
3.0.1
Package Id
commitlint-plugin-semantic-commit-emoji@3.0.1
Unpacked Size
74.91 kB
Size
25.91 kB
File Count
8
Published on
Sep 17, 2024
Total Downloads
Cumulative downloads
Total Downloads
42,532
Dependencies
1
Peer Dependencies
1
semantic-commit-emoji
Prepend emoji to matching semantic commit messages.
What It Does
- This package adds github compatible emojis to commit messages in plain text.
- This package is intended to be used directly in the
commit-msggit hook. - Following git hook documentation, it will rewrite temp commit messages that follow certain semantic commit type keywords.
- It can rewrite other messages, like automated version commits, merges, and reverts.
- This is similar to other implementations, but instead of choosing between emoji or explicit semantic commit, you get both!
- This also follows some of the emoji suggestions from gitmoji.
- Allows for overriding conventional emojis with your own if you provide it in the message. (Useful for chore if you want more granularity)
Example:
1$ git commit -m "feat: Add new function" -m "Some expanded description about the feature" 2$ git log --format=%B -n 1 HEAD 3:sparkles:feat: Add new function 4 5Some expanded description about the feature 6$
What It Doesn't Do
- Add native emojis to commit mesages.
- This will not enforce that commits are of a semantic commit pattern.
- It will also not prepend emojis to messages that do not follow a semantic commit pattern.
- For simplicity, the total list of gitmoji has been reduced to some
Supported Semantic Types
The list of current message types and their used emoji
| Type | Emoji |
|---|---|
| feat | :sparkles: :sparkles: |
| fix | :bug: :bug: |
| docs | :pencil: :pencil: |
| refactor | :recycle: :recycle: |
| style | :art: :art: |
| test | :microscope: :microscope: |
| perf | :zap: :zap: |
| hotfix | :ambulance: :ambulance: |
| locale | :globe_with_meridians: :globe_with_meridians: |
| ci | :construction_worker: :construction_worker: |
| chore | :wrench: :wrench: |
| types | :label: :label: |
Installation
This can either be a global module if this is just a personal preference, or a project one, so that you may enforce consistency on all contributors. It is recommended that you use a utility, like Husky, to manage consistently setting up git hooks on project setup.
Global Installation
1yarn global add semantic-commit-emoji 2# or 3npm g i semantic-commit-emoji
Project Installation
1yarn add --dev semantic-commit-emoji 2# or 3npm install --save-dev semantic-commit-emoji
Usage
Standalone Git Hook
For a standalone git hook, you can symlink the script into the appropriate hook
1mkdir -p .git/hooks 2ln -s ./node_modules/.bin/semantic-commit-emoji
Multiple Git Hooks
If you want this hook to run with other commit-message or prepare-commit-message hooks, it can be called from the hook file like this (assuming sh syntax):
1#!/bin/sh 2 3# ... Other git hooks 4 5# If globally installed module 6commit-message-emoji "$@" 7# Or if localy installed module 8npx commit-message-emoji "$@"
Usage with Husky
An example for husky can be found in this repo's .huskyrs.js file.
Limitations
By design, this package will let you override an emoji with your own if you provide it in your message. This offers the greatest flexibility for your own preferences over the conventions of this script.
It is recommended that you use this in the commit-msg hook, as the prepare-commit-msg hook prepares templates for an editor.
This means that if a user runs git commit their message that was entered via an external editor will not get processed, and therefore will miss the benefits of this package.
Since this is a user script, this will not be able to rewrite messages generated by git server actions, like merging a PR on github or bitbucket. If need be, you could write a CI step to detect merged and reverts from your source control server, rewrite the message and force push it back up. However, it is the opinion of the maintainer that you shoud probably just do a manual merge of PRs according to the copy+paste script that github provides.
Road Map
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release.yml:17
- Warn: no topLevel permission defined: .github/workflows/nodejs.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/release.yml:9
Reason
Found 0/22 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/nodejs.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/nodejs.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/adambullmer/semantic-commit-emoji/release.yml/main?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact commitlint-plugin-semantic-commit-emoji-v3.0.1 not signed: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175385067
- Warn: release artifact commitlint-config-semantic-commit-emoji-v3.0.1 not signed: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175385100
- Warn: release artifact semantic-commit-emoji-v2.0.0 not signed: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175169965
- Warn: release artifact semantic-commit-emoji-v1.0.4 not signed: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175168413
- Warn: release artifact semantic-commit-emoji-v1.0.3 not signed: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175161941
- Warn: release artifact commitlint-plugin-semantic-commit-emoji-v3.0.1 does not have provenance: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175385067
- Warn: release artifact commitlint-config-semantic-commit-emoji-v3.0.1 does not have provenance: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175385100
- Warn: release artifact semantic-commit-emoji-v2.0.0 does not have provenance: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175169965
- Warn: release artifact semantic-commit-emoji-v1.0.4 does not have provenance: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175168413
- Warn: release artifact semantic-commit-emoji-v1.0.3 does not have provenance: https://api.github.com/repos/adambullmer/semantic-commit-emoji/releases/175161941
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-7q7g-4xm8-89cq
- Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq
Score
2.3
/10
Last Scanned on 2025-06-02
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More