misspell

Correct commonly misspelled words in source files.

Version

v0.3.4

Runtime

Alpine Linux 3.7

Supported Languages

All Languages

Official Documentation

https://github.com/client9/misspell

YAML Configuration

misspell:

  • input:

    Patterns to include in execution and reports.

  • ignore:

    Patterns to exclude from execution and reports.

  • auto-fix:

    true/false

    Specifying true implies -w option.

  • config-file:

    N/A

  • options:

    Below is the list of options that are supported:

    -i string
        ignore the following corrections, comma separated
    -locale string
        Correct spellings using locale perferances for US or UK.  Default is to use a neutral variety of English.  Setting locale to US will correct the British spelling of 'colour' to 'color'
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.25 CPU with 960 MiB RAM.

      Inspecode automatically specifies -j option to misspell according to this value. For example, -j 1 is specified by default (for 0.25 CPU), -j 2 is specified for 1.1 CPU.

YAML Examples

  • With default options:

    inspecode:
      misspell: default
  • With enabling auto-fixing and default options:

    inspecode:
      misspell: auto-fix
  • With custom machine:

    inspecode:
      misspell:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
  • With custom options:

    inspecode:
      misspell:
        options:
          -locale: US

results matching ""

    No results matching ""