semvec/pypi-packages huggingface dataset:
lintmon 0.2.0
Monitor project files in the background for lint issues and flag issues in your prompt
License: Apache-2.0
Requires Python: >=3.8

# lintmon

A tool for monitoring for lint errors. Provides a configurable way to specify checks to run on code in a given directory when it changes on disk, run those checks in the background and provide a fast way to display the outcome of the latest checks with a concise format suitable for embedding in your prompt.

It is designed for lint errors because these are quick to run and affect single files at a time, so in general they can be checked in the background with relatively low system impact, but in principle you could use it to trigger any sort of validation check, such as running unit tests.

## Motivation

The two main ways of avoiding pushing lint errors to a repo it seemed to me were:

1. lint on save in your IDE
2. add git hooks on push to check for / fix lint errors

I didn't like either of those, because in both cases they happen synchronously while you are doing something and can cause disruptions. Also I push from the command line, so what I wanted was a warning at the point that I was going to push that was pre-calculated about errors.

This is that.

## Configure

Install lintmon using `pip` in your virtualenv (or wherever you install packages for use with your codebase):

    pip install lintmon

Add a file like the lintmon.yaml file in this codebase to the root directory of your codebase. It tells lintmon what checks to do on files. It aims to be very configurable.

Add the following to your prompt in your `.bashrc` or `.zshrc`:

    PS1='$([[ -e lintmon.yaml ]] && which lintmon-status-prompt >/dev/null && lintmon-status-prompt)'$PS1

That's it! `lintmon-status-prompt` will start `lintmond` automatically in the background when it is run, and from now on you should get a "badge" in your prompt when there are lint errors in your directory, which will be updated when you modify files.

## Commands

### `lintmon-status`

Output status of lintmon along with all current errors from the linters.

### `lintmon-stop`, `lintmon-start`

Tell lintmon to stop (and not restart automatically) or start again. Mostly useful for debugging lintmon. This will display an ` S ` badge in your prompt to tell you it is stopped.

### `lintmon-run-all`

Run all linters on all appropriate files in your project, thus "hydrating" lintmon's state if it hasn't been running for a while and changes have been made.

### `lintmond`

Run the daemon in the shell (again mainly useful for debugging).


## Directory structure

lintmon adds a `.lintmon` directory to your project directory where it stores all its state about what current errors there are, lintmon's pid etc. You will probably want to add this to your .gitignore.