This file typeDisplayNames.ts defines an object typeMap that is used by getDisplayName.

It'd be great if a user-defined typeMap can be supported by the configuration file, Let me know if I can raise a PR for this.

当前使用的 Emoji Unicode 正则并不支持诸如 ♻️ ⬆️ ⚡️ 这样的 UCS-4 字符。

比如在 StackOverflow 的这个问题中不仅考虑了当前的 UCS-2（和现在所用的正则较为相似），还考虑到了 UCS-4 的正则。但我并不清楚 JS 中如何能实现 UCS-4 正则。另一方面，这个正则也只适用于 Unicode 8.0，而现在已经 Unicode 13.1 了，所以使用某些持续更新的库也许会是更好的方案。

不过，我们还可以利用 Gitmoji 字符少的优势，正则里穷举所有 Gitmoji 即可，示例

由于 JS 会将 UCS-4 字符视作两个字符，所以 [🎨🔥🐛🚑✨♻️⬆️⚡️] 是不可行的，🎨|🔥|🐛|🚑|✨|♻️|⬆️|⚡️ 这样则是一种简单易行的方案。当然，这个正则使用动态生成应当会更好一些（虽然现在 64 个字符不算多，但一旦发生改动，改起来也挺麻烦的）。

在不同类型的项目中，需要显示的 Changelog 是不一样的，

例如在面向开发者的项目中，Changelog 可能越详细越好，但是在面向用户的项目中，Changelog 可能只需写特性与 Bug 修复等 。

因此需要提供一个配置项，允许开发者配置待生成的Changelog 显示信息。

目前提供了一个配置项 displayTypes，用于筛选出需要显示的 types

// .changelogrc.js
module.exports = {
  displayTypes: ['feat', 'fix', 'styles', 'pref'],
};

More：

允许用户过滤不要的 types

Any idea why this:

$ npx -p commitlint -p "commitlint-config-gitmoji" commitlint --from "origin/${CI_DEFAULT_BRANCH}" --to HEAD
npm WARN exec The following packages were not found and will be installed: [email protected], [email protected]
Error: Cannot find module "conventional-changelog-lint-config-gitmoji" from "/builds/xxx/xxx-ci"
    at resolveId (/builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/resolve-extends/src/index.ts:131:14)
    at resolveConfig (/builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/resolve-extends/src/index.ts:105:20)
    at /builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/resolve-extends/src/index.ts:51:20
    at Array.reduce (<anonymous>)
    at loadExtends (/builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/resolve-extends/src/index.ts:49:13)
    at resolveExtends (/builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/resolve-extends/src/index.ts:25:19)
    at load (/builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/load/src/load.ts:56:33)
    at async main (/builds/xxx/xxx-ci/.cache/npm/_npx/49ea1ae74129e566/node_modules/@commitlint/cli/src/cli.ts:214:17) {
  code: 'MODULE_NOT_FOUND'
}

doesn't work? My newbieness wrt JS world might play a role here.

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

https://github.com/carloscuesta/gitmoji/blob/master/src/data/gitmojis.json

this repo has been removed.

Problem:

Possible issue:

scope 常见场景包括：

• 区分 Mono Repo 多个模块
• 区分一个项目中的多个子功能

由于 scope 均为英文，因此在 Changelog 中显示并不方便。

因此应允许用户在外部输入配置项，对 scope 的显示值进行替换

配置项可能如下：

scopeDisplayName:{
  changelog:"conventional-changelog-gitmoji-config",
  config:"commitlint-config-gitmoji"
}

Hello @arvinxx,

First of all amazing project. I'm using your commitlint config for a Gitlab project. On Gitlab, I can't use the codes for Gitmoji, but I use the regular Unicode Emojis (this is the standard setting for the VS Code plugin that I use anyway).

The RegEx that you used in https://github.com/arvinxx/gitmoji-commit-workflow/blob/master/packages/commitlint-plugin/src/rule.ts#L11 does not work for every Gitmoji and I get this commitlint error for a correctly formatted commit message:

