Swiftpack.co - Package - ezura/spell-checker-for-swift

No more "Fix typo" commit...!

This command line tool can check spelling and show proposed correction.

Installation

Binary

We can download binary from here.

Makefile

$ git clone git@github.com:ezura/spell-checker-for-swift.git
$ cd spell-checker-for-swift
$ make

Mint

$ mint install ezura/spell-checker-for-swift@5.2.0

Usage

Command

typokana

Search typo in all swift files.
Show warning for typo on Xcode when this command is run at "Run Script".

typokana -diff

This command is recommended.
Search typo only in changed swift files (fetched with git diff).

typokana --language

Change the language to use for spell checking, e.g. "en_US" (defaults to using the system language). (typokana --language en_US)

typokana --help

(typokana --help)

OVERVIEW: Spell check

USAGE: typokana [options] argument

OPTIONS:
  --diff-only, -diff   Check only files listed by `git diff --name-only`
  --language, -l       The language to use for spell checking, e.g. "en_US" (defaults to using the system language).
  --help               Display available options

POSITIONAL ARGUMENTS:
  path                 Path of target file

How to ignore words

  1. Create file named ".typokana_ignore"
  2. Write ignored words with line breaks

For example, if you don't want to display warnings for "typokana", "json" and "yuka", please write following text in ".typokana_ignore".

typokana
json
yuka

TODO

  • [x] edit the list of words to ignore

Github

link
Stars: 54

Used By

Total: 0

Releases

Follow Swift5.2 - 2020-04-03 05:39:35

What

  • Updated for Swift 5.2: https://github.com/ezura/spell-checker-for-swift/pull/17 @nicholaslythall
  • Improved --diff-only: https://github.com/ezura/spell-checker-for-swift/pull/15 @nicholaslythall

1.2 - 2019-11-03 03:20:01

  • Follow Swift5.1 https://github.com/ezura/spell-checker-for-swift/pull/12
  • Added command line option to specify the language to use for spell checking https://github.com/ezura/spell-checker-for-swift/pull/9 (@nicholaslythall )
  • up swift-package-manager dependency version https://github.com/ezura/spell-checker-for-swift/pull/8 (@BNTR )

1.0 - 2019-05-06 06:57:47

Can set ignored words list

Add option (`--diff-only`) - 2019-05-06 04:47:30

- 2019-04-29 13:37:46