CLI tilvísun

Yfirlit

snapper [OPTIONS] [FILE...]
snapper init [--dry-run]
snapper sdiff [--no-color] [-f FORMAT] <OLD> <NEW>
snapper git-diff [--no-color] [-f FORMAT] [REF] [FILE...]
snapper watch [-f FORMAT] <PATTERNS...>
snapper lsp

Ef engar skrár eru gefnar les snapper af stdin og skrifar á stdout.

Valkostir

-f, --format <FORMAT>

Inntakssnið. Eitt af: org, latex, markdown, plaintext.

Sjálfgreinist frá skráarendingu þegar sleppt er. Sjálfgefið er plaintext fyrir stdin.

--stdin-filepath <PATH>

Gera ráð fyrir þessu skráarheiti þegar lesið er af stdin, fyrir sjálfvirka sniðgreiningu. Gagnlegt fyrir samþættingu ritla sem pípa innihald biðminnis.

Dæmi: cat paper.org | snapper --stdin-filepath paper.org

-o, --output <FILE>

Skrifa úttak í skrá í stað stdout.

-i, --in-place

Breyta inntaksskrám á staðnum. Krefst skráarviðfanga (ekki stdin).

-w, --max-width <N>

Hámarkslínubreidd. Setningar sem fara yfir þessa breidd eru umbrotnar við orðamörk með textwrap. Sjálfgefið: 0 (ótakmarkað). Virðir einnig max_line_length úr .editorconfig ef til staðar.

--check

Prófunarstilling fyrir CI. Hættir með kóða 1 ef einhver skrá myndi breytast, án þess að breyta neinu. Prentar slóðir skráa sem myndu endursníðast á stderr.

--diff

Sýna sameinaðan diff af því sem myndi breytast, án þess að breyta neinu. Gagnlegt til rýni áður en lagt er inn. Hættir með kóða 1 ef einhver skrá myndi breytast.

--range <START:END>

Aðeins sníða línur innan tiltekins bils (1-númerað, meðtalið). Línur utan bilsins fara í gegn óbreyttar. Gagnlegt fyrir samþættingu sniðvals í ritli.

Dæmi: snapper --range 10:20 paper.org

--output-format <text|json|sarif>

Úttakssnið fyrir --check stillingu. Sjálfgefið: text (prentar skráarnöfn á stderr).

  • json : skilar JSON-fylki með skráarslóðum og línufjölda

  • sarif : skilar SARIF v2.1.0 fyrir GitHub Code Scanning samþættingu

--neural

Nota taugakerfisstuðða setningargreiningu gegnum nnsplit (bæta-stigs LSTM, tract-bakendi). Hleður niður og vistar eredlíkanið (~4MB) í ~/.cache/nnsplit/ við fyrstu notkun. Reglubundin greining er áfram sjálfgefin (hraðvirkari, betri meðhöndlun skammstafana). Taugakerfisgreining er yfirburða fyrir texta á öðrum tungumálum en ensku.

--lang <CODE>

Tungumál fyrir taugakerfissetningargreiningu. Sjálfgefið: en. Tiltæk: en, de, fr, no, sv, zh, tr, ru, uk.

--model-path <PATH>

Slóð að sérsniðinni ONNX eredlíkansskrá fyrir taugakerfisgreiningu. Yfirgegnir --lang.

--config <PATH>

Slóð að .snapperrc.toml stillingarskrá. Þegar sleppt er leitar snapper frá núverandi möppu og upp á við.

-h, --help

Prenta hjálparskilaboð.

-V, --version

Prenta útgáfunúmer.

Undirskipanir

snapper init

Frumstilla snapper fyrir verkefni. Greinir hvaða textasnið eru til staðar í möpputrénu og býr til:

  • .snapperrc.toml með skynsamlegum sjálfgildum

  • .gitattributes færslur fyrir git smudge/clean síuna

  • pre-commit hook bútur

  • Apheleia (Emacs) stillingabútur

Notaðu --dry-run til að forskoða án þess að skrifa skrár.

snapper sdiff <OLD> <NEW>

Sentence-level diff between two files. Parses both files, extracts sentences, diffs at sentence granularity. Whitespace reflow produces zero diff. Colored output by default; use --no-color to disable. Exits with code 1 if differences found.

snapper git-diff [REF] [FILE...]

Sentence-level diff against a git ref. Default ref: HEAD. If no files specified, diffs all changed prose files (.org, .tex, .md). Uses git show REF:path to retrieve the old version.

snapper watch <PATTERNS...>

Watch files and auto-reformat on save. Accepts file paths or glob patterns. 200ms debounce to avoid reformatting during rapid saves. Press Ctrl+C to stop.

snapper lsp

Start the Language Server Protocol server on stdin/stdout. Provides document formatting, range formatting, and diagnostics (flags lines with multiple sentences). Works with any LSP-compatible editor (Neovim, Emacs eglot, VS Code, Helix).

Útgangskóðar

  • 0 : Tókst (eða --check / --diff án breytinga)

  • 1 : --check eða --diff fann skrár sem myndu breytast, eða einhver villa