Your commit should start with gitmoji code,please check the emoji code on https://gitmoji.dev/. [start-with-gitmoji]

The emoji I faced the issue was 🩹 and ✏️, I could verify it's not working with the Regex101 link (try out 🩹 chore(scope): test).

Thank you for your support!

是否允许中文应该交给另外一条规则来考虑，在 gitmoji 的 commit 识别符中不应该关心中文的问题。

In some case such as Gitlab, gitmoji code (ex: :sparkles:) are not well supported.

It would be very nice to be able to enforce the gitmoji encoding (code or emoji).

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

is there any way to use this as github worklflow? like currently we can use commitlint as a github workflow, but how to extend it to use gitmoji-commit-workflow

开发者你好,
Hello developer,

我在使用 vitepress 构建自己的博客,同时使用了仓库的部分提交约束库, 最近 vitepress 最新版本由 commonJS 升级到了 ESmodule,
I am using Vitepress to build my own blog, and at the same time, I have used some repository submission constraint libraries. Recently, the latest version of Vitepress has been upgraded from CommonJS to ES module.

要求必须是package.json中配置type:module,
The requirement is that type: module must be configured in the package.json file.

我在做出如上配置后, 在提交约束过程中遇到了一些自己无法解决的问题,具体可以看图片所示,在提交的最后一步产生了报错:
After making the above configuration, I encountered some problems that I couldn't solve during the submission constraint process. You can see the specific details in the picture below. An error occurred in the last step of submission.

package.json

{
  "name": "vitepress",
  "version": "2.0.9",
  "description": "",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "dev": "vitepress dev docs --open",
    "build": "vitepress build docs",
    "serve": "vitepress serve docs",
    "prepare": "husky install",
    "cz": "git-cz",
    "clog": "npx standard-version --preset gitmoji-config -i docs/CHANGELOG.md --header '# 更新日志'"
  },
  "config": {
    "commitizen": {
      "path": "node_modules/cz-message-helper"
    },
    "cz-message-helper": {
      "config": ".cz-message.cjs"
    },
    "commitlint": {
      "extends": [
        "gitmoji"
      ]
    },
    "changelog": {
      "titleLanguage": "zh-CN"
    }
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@algolia/client-search": "^4.17",
    "@types/node": "^18.15.11",
    "commitizen": "^4.3.0",
    "commitlint": "^17.6.6",
    "commitlint-config-gitmoji": "^2.3.1",
    "conventional-changelog-gitmoji-config": "^1.5.2",
    "cz-message-helper": "^1.3.0",
    "husky": "^8.0.0",
    "standard-version": "^9.5.0",
    "vitepress": "^1.0.0-rc.4"
  },
  "dependencies": {
    "markdown-it-footnote": "^3.0.3",
    "markdown-it-task-checkbox": "^1.0.6",
    "medium-zoom": "^1.0.8"
  }
}

System Info

System:
    OS: macOS 13.5
    CPU: (10) arm64 Apple M1 Max
    Memory: 7.17 GB / 32.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 18.16.0 - ~/Library/pnpm/node
    npm: 9.5.1 - ~/Library/pnpm/npm
    pnpm: 8.6.3 - ~/Library/pnpm/pnpm
  Browsers:
    Chrome: 115.0.5790.170
    Safari: 16.6
  npmPackages:
    vitepress: 1.0.0-rc.4 => 1.0.0-rc.4

希望能修复这个报错,让我正常提交代码, 如果还需要任何信息,可以随时回复.
I hope to fix this error so that I can submit the code normally. If any further information is needed, please feel free to reply.

Hey! I'm new to the whole 'commitlint' thing and was messing around and found possibly redundant dependency.

commitlint@"^11.0.0 required by commitlint-plugin-gitmoji and' is required by commitlint-config-gitmoji seems to be redundant. Furthermore, even with installed commitlint, it would show an error that says I got the wrong version (required 11, latest 17).

So I got commitlint totally removed and ignored the warning message. And it works as expected! I got installed only @commitlint/cli (which seems to be the only package needed to get commitlint to work, according to official documentation), commitlint-config-gitmoji, and @commitlint/types (for config file).

