{"id":15512376,"url":"https://github.com/TypoCI/spellcheck-action","last_synced_at":"2025-10-12T09:31:21.940Z","repository":{"id":45175127,"uuid":"288239982","full_name":"TypoCI/spellcheck-action","owner":"TypoCI","description":"GitHub Action for checking code \u0026 Pull Requests for spelling mistakes","archived":false,"fork":false,"pushed_at":"2021-12-03T10:46:53.000Z","size":2234,"stargazers_count":42,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-03T20:03:45.361Z","etag":null,"topics":["actionshackathon","code-quality","docker","github-action","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/TypoCI.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-17T17:12:18.000Z","updated_at":"2025-08-27T12:24:25.000Z","dependencies_parsed_at":"2022-09-05T18:12:27.224Z","dependency_job_id":null,"html_url":"https://github.com/TypoCI/spellcheck-action","commit_stats":{"total_commits":116,"total_committers":8,"mean_commits":14.5,"dds":0.5775862068965517,"last_synced_commit":"a63b1430c8f0ceed9fd0bd0f3ad8f7466e6c695d"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/TypoCI/spellcheck-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypoCI%2Fspellcheck-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypoCI%2Fspellcheck-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypoCI%2Fspellcheck-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypoCI%2Fspellcheck-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TypoCI","download_url":"https://codeload.github.com/TypoCI/spellcheck-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypoCI%2Fspellcheck-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010939,"owners_count":26084837,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["actionshackathon","code-quality","docker","github-action","ruby"],"created_at":"2024-10-02T09:53:36.947Z","updated_at":"2025-10-12T09:31:20.057Z","avatar_url":"https://github.com/TypoCI.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://typoci.com/images/typo-ci-logo.svg\" alt=\"Typo CI Logo - It's a sword surrounded by brackets\" width=\"96\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\n  Typo CI - Spellcheck Action\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\nChecks for spelling mistakes within code via a GitHub Action\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://twitter.com/MikeRogers0\" target=\"_blank\" rel=\"nooppener\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/MikeRogers0?label=Follow%20%40MikeRogers0%20For%20Updates\u0026style=social\" a;t=\"@MikeRogers0 on Twitter\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/TypoCI/spellcheck-action/actions?query=workflow:RSpec\" target=\"_blank\" rel=\"nooppener\"\u003e\u003cimg src=\"https://github.com/TypoCI/spellcheck-action/workflows/RSpec/badge.svg\" alt=\"RSpec passing\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n**👉 If you'd like to use this Action without having to add any files to your repository, consider the [Typo CI GitHub App](https://github.com/marketplace/typo-ci/) 👈**\n\n## Installation\n\nCopy add the following to `.github/workflows/spellcheck.yml`:\n\n```yml\n# Add to: .github/workflows/spellcheck.yml\nname: Typo CI\n\non:\n  push:\n    branches-ignore:\n      - master\njobs:\n  spellcheck:\n    name: Typo CI (GitHub Action)\n    runs-on: ubuntu-latest\n    timeout-minutes: 4\n    if: \"!contains(github.event.head_commit.message, '[ci skip]')\"\n    steps:\n    - name: TypoCheck\n      uses: typoci/spellcheck-action@master\n      env:\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Configuration\n\nYou 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:\n\n```yml\n# This is a sample .typo-ci.yml file, it's used to configure how Typo CI will behave.\n# Add it to the root of your project and push it to github.\n---\n\n# What language dictionaries should it use? By default Typo CI will select 'en' \u0026 'en_GB'\n# Currently Typo CI supports:\n# de\n# en\n# en_GB\n# es\n# fr\n# it\n# nl\n# pt\n# pt_BR\n# tr\ndictionaries:\n  - en\n  - en_GB\n\n# Any files/folders we should ignore?\nexcluded_files:\n  - \"vendor/**/*\"\n  - \"node_modules/**/*\"\n  - \"*.key\"\n  - \"*.enc\"\n  - \"*.min.css\"\n  - \"*.css.map\"\n  - \"*.min.js\"\n  - \"*.js.map\"\n  - \"*.mk\"\n  - \"package-lock.json\"\n  - \"yarn.lock\"\n  - \"Gemfile.lock\"\n  - \".typo-ci.yml\"\n  - \".github/.typo-ci.yml\"\n\n# Any words we should ignore?\nexcluded_words:\n  - typoci\n\n# Would you like filenames to also be spellchecked?\nspellcheck_filenames: true\n```\n\n## Dictionaries\n\n### Development Languages\n\nTo 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](https://github.com/TypoCI/spellcheck-action/tree/master/db/dict/contextual).\n\nThese are pragmatically generated by analysing open source projects.\n\n### Spoken Language Dictionaries\n\nThe `en`, `en_GB` \u0026 `pt_BR` dictionaries were built from [https://github.com/en-wl/wordlist](https://github.com/en-wl/wordlist) and they are stored in [db/dict/imported](https://github.com/TypoCI/spellcheck-action/tree/master/db/dict/imported).\n\nOther languages have been imported via NPM from [wooorm/dictionaries](https://github.com/wooorm/dictionaries).\n\n## Testing\n\n- Run `docker-compose run --rm web bin/setup` \u0026 `docker-compose run --rm web rspec`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTypoCI%2Fspellcheck-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTypoCI%2Fspellcheck-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTypoCI%2Fspellcheck-action/lists"}