misspell-codeclimate
Turn that misspell report into a GitLab compatible Code Climate report for annotated merge requests.
Quick Start
Generate a misspell report by scanning your repository:
misspell -locale UK docs > misspell-report.txt
Then generate a Code Climate report:
misspell-codeclimate --file misspell-report.txt > codeclimate-report.json
Install
Homebrew
To use Homebrew:
brew install purpleclay/tap/misspell-codeclimate
Scoop
To use Scoop:
scoop bucket add purpleclay https://github.com/purpleclay/scoop-bucket.git
scoop install misspell-codeclimate
Apt
To install using the apt package manager:
echo 'deb [trusted=yes] https://fury.purpleclay.dev/apt/ /' | sudo tee /etc/apt/sources.list.d/purpleclay.list
sudo apt update
sudo apt install -y misspell-codeclimate
You may need to install the ca-certificates
package if you encounter trust issues with regards to the gemfury certificate:
sudo apt update && sudo apt install -y ca-certificates
Yum
To install using the yum package manager:
echo '[purpleclay]
name=purpleclay
baseurl=https://fury.purpleclay.dev/yum/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/purpleclay.repo
sudo yum install -y misspell-codeclimate
Aur
To install from the aur using yay:
yay -S misspell-codeclimate-bin
Bash Script
To install the latest version using a bash script:
curl https://raw.githubusercontent.com/purpleclay/misspell-codeclimate/main/scripts/install | bash
A specific version can be downloaded by using the -v
flag. By default the script uses sudo
, which can be turned off by using the --no-sudo
flag.
curl https://raw.githubusercontent.com/purpleclay/misspell-codeclimate/main/scripts/install | bash -s -- -v v0.1.0 --no-sudo