Giter VIP home page Giter VIP logo

@check-spelling/check-spelling GitHub Action

Overview

Everyone makes typos. This includes people writing documentation and comments, but it also includes programmers naming variables, functions, APIs, classes, and filenames.

Often, programmers will use InitialCapitalization, camelCase, ALL_CAPS, or IDLCase when naming their things. When they do this, it makes it much harder for naive spelling tools to recognize misspellings, and as such, with a really high false-positive rate, people don't tend to enable spell checking at all.

This repository's tools are capable of tolerating all of those variations. Specifically, w understands enough about how programmers name things that it can split the above conventions into word-like things for checking against a dictionary.

GitHub Action

Check Spelling

Quick Setup

Just copy the spell-check-this .github/workflows/spelling.yml into your .github/workflows in your project.

Configuration

See the documentation for Configuration information.

Events

When check-spelling runs and encounters something that isn't ideal, it may output a message including an event code, at the end of the message (unrecognized-spelling).

You should be able to look up the code in https://docs.check-spelling.dev/Event-descriptions. For unrecognized-spelling, that's: https://docs.check-spelling.dev/Event-descriptions#unrecognized-spelling.

Multilingual

As of v0.0.22, you can use non English dictionaries with the help of Hunspell.

Wiki

There is a wiki containing evolving information. It's open to public editing (and is occasionally defaced/spammed).

Sample output

Comment as seen in a PR

github action comment

Comment as seen in a commit

github action annotation

GitHub Action Run log

github action log

Running locally

Yes you can!

Running locally with Act

  1. Install Act
  2. act

⚠️ This may break at times as act may be missing support for newer GitHub Actions features.

Prerelease

I do test development on a prerelease branch.

Features and the behavior of this branch are not guaranteed to be stable as they're under semi-active development.

License

MIT

Check Spelling's Projects

.github icon .github

About the check-spelling organization

check-spelling icon check-spelling

Spelling checker action to check spelling in repositories / pull requests / commits

examples-testing icon examples-testing

This repository will be trashed periodically -- it's for testing / debugging the examples repository

flatbuffers icon flatbuffers

FlatBuffers: Memory Efficient Serialization Library

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.