Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 2.56 KB

pre-commit-hooks.md

File metadata and controls

101 lines (69 loc) · 2.56 KB
title draft type layout menu
pre-commit hooks
false
docs
single
docs
weight
120

pre-commit hooks

pre-commit is a framework for building and running git hooks. See the official documentation for more information: pre-commit.com

This document provides a list of available pre-commit hooks provided by Poetry.

{{% note %}} If you specify the args: for a hook in your .pre-commit-config.yaml, the defaults are overwritten. You must fully specify all arguments for your hook if you make use of args:. {{% /note %}}

poetry-check

The poetry-check hook calls the poetry check command to make sure the poetry configuration does not get committed in a broken state.

Arguments

The hook takes the same arguments as the poetry command. For more information see the [check command]({{< relref "cli#check" >}}).

poetry-lock

The poetry-lock hook calls the poetry lock command to make sure the lock file is up-to-date when committing changes.

Arguments

The hook takes the same arguments as the poetry command. For more information see the [lock command]({{< relref "cli#lock" >}}).

poetry-export

The poetry-export hook calls the poetry export command to sync your requirements.txt file with your current dependencies.

{{% note %}} It is recommended to run the poetry-lock hook prior to this one. {{% /note %}}

Arguments

The hook takes the same arguments as the poetry command. For more information see the [export command]({{< relref "cli#export" >}}).

The default arguments are args: ["-f", "requirements.txt", "-o", "requirements.txt"], which will create/update the requirements.txt file in the current working directory.

You may add verbose: true in your .pre-commit-config.yaml in order to output to the console:

hooks:
  - id: poetry-export
    args: ["-f", "requirements.txt"]
    verbose: true

Also, --dev can be added to args to write dev-dependencies to requirements.txt:

hooks:
  - id: poetry-export
    args: ["--dev", "-f", "requirements.txt", "-o", "requirements.txt"]

Usage

For more information on how to use pre-commit please see the official documentation.

A full .pre-commit-config.yaml example:

repos:
  - repo: https://github.com/python-poetry/poetry
    rev: ''  # add version here
    hooks:
      - id: poetry-check
      - id: poetry-lock
      - id: poetry-export
        args: ["-f", "requirements.txt", "-o", "requirements.txt"]