https://github.com/codingjoe/relint

Write your own linting rules using regular expressions.
https://github.com/codingjoe/relint

hacktoberfest lint linter qa qatools regex

Last synced: about 2 months ago
JSON representation

Write your own linting rules using regular expressions.

• Host: GitHub
• URL: https://github.com/codingjoe/relint
• Owner: codingjoe
• License: mit
• Created: 2018-03-30T22:45:40.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-24T12:29:00.000Z (2 months ago)
• Last Synced: 2024-03-25T08:44:05.380Z (2 months ago)
• Topics: hacktoberfest, lint, linter, qa, qatools, regex
• Language: Python
• Homepage:
• Size: 75.2 KB
• Stars: 49
• Watchers: 4
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Lists

• static-analysis - relint

README

        
![/(re)lint/](https://repository-images.githubusercontent.com/127479533/061e8bfe-f0e0-4f0b-857b-eae82f9df6af)

# reLint

**Regular Expression Linter**

*Write your own linting rules using regular expressions.*

[![PyPi Version](https://img.shields.io/pypi/v/relint.svg)](https://pypi.python.org/pypi/relint/)

[![Test Coverage](https://codecov.io/gh/codingjoe/relint/branch/main/graph/badge.svg)](https://codecov.io/gh/codingjoe/relint)

[![GitHub License](https://img.shields.io/github/license/codingjoe/relint)](https://raw.githubusercontent.com/codingjoe/relint/main/LICENSE)

## Installation

```shell-session

python3 -m pip install relint

```

## [Examples & Recipes – The reLint Cookbook](https://github.com/codingjoe/relint/blob/main/COOKBOOK.md)

## Usage

You can write your own regular rules in a YAML file, like so:

```yaml

- name: No ToDo

  pattern: '(?i)todo' # case insensitive flag

  hint: Get it done right away!

  filePattern: .*\.(py|js)

  error: false

```

The `name` attribute is the name of your linter, the `pattern` can be

any regular expression. The linter does lint entire files, therefore

your expressions can match multiple lines and include newlines.

You can narrow down the file types your linter should be working with,

by providing the optional `filePattern` attribute. The default is `.*`.

The optional `error` attribute allows you to only show a warning but not

exit with a bad (non-zero) exit code. The default is `true`.

The following command will lint all files in the current directory:

```shell

relint -c .relint.yml FILE FILE2 ...

```

The default configuration file name is `.relint.yml` within your working

directory, but you can provide any YAML or JSON file.

If you prefer linting changed files (cached on git) you can use the

option `--diff [-d]` or `--git-diff [-g]`:

```shell

git diff --unified=0 | relint my_file.py --diff

```

### pre-commit

You can automate the linting process by adding a

[pre-commit](https://pre-commit.com/) hook to your project. Add the

following entry to your `.pre-commit-config.yaml`:

```yaml

- repo: https://github.com/codingjoe/relint

  rev: 1.4.0

  hooks:

    - id: relint

      args: [-W]  # optional, if you want to fail on warnings during commit

```