Crate cargo_spellcheck

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

action

Covers all user triggered actions (except for signals).

errors

Global error usage without cluttering each file.

util

Structs

Args

CheckableChunk

A chunk of documentation that is supposed to be checked.

Clusters

Cluster comments together, such they appear as continuous text blocks.

Common

Config

Documentation

Collection of all the documentation entries across the project

HunspellConfig

LanguageToolConfig

LineColumn

A line-column pair representing the start or end of a Span.

ManifestMetadata

ManifestMetadataSpellcheck

MultipleCheckerTypes

PlainOverlay

A plain representation of cmark riddled chunk.

Span

Relative span in relation to the beginning of a doc comment.

Suggestion

A suggestion for certain offending span.

SuggestionSet

A set of suggestions across multiple files, clustered per file

TinHat

Blocks (UNIX) signals.

UnknownCheckerTypeVariant

Enums

CheckerType

Checker types to be derived from the stringly typed arguments.

CommentVariant

Track what kind of comment the literal is

CommentVariantCategory

Determine if a CommentVariant is a documentation comment or not.

ConfigWriteDestination

ContentOrigin

Definition of the source of a checkable chunk

Detector

Bitflag of available checkers by compilation / configuration.

ExitCode

A simple exit code representation.

Sub

UnifiedArgs

Unified arguments with configuration fallbacks.

Functions

byte_range_to_char_range

Convert a given byte range of a string, that is known to be at valid char bounds, to a character range.

byte_range_to_char_range_many

Convert many byte ranges to character ranges.

condition_display_content

For long lines, literal will be trimmed to display in one terminal line. Misspelled words that are too long shall also be ellipsized.

derive_job_count

Set the worker pool job/thread count.

extract_delimiter

Extract line delimiter of a string.

generate_completions

get_terminal_size

Terminal size in characters.

iter_with_line_column

Iterate over annotated chars starting from line 1 and column 0 assuming s starts there.

iter_with_line_column_from

Iterate over a str and annotate with line and column.

load_span_from

Extract span from a Read-able source as String.

run

The inner main.

signal_handler

Handle incoming signals.

sub_char_range

Extract a subset of chars by iterating. Range must be in characters.

sub_chars

Extract a subset of chars by iterating. Range must be in characters.

Type Aliases

Range

Range based on usize, simplification.