Don't you find this dependency redundant? Or at least outdated

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Package: commitlint-config-gitmoji

您好，ccommitlint-plugin-gitmoji使用时 Failed to fetch gitmoji JSON，看了您的文档解决方法需要自己下载gitmojis.json文件放node_modules里，我觉得这样不太合理，这样我和我的搭档一起写代码我们都需要下载一份这个文件放本地node_modules。我觉得这个文件您可以下载放在您的包里，如果Failed to fetch gitmoji JSON就引用您项目内的gitmojis.json文件，这样使用起来更友好些，您觉得呢？

          I will try to figure it out

Originally posted by @arvinxx in #668 (comment)

Getting this error, any idea?

Can we relax the dependency to commintilnt 11 ?

https://github.com/arvinxx/umi-web-template/runs/1863078036?check_suite_focus=true

Heyhey, would you mind we add your config here?: https://commitlint.js.org/#/reference-community-projects

See:
conventional-changelog/commitlint#3036 (comment)

There's normally a space after commas. Additionally, applying a bit more grammar nitpicking would give something like:

- ✖   Your commit should start with gitmoji code,please check the emoji code on https://gitmoji.dev/. [start-with-gitmoji]
+ ✖   Your commit should start with gitmoji code. Please check the emoji code on https://gitmoji.dev/. [start-with-gitmoji]

Happy to send a PR if this is acceptable.

Love this tool overall, thanks for making it! ❤️‍🔥

I think if GCW can only use semantic-release to release and generate changelog, it will be more limited. Is there a way to use lerna to manage and release?

The bug concerns the commitlint plugin/config.

I usea custom config available in this repository. It is possible to reproduce the bug by changing the value of anyGitmoji to '⬆️'.

The validation message is "Your commit should start with gitmoji code,please check the emoji code on https://gitmoji.dev/."

