Giter VIP home page Giter VIP logo

commit-conv's Introduction

commit-conv

NPM Downloads Inline docs

NodeVersion GitHub package version devDependencies Status dependencies Status

GH Downloads GitHub commit activity the past year GitHub contributors Github search hit counter

Dependabot Status Build Status codecov.io Code Coverage tested with jest eslint Known Vulnerabilities

All Contributors GitHub contributions welcome Commitizen friendly

GitHub top language GitHub language count GitHub code size in bytes

BCH compliance Codacy Badge semantic-release

Converts commit messages based on commit conventions.

Documentation

Table of Contents

commitConv

index.js:36-68

Convert a commit message into one that follows the specified commit convention.

Parameters

  • param Object<string> Parameters
    • param.tag string Tag of the commit message (e.g: fix, chore, feat, docs, test, ...) (optional, default required('tag'))
    • param.msg string Header of the commit message (optional, default required('msg'))
    • param.convention string Name of the commit convention (angular, atom, ember, eslint, jshint, gitmoji or none) (optional, default '')

Examples

commitConv({tag: 'docs', msg: 'Update README.md', convention: 'angular'}); //'docs: update README.md'
commitConv({tag: 'fix', msg: 'bye bye #1', convention: 'eslint'}); //'Fix: Bye bye #1'
  • Throws Error Invalid convention
  • Throws Error Invalid tag in specified convention

Returns string Commit message

Contributions

Please refer to that.

Contributors

Thanks goes to these wonderful people (emoji key):

Maximilian Berkmann
Maximilian Berkmann

πŸ’» πŸ“– πŸ€” πŸš‡ 🚧 ⚠️ πŸ’‘
Semantic Release Bot
Semantic Release Bot

πŸ“¦
Benjamin Bourgeois
Benjamin Bourgeois

πŸ’»

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE

MIT

commit-conv's People

Contributors

allcontributors[bot] avatar bengeois avatar berkmann18 avatar dependabot[bot] avatar semantic-release-bot avatar

Watchers

 avatar  avatar  avatar

commit-conv's Issues

The automated release is failing 🚨

🚨 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:

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.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Allow `scope` in the creation of conventional commit messages

Proposal

Conventional commits allows an optional scope e.g. chore(ci). It should be possible to specify a tag with a scope, or scope as an optional parameter.

Motivation

Since it is valid conventional commit syntax, it should be an allowed feature here.

Use cases and examples

This is coming from the all-contributors bot that fails to create a pull request if a scope is used as the commitType arg, presumably because it throws an error from this library.

Adding gitmoji as convention

Proposal

What do you think about adding gitmoji as convention type (https://gitmoji.dev/)
I can work on this if you want.

Motivation

Lots of repositories are now using gitmoji for their commits

Use cases and examples

All-contributors bot is using commit-conv to generate commit-message

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.