Git Product home page Git Product logo

node-energy-pre-commit-hooks's Introduction

node-energy-pre-commit-hooks

This is a collection of our custom pre-commit hooks.

The structure of this package is inspired by pre-commit's own hook collection: https://github.com/pre-commit/pre-commit-hooks/

You can find more information on pre-commit here: https://pre-commit.com/

Using pre-commit-hooks with pre-commit

Add this to your .pre-commit-config.yaml

-   repo: https://github.com/node-energy/node-energy-pre-commit-hooks
    rev: 0.2.0  # Use the ref (branch or tag of this repo) you want to point at
    hooks:
    -   id: liccheck-pipenv
        args: ...
    # -   id: ...

Hooks available

liccheck-pipenv

Creates a temporary requirements.txt file from the Pipfile.lock and uses this to run liccheck.

  • You can pass the path to your liccheck strategy.ini as argument: args: [--strategy, path/to/strategy.ini]. The default is strategy.ini
  • This hook may fail if your environment is not in sync with Pipfile.lock. In this case, do a pipenv sync --dev.

Adding new hooks

To add a new hook:

  1. Create a script in the package folder
  2. Add an entry point for that script to the [tool.poetry.scripts] section of pyproject.toml
  3. Add the configuration to .pre-commit-hooks.yaml (documentation)
  4. Add a new tag to this repo and push it to Github.

node-energy-pre-commit-hooks's People

Contributors

larsrinn avatar barisx avatar fabianallendorf 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.