Lint for likely-malformed reference style links · rust-lang/rust-clippy#1952

(4 comments) (0 reactions) (0 assignees)Rust (1.391 forks)batch import

A-documentationA-lintL-correctnessT-ASTgood first issue

Métricas do repositório

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.

Direção de pesquisa: Implemente um novo lint do Clippy que verifica definições de links de estilo referência em markdown onde parênteses são usados em vez de dois pontos após o rótulo de referência. O lint deve acionar apenas se a linha for independente e o rótulo de referência for válido.
Pilha de tecnologia: rust
Domain: tooling
Tipo Issue: Funcionalidade
Difficulty: 3
Tempo estimado: Meio dia
Status da atividade: Ativo
Clarity: Claro
Prerequisites: Rust
Simpatia para novatos: 70