typoci / spellcheck-action Goto Github PK

View Code? Open in Web Editor NEW

38.0 2.0 8.0 2.18 MB

GitHub Action for checking code & Pull Requests for spelling mistakes

License: MIT License

Dockerfile 1.50% Ruby 98.42% Shell 0.08%

github-action ruby code-quality docker actionshackathon

spellcheck-action's Introduction

Typo CI - Spellcheck Action

Checks for spelling mistakes within code via a GitHub Action

👉 If you'd like to use this Action without having to add any files to your repository, consider the Typo CI GitHub App 👈

Installation

Copy add the following to .github/workflows/spellcheck.yml:

# Add to: .github/workflows/spellcheck.yml
name: Typo CI

on:
  push:
    branches-ignore:
      - master
jobs:
  spellcheck:
    name: Typo CI (GitHub Action)
    runs-on: ubuntu-latest
    timeout-minutes: 4
    if: "!contains(github.event.head_commit.message, '[ci skip]')"
    steps:
    - name: TypoCheck
      uses: typoci/spellcheck-action@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Configuration

You can tweak how Typo CI analyses your code by adding a .typo-ci.yml file to the root of your repository (You can also add it within your .github folder). Here is a sample file:

# This is a sample .typo-ci.yml file, it's used to configure how Typo CI will behave.
# Add it to the root of your project and push it to github.
---

# What language dictionaries should it use? By default Typo CI will select 'en' & 'en_GB'
# Currently Typo CI supports:
# de
# en
# en_GB
# es
# fr
# it
# nl
# pt
# pt_BR
# tr
dictionaries:
  - en
  - en_GB

# Any files/folders we should ignore?
excluded_files:
  - "vendor/**/*"
  - "node_modules/**/*"
  - "*.key"
  - "*.enc"
  - "*.min.css"
  - "*.css.map"
  - "*.min.js"
  - "*.js.map"
  - "*.mk"
  - "package-lock.json"
  - "yarn.lock"
  - "Gemfile.lock"
  - ".typo-ci.yml"
  - ".github/.typo-ci.yml"

# Any words we should ignore?
excluded_words:
  - typoci

# Would you like filenames to also be spellchecked?
spellcheck_filenames: true

Dictionaries

Development Languages

To help the spell checker detect words that are valid in the programming world, I've created a collection of language specific dictionaries which are stored in db/dict/contextual.

These are pragmatically generated by analysing open source projects.

Spoken Language Dictionaries

The en, en_GB & pt_BR dictionaries were built from https://github.com/en-wl/wordlist and they are stored in db/dict/imported.

Other languages have been imported via NPM from wooorm/dictionaries.

Testing

Run docker-compose run --rm web bin/setup & docker-compose run --rm web rspec.

spellcheck-action's People

Contributors

Stargazers

Watchers

Forkers

ollymid syllogy

spellcheck-action's Issues

Only checks changed files

Maybe this is intentional, but it only checks files changed in the commit

Cleanup readme

remove:

👉 If you'd like to use this Action without having to add any files to your repository, consider the Typo CI GitHub App 👈

since the app has been removed

Bug: Unable to add annotations for PR from forks

As seen: #35

It looks like the Token we're provided by GitHub doesn't let us annotate the PR. I think I just need to switch it out so it annotates the forked repo.

cronjon anyone?

i wonder why that isn't in any dictionary 📖

Will Typo CI's closure affect this action?

Hi @MikeRogers0, i saw your blog post regarding the closure of TypoCI on Hacker News, sorry to hear!

In light of this, will this action continue to be maintained?

duplicatable is spelled wrong

are those things really typos?
i'm not a native speaker but quick google search tells me it's kinda a legit word and a thing.

excluded file won't be excluded

i'm curious why nl.yml is still checked

actions are failing since today

out of nowhere our spellcheck is ded 💀

what's causing this and how can we fix it?

How to add another dictionary?

Lots of frontend in our application is in dutch language, thus we receive a bunch of spelling mistakes as those words are unknown. Is there any chance to add a dutch dictionary, otherwise this becomes useless to us

Should have option to fail the workflow and preferably comment on pull requests

Right now you can still merge if fails and the mistakes are hidden unless you click "Details" to view them since no PR comments.

TypoCI is a typo, apparently

I got this in a repo, I know i can just use the .typo-ci.yml to exclude this but it should be fixed upstream.

What's the actual licensing cost? one time 15$ or monthly 30$

30$ a month:
https://github.com/marketplace/typo-ci/plan/MDIyOk1hcmtldHBsYWNlTGlzdGluZ1BsYW42MTMx#pricing-and-setup

15$ one time:
https://gumroad.com/l/MvvBE

i am confused what the cost of this actually is

should the config file be disabled by default?

just tested this, i wouldn't have expected a typo in my config file . should this be changed?

Dictionary usage and config file location

Hi @MikeRogers0,

Surprisingly we were in the same year in the SoC at UoP, though i studied Computing so we probably didn't share many modules after the first year!

Anyway, really useful action however I have a few questions surrounding usage:

The documentation mentions development languages here, do those need to be included under dictionaries: in the .yml file or are they already included by default?
Any chance of moving the default location of .typo-ci.yml from the root to .github/typo-ci.yml to be with the other github action config files like dependabot.yml etc, or for the action to look for the file in one place or the other?

Thanks!

Words in excluded_words being flagged as typos