Giter VIP home page Giter VIP logo

pre-commit-hooks's Introduction

pre-commit

Pre-commit custom hooks

Usage

Dependencies

$ pip3 install --user pre-commit

Optional dependencies

  • Python black $ pip3 install --user black
  • Python flake8 $ pip3 install --user flake8
  • Python bandit $ pip3 install --user bandit

Example Repo Config

$ cat .pre-commit-config.yaml 
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.2.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-yaml
    -   id: check-added-large-files
    -   id: detect-aws-credentials
    -   id: detect-private-key
-   repo: [email protected]:commit-bneyedli/pre-commit-hooks.git
    rev: bda7163e859a4c3a7a72f4e63c550481e58f04c9
    hooks:
    -   id: python-black
    -   id: python-flake8
    -   id: python-bandit

Repo init

$ pre-commit autoupdate
Updating https://github.com/pre-commit/pre-commit-hooks ... already up to date.
Updating [email protected]:commit-bneyedli/pre-commit-hooks.git ... [INFO] Initializing environment for [email protected]:commit-bneyedli/pre-commit-hooks.git.
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

Example usage

$ git commit -a
Trim Trailing Whitespace.................................................Passed
Fix End of Files.........................................................Passed
Check Yaml...........................................(no files to check)Skipped
Check for added large files..............................................Passed
Detect AWS Credentials...................................................Passed
Detect Private Key.......................................................Passed
Python black wrapper.....................................................Passed
Python flake8 wrapper....................................................Passed
Python bandit wrapper....................................................Passed

pre-commit-hooks's People

Contributors

commit-bneyedli avatar

Watchers

 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.