Integracja z vale¶

Przegląd¶

Snapper zawiera pakiet stylów vale z dwiema regułami, które oznaczają linie wymagające semantycznych podziałów wierszy. Dla precyzyjnego wymuszania użyj snapper --check bezpośrednio w CI.

Konfiguracja pakietu stylów¶

Dodaj styl snapper vale do swojego .vale.ini:

StylesPath = /path/to/snapper/vale
MinAlertLevel = suggestion

[*.org]
BasedOnStyles = snapper

[*.tex]
BasedOnStyles = snapper

[*.md]
BasedOnStyles = snapper

Dołączone reguły¶

SemanticLineBreaks: Oznacza linie zawierające wiele zdań (kropka, po której następuje spacja i wielka litera w tej samej linii).

Poziom: ostrzeżenie.

LongProseLine: Oznacza linie tekstu przekraczające 120 znaków.

Poziom: sugestia.

Precyzyjne wymuszanie w CI¶

Reguły vale korzystają z heurystyk opartych na wyrażeniach regularnych. Dla dokładnego sprawdzania użyj bezpośrednio formatera:

snapper --check paper.org

Pozwala to wykryć wszystkie przypadki pomijane przez reguły regex (skróty, tokeny inline itp.).

Łączenie vale i snapper¶

Typowy przepływ pracy:

vale wykrywa problemy stylistyczne (AI tells, hedging, E-Prime) podczas edycji
snapper wymusza formatowanie podziałów wierszy w CI za pomocą --check
Hook pre-commit uruchamia oba narzędzia:

- repo: https://github.com/TurtleTech-ehf/snapper
  rev: v0.1.0
  hooks:
    - id: snapper
- repo: https://github.com/errata-ai/vale
  rev: v3.0.0
  hooks:
    - id: vale