Content Lint check

Content Lint-kontrollen er den alltid-på halvparten av kapi check. Den leser kildeteksten i hver blokk alene, uten måltekst og uten sammenligning mot en språkkode, og rapporterer hva som er galt med innholdets form:

• hygiene.empty: blokken inneholder ingenting annet enn blanktegn. Alvorlig, og det eneste funnet som rapporteres for den blokken, fordi de øvrige ikke har noe å bedømme.
• hygiene.leading-whitespace og hygiene.trailing-whitespace: blanktegn på en kant som en forfatter har lagt igjen der.
• hygiene.double-spaces: to eller flere mellomrom mellom to innholdsdeler på én linje.
• hygiene.doubled-word: et ord som gjentas umiddelbart, sammenlignet uten hensyn til store og små bokstaver.
• hygiene.control-char: et løst kontrolltegn. Tab, vognretur og linjeskift er ordinære blanktegn og rapporteres ikke.

Alt unntatt tomhetsfunnet er mindre alvorlig, så et dokument med småfeil består likevel en vanlig kontroll og vises i poengsummen. Unntaket er et dobbelt mellomrom i en kommentar, som er alvorlig.

Hvert enkelt av disse er en vurdering av form, og form bedømmes over blokken snarere enn over ren tekst. En plassholder er innhold: den holder en posisjon, så mellomrommet ved siden av den skiller den fra et ord i stedet for å henge etter kanten av innholdet. Et inline-kode-spenn står som én enhet, så det en forfatter har skrevet inne i backticks er sitert, ikke bedømt – to mellomrom i et kode-spenn er eksempelet, ikke en feil. Og ett enkelt avsluttende linjeskift er innholdets linjeavslutning, som formater som et YAML-blokkskalar krever, så det er ikke blanktegn noen har lagt igjen.

Checkcontent-lint

Rule familyhygiene.*

SourceBuilt-in

Rules

A finding carries one of these rule ids. The family is hygiene, which differs from the check id the code registers.

Rule	Severity	Reports	Fix
hygiene.empty	major	The block holds nothing but whitespace. It is the only finding reported for that block, because the rest have nothing to judge.	Give the block content, or remove the block from the source.
hygiene.leading-whitespace	minor	Whitespace at the start of the block that an author left there.	Remove the leading whitespace from the source text.
hygiene.trailing-whitespace	minor	Whitespace at the end of the block, beyond a single terminating line break, that an author left there.	Remove the trailing whitespace from the source text.
hygiene.double-spaces	minor	Two or more spaces between two pieces of content on one line. In a comment the finding is major and covers a run of exactly two spaces.	Replace the run of spaces with one space.
hygiene.doubled-word	minor	A word immediately repeated, compared without regard to case. The finding quotes the word.	Remove the repeated word.
hygiene.control-char	minor	A stray control character, named by its code point. Tab, carriage return and line feed are ordinary whitespace and are never reported.	Remove the control character, or replace it with the character the text needs.

This check takes no flag of its own.

Processing notes

• Alltid på. Den trenger ingen konfigurasjon og har ingen bryter for å aktivere eller deaktivere den.

• Funn bærer den stabile regel-id-en hygiene.<category> og blokkens plassering, slik at en fikssløyfe kan adressere den eksakte blokken og spore en regel på tvers av iterasjoner.

• Regelen om dobbelt mellomrom ser bort fra en rekke mellomrom som rykker inn en fortsettelseslinje, fordi det er kildens linjestruktur snarere enn mellomrom inne i en setning.

• I en kommentar rapporterer regelen for dobbelt mellomrom bare en sekvens på nøyaktig to mellomrom mellom to tegn – ikke én som slutter der et ord begynner på linjen over eller under, og ikke én inne i backticks eller doble anførselstegn, fordi en kommentar legger ut tekst i kolonner og siterer bokstavelig tekst. Et dobbelt mellomrom som rapporteres, er alvorlig.

• Regelen for dobbelt ord rapporterer et gjentatt ord, så et gjentatt tegn eller symbol, notasjonen en forfatter mente å vise, er ikke et slikt.

Limitations

• Leser bare kildetekst; et misforhold mellom en kilde og dens oversettelse er spørsmålet for den tospråklige qa-kontrollen.

• Bedømmer form fremfor språk, og utfører ingen stave-, grammatikk- eller stilanalyse.

• Kjører over oversettbare blokker; innhold en leser presenterer som struktur eller kode blir aldri vurdert.

← Back to the Check Reference