Git Product home page Git Product logo

lintush's Introduction

Lintush - Commit made easy ๐Ÿฆ„

Lintush uses commitlint to help you write standard commit messages

Quick start

npm i -g lintush
-- OR --
npm i -D lintush

  1. Run lintush --init in your project root to create a lintush-config.js file.
  2. Edit lintush-config.js to fit your lint demands.
  3. Make sure your project has a commitlint.config.js file with a scope-enum [required]

Writing commit messages

Run lintush in your project directory to write your amazing commit message ๐Ÿฆ„๐Ÿฆ„๐Ÿฆ„

You can run lintush && git commit -F .git/COMMIT_EDITMSG to automatically commit, or run lintush && git commit -F .git/COMMIT_EDITMSG -e to edit your commit message after Lintush is done.

lintush's People

Contributors

chezihp avatar dependabot[bot] avatar segevofer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

lintush's Issues

Not supporting scopes of extended configurations

Great job.

I was playing with this in one of my projects, but wasn't able to get started (got an error instead).

That's my configuration:
commitlint.config.js:

const Configuration = {
  extends: ['@commitlint/config-conventional'],
  parserPreset: 'conventional-changelog-atom',
  defaultIgnores: true
};

module.exports = Configuration;

I'm getting this error:

(node:38215) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'scope-enum' of undefined
    at Object.<anonymous> (/Users/***/lintush-config.js:4:58)
    at Module._compile (internal/modules/cjs/loader.js:721:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:732:10)
    at Module.load (internal/modules/cjs/loader.js:620:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:560:12)
    at Function.Module._load (internal/modules/cjs/loader.js:552:3)
    at Module.require (internal/modules/cjs/loader.js:657:17)
    at require (internal/modules/cjs/helpers.js:20:18)
    at /Users/***/node_modules/lintush/src/lintush.js:69:25

It's related to the fact it does not recognise scope-enum while extending from a parent configuration.

Is it possible to link with husky?

Is it possible to link with husky?

Endless loop

lintush && git commit -F .git/COMMIT_EDITMSG

module.exports = {
    hooks: {
        "pre-commit": "yarn test",
    }
}

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.