{"id":14110485,"url":"https://github.com/check-spelling/check-spelling","last_synced_at":"2025-05-15T09:05:38.770Z","repository":{"id":37303353,"uuid":"240846407","full_name":"check-spelling/check-spelling","owner":"check-spelling","description":"Spelling checker action to check spelling in repositories / pull requests / commits","archived":false,"fork":false,"pushed_at":"2025-05-12T19:20:25.000Z","size":2926,"stargazers_count":289,"open_issues_count":25,"forks_count":34,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-12T20:41:05.912Z","etag":null,"topics":["github-actions","spell-check","spellcheck","spelling","spelling-checker-action"],"latest_commit_sha":null,"homepage":"https://check-spelling.dev","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/check-spelling.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-16T06:55:44.000Z","updated_at":"2025-05-11T21:21:11.000Z","dependencies_parsed_at":"2023-02-08T09:00:46.708Z","dependency_job_id":"393cff58-27f2-4104-abe8-bd5a1698fbd4","html_url":"https://github.com/check-spelling/check-spelling","commit_stats":{"total_commits":909,"total_committers":1,"mean_commits":909.0,"dds":0.0,"last_synced_commit":"96936aff2bf9fd5c2e49d370744ac55860fee67d"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/check-spelling%2Fcheck-spelling","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/check-spelling%2Fcheck-spelling/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/check-spelling%2Fcheck-spelling/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/check-spelling%2Fcheck-spelling/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/check-spelling","download_url":"https://codeload.github.com/check-spelling/check-spelling/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310513,"owners_count":22049468,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","spell-check","spellcheck","spelling","spelling-checker-action"],"created_at":"2024-08-14T10:02:52.250Z","updated_at":"2025-05-15T09:05:38.762Z","avatar_url":"https://github.com/check-spelling.png","language":"Shell","funding_links":[],"categories":["Perl"],"sub_categories":[],"readme":"# @check-spelling/check-spelling GitHub Action\n\n## Overview\n\nEveryone makes typos. This includes people writing documentation and comments,\nbut it also includes programmers naming variables, functions, APIs, classes,\nand filenames.\n\nOften, programmers will use `InitialCapitalization`, `camelCase`,\n`ALL_CAPS`, or `IDLCase` when naming their things. When they do this, it makes\nit much harder for naive spelling tools to recognize misspellings, and as such,\nwith a really high false-positive rate, people don't tend to enable spell checking\nat all.\n\nThis repository's tools are capable of tolerating all of those variations.\nSpecifically, [w](https://github.com/jsoref/spelling/blob/main/w) understands\nenough about how programmers name things that it can split the above conventions\ninto word-like things for checking against a dictionary.\n\n### How check-spelling approaches content\n\nInput | Seen | Reported | Explanation\n-|-|-|-\n`InitialCapitalization`|`Initial` `Capitalization`| `` | Both words are in the dictionary\n`camelCase`|`camel` `Case`| `` | Both words are in the dictionary\n`ALL_CAPS`|`ALL` `CAPS`| `` | Both words are in the dictionary\n`IDLCase`| `IDL` `Case`| `IDL` | The first word isn't in the dictionary, but the second is\n\n### How check-spelling manages `expect.txt`\n\nGenerally, check-spelling wants to minimize the `expect.txt` (or similar file(s)) so that it's easier for someone to open the file up and complain that something in it shouldn't be there.\n\nThe enemy of that goal is repetition or near repetition. The longer the file, the more likely a reader's eyes will glaze over before they spot something that shouldn't be there.\n\n#### uppercase\n\n`about.txt`\n\n```\nIKEA was started July 28, 1943.\n```\n\nCorresponding `expect.txt`:\n\n```\nIKEA\n```\n\nExplanation: `IKEA` isn't in the dictionary.\n\nThis doesn't mean that it would be ok to write `Ikea` or `ikea`.\n`Ikea` is definitely wrong (and outside of domain names, `ikea` is probably also wrong).\n\n#### proper noun\n\n`file.txt`\n\n```\nMicrosoft shipped Windows in 1985.\n```\n\nCorresponding `expect.txt`:\n\n```\nMicrosoft\n```\n\nExplanation: `Microsoft` isn't in the dictionary.\n\n### proper noun and uppercase\n\n`file.js`\n\n```\n// Microsoft shipped Windows in 1985.\n\nMICROSOFT_WINDOWS_RELEASE_DATE=\"November 20, 1985\"\n```\n\nCorresponding `expect.txt`:\n\n```\nMicrosoft\n```\n\nExplanation: `Microsoft` isn't in the dictionary, but there's a reasonable expectation that in some programming language a proper noun will need to be written in uppercase in order to be used as constant (or similar).\n\nThis doesn't mean that a project has decided to allow `microsoft`,\nin a documentation oriented project `microsoft` would be wrong.\n\n### lowercase, proper noun, and uppercase\n\n`file.js`\n\n```\n// http://microsoft.com/ie\n\nMICROSOFT_IE_RELEASE_DATE=\"August 16, 1995\"\n```\n\nCorresponding `expect.txt`:\n\n```\nmicrosoft\n```\n\nExplanation: `microsoft` isn't in the dictionary, and there's a reasonable expectation that in some cases it will have to be written as `Microsoft` (because in English the first word of a sentence will have its first letter capitalized) or as `MICROSOFT` (because programmers tend to write things in uppercase for constants).\n\n## GitHub Action\n\n[![Check Spelling](https://github.com/check-spelling/check-spelling/actions/workflows/spelling.yml/badge.svg)](https://github.com/check-spelling/check-spelling/actions/workflows/spelling.yml)\n\n- [@check-spelling/check-spelling GitHub Action](#check-spellingcheck-spelling-github-action)\n  - [Overview](#overview)\n  - [GitHub Action](#github-action)\n  - [Quick Setup](#quick-setup)\n  - [Configuration](#configuration)\n  - [Events](#events)\n  - [Multilingual](#multilingual)\n  - [Wiki](#wiki)\n  - [Sample output](#sample-output)\n    - [Comment as seen in a PR](#comment-as-seen-in-a-pr)\n    - [Comment as seen in a commit](#comment-as-seen-in-a-commit)\n    - [GitHub Action Run log](#github-action-run-log)\n  - [Running locally](#running-locally)\n    - [Running locally with Act](#running-locally-with-act)\n  - [Prerelease](#prerelease)\n  - [License](#license)\n\n## Quick Setup\n\nJust copy the [spell-check-this](https://github.com/check-spelling/spell-check-this)\n[`.github/workflows/spelling.yml`](https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml) into your `.github/workflows` in your project.\n\n## Configuration\n\nSee the [documentation](https://docs.check-spelling.dev) for [Configuration information](https://docs.check-spelling.dev/Configuration).\n\n## Events\n\nWhen check-spelling runs and encounters something that isn't ideal,\nit may output a message including an event code,\nat the end of the message `(unrecognized-spelling)`.\n\nYou should be able to look up the code in\nhttps://docs.check-spelling.dev/Event-descriptions.\nFor `unrecognized-spelling`,\nthat's:\nhttps://docs.check-spelling.dev/Event-descriptions#unrecognized-spelling.\n\n## Multilingual\n\nAs of [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22), you can [use non English dictionaries](https://docs.check-spelling.dev/Feature:-Configurable-word-characters) with the help of [Hunspell](https://github.com/hunspell/hunspell).\n\n## Wiki\n\nThere is a [wiki](https://github.com/check-spelling/check-spelling/wiki) containing evolving information. It's open to public editing (and is occasionally defaced/spammed).\n\n## Sample output\n\n### Comment as seen in a PR\n\n![github action comment](https://raw.githubusercontent.com/check-spelling/art/86a33c871e0e01aaf210087d13614c166d0ba536/output/check-spelling-comment.png)\n\n### Comment as seen in a commit\n\n![github action annotation](https://raw.githubusercontent.com/check-spelling/art/86a33c871e0e01aaf210087d13614c166d0ba536/output/check-spelling-annotation.png)\n\n### GitHub Action Run log\n\n![github action log](https://raw.githubusercontent.com/check-spelling/art/86a33c871e0e01aaf210087d13614c166d0ba536/output/check-spelling-log.png)\n\n## Running locally\n\nRead about [running check-spelling locally](https://docs.check-spelling.dev/Feature:-Run-locally).\n\n## Prerelease\n\nI do test development on a [prerelease](https://github.com/check-spelling/check-spelling/tree/prerelease) branch.\n\nFeatures and the behavior of this branch are not guaranteed to be stable\nas they're under semi-active development.\n\n## License\n\n[MIT](LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheck-spelling%2Fcheck-spelling","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheck-spelling%2Fcheck-spelling","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheck-spelling%2Fcheck-spelling/lists"}