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).
• chunk
  Chunk definition for what is going to be processed by the checkers
• cluster
  Cluster proc_macro2::Literals into LiteralSets
• errors
  Global error usage without cluttering each file.
• literal
• literalset
• markdown
  Erase cmark syntax
• span
  Span annotation, independent yet compatible with proc_macro2::Span
• tests
• util

Macros

• chyrp_dbg
  A debug helper to print concatenated length of all items.
• chyrp_up
  A helper macro creating valid doc string using the macro syntax #[doc=r#"..."#].
• fluff_up
  A helper macro creating valid doc string using the macro syntax /// ....

Structs

• Args
• CheckableChunk
  A chunk of documentation that is supposed to be checked.
• ChunkDisplay
  A display style wrapper for a trimmed literal.
• 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.
• LiteralSet
  A set of consecutive literals.
• 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.
• TrimmedLiteral
  A literal with meta info where the first and list whitespace may be found.
• TrimmedLiteralDisplay
  A display style wrapper for a trimmed literal.
• 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.
• Error
• ExitCode
  A simple exit code representation.
• SourceRange
  Describes whether there is a matching segment in the source, of if it is a placeholder for i.e. a code block or inline code. These placeholders are required for grammar checks.
• Sub
• UnifiedArgs
  Unified arguments with configuration fallbacks.

Functions

• apply_offset
  Apply an offset to start and end members, equaling a shift of the range.
• 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 Definitions

• Range
  Range based on usize, simplification.