Git Product home page Git Product logo

gjallar's Introduction

image image image

Introduction

Msg formatting tool for git-commit based on Commitizen.

And you could check your committing files when pre-commit.

Installation

  1. edit package.json.
"scripts": {
        "commitmsg": "validate-commit-msg",
        "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
        "version": "npm run changelog && git add CHANGELOG.md"
    },
"devDependencies": {
        "@vanir/gjallar": "^1.0.9"
    },
"husky": {
    "hooks": {
        "pre-commit": "lint-staged"  // if you want to use git-hook
        }
    },
"config": {
    "commitizen": {
        "path": "node_modules/@vanir/gjallar"
        }
    }
  1. install or update cypher.
npm install
  1. create file.lintstagedrc.jsonin ./ and add it.
{
    "src/*.js": [
        "prettier --write", // if use prettier
        "tsc",  // if use typescript
        "commitmsg",
        "git add"
        // able to add some commands,like jest
        ]
}
  1. if you want to use prettier, should create file.prettierrcin ./ and add it.
{
    "tabWidth": 4,
    "singleQuote": true,
    "semi": true,
    "printWidth": 120
}

Todo List

pre-commit check

  • husky
  • commit-lint
  • lint-stage
  • prettier
  • TSLint/ESLint

multi-language

  • Chinese Language Config
  • English Language Config

gjallar's People

Contributors

koyoshiro avatar

Watchers

 avatar  avatar

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.