twolfson/restructuredtext-lint

New check to enforce line length?

Open

#43 opened on Jan 16, 2018

View on GitHub
 (3 comments) (4 reactions) (0 assignees)Python (21 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (183 stars)
PR merge metrics
 (PR metrics pending)

Description

I would like to be able to lint my RST files for excessively long lines. Since this is likely to be controversial, the new check might best be ignored by default?

i.e. something similar to the flake8 code E501 for maximum line length, which can be configured at the command line:

  --max-line-length=n   Maximum allowed line length for the entirety of this
                        run. (Default: 79)

I would suggest using the same default line length (and double checking if this counts the new line character or not).

Contributor guide

Research direction
Implement a new lint rule that checks for maximum line length in RST files, similar to flake8's E501. The rule should be off by default and configurable via command line option max line length with a default of 79 characters.
Tech stack
python
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonreStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70