https://github.com/fromkk/spellchecker

SpellChecker for Xcode
https://github.com/fromkk/spellchecker

cli spellchecker swift swift5 swift5-1 typo xcode xcode11

Last synced: 2 months ago
JSON representation

SpellChecker for Xcode

• Host: GitHub
• URL: https://github.com/fromkk/spellchecker
• Owner: fromkk
• License: mit
• Created: 2019-11-23T14:44:42.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-16T13:18:05.000Z (over 2 years ago)
• Last Synced: 2023-03-24T06:18:11.390Z (almost 2 years ago)
• Topics: cli, spellchecker, swift, swift5, swift5-1, typo, xcode, xcode11
• Language: Swift
• Size: 1.98 MB
• Stars: 86
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  SpellChecker for Xcode

![GitHub Actions](https://github.com/fromkk/SpellChecker/workflows/CI/badge.svg)

![LICENSE](https://img.shields.io/github/license/fromkk/SpellChecker)

![Tag](https://img.shields.io/github/v/tag/fromkk/SpellChecker)

![screenshot](./images/screenshot.png)

## Recommended environment

- Swift 5.1

- Xcode 11.2.1

- macOS 10.15

## Install

### Mint

```shllscript

mint install fromkk/[email protected] SpellChecker

```

### Manual

```shellscript

git clone [email protected]:fromkk/SpellChecker.git

cd ./SpellChecker

make install

```

## Usage

Write to your `Run script` like a below code.

```shellscript

if ! [ -f /usr/local/bin/SpellChecker ]; then

    echo "SpellChecker not installed"

    exit 0

fi

git_path=/usr/local/bin/git

files=$($git_path diff --diff-filter=d --name-only -- "*.swift" "*.h" "*.m")

if (test -z $files) || (test ${#files[@]} -eq 0); then

  echo "no files changed."

  exit 0

fi

options=""

for file in $files

do

  options="$options $SRCROOT/$file"

done

/usr/local/bin/SpellChecker -- $options

```

### Whitelist

If you want ignore some warnings, make YAML file to your directory.  

For example:

```yaml

whiteList:

  - kazuya

  - ueoka

  - fromkk

```

And set `--yml` options.

```shellscript

/usr/local/bin/SpellChecker --yml $SRCROOT/swift-keywords.yaml -- $options

```