rust-lang/rust-clippy

Lint for likely-malformed reference style links

Open

#1.952 geöffnet am 13. Aug. 2017

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (1.391 Forks)batch import
A-documentationA-lintL-correctnessT-ASTgood first issue

Repository-Metriken

Stars
 (10.406 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 19T 22h) (113 gemergte PRs in 30 T)

Beschreibung

I often come across the situation in markdown when I accidentally write the following:

[useful text][reference]

[reference](<example.com>)

This, though it might look like a reference style link, is not:

[useful text][reference]

reference

The correct syntax is as follows:

[useful text][reference]

[reference]: <example.com>

useful text

Clippy could lint against this likely-malformed reference link.

Notes:

  • This lint should only trigger if [reference](<link>) is on a line on its own (e.g. would be a valid reference target) and reference could be a valid reference key.
  • This lint should not trigger if there is any escaping of the in-text part of the reference which makes it not a valid reference link, even if it renders [like][so] in the output.
  • I don't think [bracketed][words] would ever be desired except in a code block about markdown, so this lint shouldn't have a lot of real-world false positives.

Contributor Guide

Research-Richtung
Implementieren Sie einen neuen Clippy Lint, der überprüft, ob in Markdown Referenzlink Definitionen nach dem Referenzlabel Klammern statt eines Doppelpunkts verwendet werden. Der Lint sollte nur ausgelöst werden, wenn die Zeile eigenständig ist und das Referenzlabel gültig ist.
Tech Stack
rust
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70