Skip to main content

Inline your lint messages

Project description

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

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

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.
  • 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

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2015-12-13)

  • First release on PyPI.

Project details


Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
inlineplz-0.12.1.zip (206.7 kB) Copy SHA256 hash SHA256 Source None Apr 12, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page