Skip to main content

Code review from any linter!

Project description

lint_review

Plug in any linter for a code review!

Features:

  • Creates merge request comments according to linter comments
  • Easy to expand to any linter - just pass --custom-pattern with a regex capturing the important parts of the linter errors.
  • Automatically resolves any comments that are no longer relevant.

Usage:

  • Create an access token with api premissions
  • Pipe your linter into lint_review as part of your merge request CI
  • Make a few mistakes (we all do)
  • Fix the comments as they pop up
Full interface
usage: lint_review [-h] [--linter {flake8,mypy}] --reviewer {dry,gitlab}
                   [--custom_pattern CUSTOM_PATTERN] [--token TOKEN]
                   [--project PROJECT] [--merge_request MERGE_REQUEST]

optional arguments:
  -h, --help            show this help message and exit
  --linter {flake8,mypy}
                        Name of the linter to use
  --reviewer {dry,gitlab}
                        The service used to review the code
  --custom_pattern CUSTOM_PATTERN
                        A custom regex pattern to capture comments. The
                        pattern must have the named capture groups: {'line',
                        'message', 'path'} and optionally col

gitlab:
  --token TOKEN         API token for gitlab, Is required for gitlab usage
  --project PROJECT     Project ID of the merge request, defaults to
                        enviroment variable set by pipeline.
  --merge_request MERGE_REQUEST
                        Internal ID of the merge request, defaults to
                        enviroment variable set by pipeline.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lint_review-0.1.3.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

lint_review-0.1.3-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file lint_review-0.1.3.tar.gz.

File metadata

  • Download URL: lint_review-0.1.3.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/4.19.78-coreos

File hashes

Hashes for lint_review-0.1.3.tar.gz
Algorithm Hash digest
SHA256 625fd6baa80339f059bae43c52e61c7c38caac720cd2f8fa53e69bb324dcc700
MD5 15edf568d99ecb470c07ce6d41664890
BLAKE2b-256 9a13257b99e1ad115b264abc5399e305a540dd3dfabf6a90eca2519fcdbb2764

See more details on using hashes here.

File details

Details for the file lint_review-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: lint_review-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/4.19.78-coreos

File hashes

Hashes for lint_review-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e91dcb4b103fe2ace951a0bb3b2000958b7326bb0df2ad12165aebcecfe69a8f
MD5 4591d1319b3da8b3b4a3ccc126d9c0a5
BLAKE2b-256 55afd967796e066d88237c2ecb2415f0adf0eac3ff2cb5456cd31d8ce8db24f3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page