https://github.com/guykisel/inline-plz

Inline your lint messages
https://github.com/guykisel/inline-plz

code-quality code-review linters python static-analysis

Last synced: 3 days ago
JSON representation

Inline your lint messages

• Host: GitHub
• URL: https://github.com/guykisel/inline-plz
• Owner: guykisel
• License: isc
• Created: 2016-01-09T16:37:10.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-01T15:58:14.000Z (about 1 month ago)
• Last Synced: 2024-12-22T23:27:28.892Z (11 days ago)
• Topics: code-quality, code-review, linters, python, static-analysis
• Language: XSLT
• Size: 59.4 MB
• Stars: 33
• Watchers: 4
• Forks: 14
• Open Issues: 62
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
==========

inline-plz

==========

.. image:: https://img.shields.io/pypi/v/inlineplz.svg

        :target: https://pypi.python.org/pypi/inlineplz

.. image:: https://img.shields.io/travis/guykisel/inline-plz.svg

        :target: https://travis-ci.org/guykisel/inline-plz

Tired of reading through CI console logs to find your lint errors? Inline your lint messages in your diffs!

* Free software: ISC license

Github webhook bot

------------------

* https://github.com/guykisel/inline-plz-bot

Features

--------

* Run linters against your code and comment in your diffs at the failing lines

* Automatically run linters with reasonable default configs

* Easy to add new linter configurations

How to use

----------

::

  pip install inlineplz

  inline-plz --install --autorun

You probably want to run the above in a CI job, not in your regular development environment.

You'll also need to provide the following either in the command line or via environment variables:

* owner: the repo organization/owner

* repo: the repo name

* token: your auth token (encrypt this, don't put this in plaintext in any public configurations!)

* url: the url of your scm host

* interface: the type of scm host (such as github)

Dependencies:

* node.js / npm

* ruby / gem

* python / pip

* haskell / cabal

Configuration

-------------

Besides specifying options at the command line or in environment variables, you can also set them in a yaml file.

You can create a file in the root of your repo named ``.inlineplz.yml``

For example:

::

  ignore_paths:

    - node_modules

    - .tox

    - .git

  enabled_linters:

    - prospector

  disabled_linters:

    - markdownlint-cli

    - gherkin-lint

For more see the examples folder in the repo.

Known issues

------------

* Currently for Travis-CI usage, inline-plz only works for PRs within the original repo, not PRs from forks. This is because encrypted creds in Travis-CI configs are encrypted per repo, and cannot be decrypted in PRs from forks. You can work around this using the webhook bot at https://github.com/guykisel/inline-plz-bot

* Currently the inline-plz console output can print out some misleading stack traces

* Currently dependencies get installed globally unless you pre-create a virtualenv

* Commits directly to master are not currently supported - only PRs get linted

Contribute

----------

* Report bugs/suggest features

* Add/update docs

* Add support for more linters

Credits

-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage