kapi check
kapi check [files...]Kjør innholdskontroller over én eller flere filer og returner strukturerte funn pluss en dom (bestått, ikke bestått, eller ble ikke kjørt), med kontroll på alvorlighetsgrad: det innholdsbaserte motstykket til en testløper.
Standard kontrollsett er på kildesiden og trenger ingen oversettelse: teksthygiene (tomme felt, doble mellomrom/ord, overflødige blanktegn), lengdegrenser (--max-chars/ --max-words), forbudte/påkrevde mønstre (--forbid/--require), og ordforråd fra profil når en profil er bundet (--profile/--pack/--profile-file).
Tosspråklige kontroller (ikke-oversett, plassholder-integritet) er opt-in: send --target <file> --target-lang <lang> for å kontrollere et oversatt mål mot kilden.
Hvert funn har en stabil regel-id (<check>.<category>) og en blokk-lokasjon, slik at en assistent kan rette den eksakte blokken og spore regler på tvers av iterasjoner. Utdata er en lesbar tabell som standard; --output-format json|yaml sender ut kapi.check/v1 Report. Konfigurasjonsadvarsler, som en ukjent nøkkel i en stemprofil, vises etter dommen og fyller rapportens warnings-array. De peker på konfigurasjon som må rettes og endrer aldri poengsummen, grensekontrollen eller avslutningstilstanden.
Posisjonsbaserte stier godtar glob-mønstre og kataloger, utvidet av kapi selv.
Sett mønsteret i anførselstegn og ** rekurserer likt i alle skall. Inne i et .kapi
prosjekt sjekker check uten filargumenter prosjektets deklarerte innhold;
navngitte filer begrenser det til disse.
Prosjektgrensemodus (--ship): kjører prosjektets bundne kvalitetsporter (stemme, terminologi, regelbaserte kontroller) pluss prosjektets leverings-/kildedekningsporter over prosjektets innhold, og avslutter med ikke-null når en port ikke er oppfylt: terskelen før utsendelse. Måldrift blokkerer aldri et ordinært bygg (se 'kapi status'); --ship er det eksplisitte, opt-in håndhevingspunktet. Uten filargumenter kontrollerer det prosjektets kildebaserte innhold og deklarerte kilde-/målpar. Navngitte kildefiler får innholdskontroller; navngitte mål beholder sin kildeparring.
Diff-omfang (--diff-file, --diff-against, --staged, --diff-range): kontroller bare de innholdsblokker en unified diff berører, hver blokk hel, og rapporter linjene hver spenner over. Alle filer diff-en navngir er listet med hva som skjedde med dem: kontrollert, urørt, utenfor omfang (inne i et prosjekt, innhold oppskriften ikke deklarerer), slettet, eller ble ikke kjørt (en endret fil hvis blokker ikke kan lokaliseres). --diff-file leser en diff fra en fil, eller fra standard inn med -. --diff-against kjører git diff mot en revisjon, skrivebeskyttet, og behandler sporede filer som lagt til. --staged kontrollerer hva et commit gjort nå ville registrere: de stagede endringene, hver fil lest fra indeksen, uten ustaged endringer og usporede filer. --diff-range A..B kontrollerer endringen mellom to commits, og A...B endringen B gjorde siden den forlot A, hver fil lest fra B, slik at det leser ingenting fra arbeidskopitreet og kjører likt fra enhver checkout. Oppskriften, stemprofiler og termer på disk styrer alle disse kontrollene. Navngitte filer begrenser omfanget. Sløyfen for en agent: rediger, kjør 'kapi check --diff-against HEAD', reparer, kjør den igjen. En pre-commit-hook kjører 'kapi check --staged', og en pull request-kontroll kjører 'kapi check --diff-range origin/main...HEAD'.
Avslutningstilstander: 0 bestått, 3 når porten ikke er oppfylt, 4 når kontrollen ikke ble kjørt, 1 operasjonell. En kontroll ble ikke kjørt når den ikke undersøkte noe innhold, eller når én av dens kontroller ikke rapporterte noe på det kjente feilaktige eksempelet den får ved siden av innholdet. --no-fail avslutter med 0 når porten ikke er oppfylt (rapportmodus for en rettesløyfe); verken det eller --lenient gjør en kontroll som ikke ble kjørt til et bestått resultat.
Runs in your browser against a small sample file. Edit the command before running, or press Run to execute it as shown.
kapi check| Flag | Type | Default | Description |
|---|---|---|---|
| --diff-against | string | kontroller bare innholdsblokker som er endret siden denne git-revisjonen, inkludert usporede filer (kjører git diff skrivebeskyttet) | |
| --diff-file | string | kontroller bare innholdsblokker som denne unified diff berører (en fil, eller - for standard inn) | |
| --diff-range | string | kontroller bare de innholdsblokker som er endret mellom to commits, A..B eller A...B (siden merge-basen), hver fil lest fra B og ingenting fra arbeidskopitreet | |
| --dnt | stringSlice | do-not-translate-termer som må overføres uendret til målspråket (med --target) | |
| --forbid | stringSlice | regulært uttrykk som IKKE skal forekomme i innholdet (kan gjentas) | |
| --gate | stringSlice | med --ship: kjør bare de navngitte prosjektportene (voice, terminology, qa); kan gjentas | |
| --locale | string | med --ship: begrens målsideportene til én enkelt målspråkkode (f.eks. fr) | |
| --max-chars | int | 0 | flagg innhold som er lengre enn dette antallet tegn (0 = av) |
| --max-words | int | 0 | flagg innhold med flere ord enn dette (0 = av) |
| --no-fail | bool | false | avslutt med 0 selv om gaten feiler (fix-loop-modus) |
| --pack | string | innebygd startpakke for merkevare | |
| --profile | string | navn på stemprofil fra det lokale lageret | |
| --profile-file | string | sti til en stemmeprofilens YAML | |
| --project , -p | string | sti til en kapi.yaml-prosjektoppskrift eller dens katalog (oppdages automatisk fra gjeldende katalog hvis utelatt) | |
| --require | stringSlice | regex som MÅ finnes i innholdet (kan gjentas) | |
| --ship | bool | false | prosjekt-gate-modus: kjør prosjektets tilknyttede gates (voice-profil, terminologi, regelbaserte kontroller) samt ship/kildedekningsgatene; avslutt med ikke-null når krav ikke er oppfylt: terskelen for forhåndsutgivelse |
| --source-lang | string | kildespråk (f.eks. en, en-US; standardverdi er prosjektets source_language, ellers en) | |
| --staged | bool | false | kontroller bare de innholdsblokker de stagede endringene berører, hver fil lest fra indeksen (utelater ustaged endringer og usporede filer) |
| --target | string | oversatt målfil som kontrolleres mot (én enkelt) kildefil, aktiverer tospråklige kontroller | |
| --target-lang | string | språkkode for --target-filen (f.eks. de) | |
| --termstore | string | med --ship: navngitte termer eller sti til termstore for terminologiporten (bruker prosjektets termstore som standard) | |
| --validate | string | off | validering av leserstruktur/koding: off|report|strict (report samler struktur.*-/koding.*-funn i rapporten; strict feiler også porten ved et Major+-struktur/koding-problem) |
| --voice | bool | false | kjør også stemme/stillikhets-kontrollen (krever tillegget kapi-check og en profil med eksempler) |
| --voice-min | float64 | 0.8 | nedre grense for stemmelikhet (cosinus, 0–1) under hvilken en blokk flagges som utenfor stemprofil |
← Back to the Command Reference