As the title says, squash commits have the format :sparkles: feat: commit message (#291) and this breaks the regex matching. To be more precise, I actually think it's the closing parenthesis that does it?

As a result squash commits are excluded from the changelog and from the semantic versioning.

Hey all, it seems there was no new version published on NPM after #6 was merged. Could this be remedied?

Hey there, could we stick to english or be able to modify the title types of the changelog?

Emojis list and their description is not in sync with Gitmoji anymore.

Hello @arvinxx, I use the commitlint with the recommended configuration, but I get this problem:

Is there any problem with my configuration？

And I test not use gitmoji plugin, commitlint can working normally!
Has anyone ever experienced a similar situation？
Thanks for your proposal！

if i put a scope i get subject-empty why?

yarn run v1.21.1
$ gitmoji -c
? Choose a gitmoji: ⚡️  - Improving performance.
? Enter the scope of current changes: test
? Enter the commit title [8/48]: New Test
? Enter the commit message: This is a test
Error: Command failed with exit code 1: git commit -S -m :zap: (test): New Test -m This is a test
husky > commit-msg (node v12.14.0)
⧗   input: :zap: (test): New Test

This is a test
✖   subject may not be empty [subject-empty]

✖   found 1 problems, 0 warnings

Hello,

I found a bug using the emoji 👷‍♂️

When I use the code the test passes

echo ':construction_worker: ci: test' | commitlint # passes

But when I use the emoji itself it fails

 echo '👷 ci: test' | commitlint
⧗   input: 👷 ci: test
✖   👷 is not in the correct gitmoji list, please check the emoji code on https://gitmoji.dev/. [start-with-gitmoji]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

It happens with several other emojis as well

🚨 The automated release from the beta branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the beta branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Hey, this lib becomes out of sync whenever gitmoji adds a new emoji. Here's how I managed to solve the problem.

• Add gitmoji to the dev dependencies. Unfortunately gitmoji is not available from NPM, so we must point to the GitHub repo.

    "gitmoji": "carloscuesta/gitmoji",

• Change the commitlint config file:

const { gitmojis } = require('gitmoji/src/data/gitmojis.json')
const allGitmojiCodes = gitmojis.map(gitmoji => gitmoji.code)

module.exports = {
  rules: {
    'type-enum': [2, 'always', allGitmojiCodes],

What do you think? Would you like a PR?

I see it is hardcoded here:

Could it also possibly link to a local file?

Currently there is a wrench emoji:

But gitmoji uses this symbol for adding ci 👷

originally in gitmoji 1.0, you use enum-type to enforce usage of gitmoji, that works great and I really enjoyed it.

Now in 2.0, it seems commitlint-config-gitmoji not only enforces on the gitmoji, but also on the subject in coventional-commit, i think this is a bit redundant.

e.g.

:bug: bug: Fixed a bug

git gitmoji has already indicated that the subject of this commit message is a bug, extra subject bug: is just way too tedious.

i'd recommend to provide some configuration options to restore behavior of usage of only gitmoji without extra enum type being passed in.

e.g.

:bug: Fixed a bug

or with scope

:bug:(feature) Null pointer bug in the feature

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Hey, I know that this might be pure semantic release related, but I want to give it a shot here. Because of a docker setup, where the frontend part has its own container, I put the package.json and my other configuration files like webpack, eslint etc. into a separate folder called buildchain. Also the node_modules folder are being saved into this folder and npm commands are called within the folder.

Is there a way to let this setup work hand in hand with your gitmoji-commit-workflow? I've tried the working-directory for the github actions, but then I get asked about an npm_token. It is a private package, which should not be published to npm. Currently my workflow file looks like this:

name: Release CI
on:
  push:
    branches:
      - master
      - next
      - beta
      - alpha
      - pre/rc
      - 1.x
      - 2.x

jobs:
  release:
    name: Release
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup Node.js environment
        uses: actions/[email protected]
        with:
          node-version: '14'

      - name: Cache multiple paths
        uses: actions/cache@v2
        with:
          path: |
            ~/.npm
            ~/cache
            !~/cache/exclude
            **/node_modules
          key: npm-${{ runner.os }}-${{ hashFiles('yarn.lock') }}

      - name: install
        working-directory: ./buildchain
        run: npm install

      - name: release
        working-directory: ./buildchain
        run: npm run release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

And my directory setup looks like this:

I'd still want to publish the package to a private github repo at once including a Changelog.md in the root level, I just have the problem that the package.json and node_modules folder live within the buildchain folder and I don't know how to setup gitmoji-commit-workflow properly to work with this structure.

Kind Regards!

I want to use this VS extension with commitlint

commitlint catch error if use some gitmoji with commitlint extending gitmoji ex) refactor

https://github.com/arvinxx/gitmoji-commit-workflow/blob/master/packages/commit-types/src/index.ts

Which cz-cli adapter should I use to be compliant with both commitlint-config-gitmoji and conventional-changelog-gitmoji-config?

I tried customizing cz-emoji without success since the types are also different from these ones.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency lerna to v6
• chore(deps): update dependency lint-staged to v13
• chore(deps): update dependency multi-semantic-release to v3
• chore(deps): update dependency ts-node to v10
• chore(deps): update jest monorepo to v29 (major) (@types/jest, jest, ts-jest)
• fix(deps): update dependency cosmiconfig to v8
• fix(deps): update dependency dotenv to v16
• fix(deps): update semantic-release monorepo (major) (@semantic-release/changelog, @semantic-release/git)
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/setup-node action to v2.5.1
• chore(deps): update actions/checkout action to v3
• chore(deps): update actions/setup-node action to v3
• chore(deps): update c-hive/gha-yarn-cache action to v2
• chore(deps): update commitlint monorepo to v17 (major) (@commitlint/lint, commitlint)
• chore(deps): update dependency @types/node to v18
• chore(deps): update dependency @umijs/fabric to v3
• chore(deps): update dependency @umijs/test to v4
• chore(deps): update dependency eslint to v8
• chore(deps): update dependency husky to v8
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

为 Monorepo 提供特制 lint 方案

强制要求传入 scope

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