Crate cargo_spellcheck
source ·Expand description
cargo-spellcheck
A syntax tree based doc comment and common mark spell checker.
Re-exports§
pub use doc_chunks as documentation;
pub use self::action::*;
Modules§
- Covers all user triggered actions (except for signals).
- Global error usage without cluttering each file.
Structs§
- A chunk of documentation that is supposed to be checked.
- Cluster comments together, such they appear as continuous text blocks.
- Collection of all the documentation entries across the project
- A line-column pair representing the start or end of a
Span
. - A plain representation of cmark riddled chunk.
- Relative span in relation to the beginning of a doc comment.
- A suggestion for certain offending span.
- A set of suggestions across multiple files, clustered per file
- Blocks (UNIX) signals.
Enums§
- Checker types to be derived from the stringly typed arguments.
- Track what kind of comment the literal is
- Determine if a
CommentVariant
is a documentation comment or not. - Definition of the source of a checkable chunk
- Bitflag of available checkers by compilation / configuration.
- A simple exit code representation.
- Unified arguments with configuration fallbacks.
Functions§
- Convert a given byte range of a string, that is known to be at valid char bounds, to a character range.
- Convert many byte ranges to character ranges.
- For long lines, literal will be trimmed to display in one terminal line. Misspelled words that are too long shall also be ellipsized.
- Set the worker pool job/thread count.
- Extract line delimiter of a string.
- Terminal size in characters.
- Iterate over annotated chars starting from line 1 and column 0 assuming
s
starts there. - Iterate over a str and annotate with line and column.
- Extract
span
from aRead
-able source asString
. - The inner main.
- Handle incoming signals.
- Extract a subset of chars by iterating. Range must be in characters.
- Extract a subset of chars by iterating. Range must be in characters.
Type Aliases§
- Range based on
usize
, simplification.