{"id":14235599,"url":"https://github.com/drahnr/cargo-spellcheck","last_synced_at":"2025-05-14T16:14:08.362Z","repository":{"id":38094345,"uuid":"263905120","full_name":"drahnr/cargo-spellcheck","owner":"drahnr","description":"Checks all your documentation for spelling and grammar mistakes with hunspell and a nlprule based checker for grammar","archived":false,"fork":false,"pushed_at":"2025-04-10T14:45:37.000Z","size":80394,"stargazers_count":343,"open_issues_count":52,"forks_count":36,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-13T03:59:45.118Z","etag":null,"topics":["cargo","cargo-plugin","cargo-spellcheck","grammar","grammar-mistakes","grammarchecker","hacktoberfest","hunspell","languagetool","nlp","spellchecker","spelling"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/drahnr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"drahnr","patreon":"drahnr","liberapay":"drahnr","open_collective":"bernhard-schuster"}},"created_at":"2020-05-14T12:11:02.000Z","updated_at":"2025-04-11T07:18:06.000Z","dependencies_parsed_at":"2023-12-22T10:09:34.579Z","dependency_job_id":"275a166c-2ca5-48b5-8793-cb19fc3b161f","html_url":"https://github.com/drahnr/cargo-spellcheck","commit_stats":{"total_commits":1168,"total_committers":25,"mean_commits":46.72,"dds":"0.18578767123287676","last_synced_commit":"6d979fccfcf8a9b5a331d8ae079d74fa77d0ac42"},"previous_names":[],"tags_count":105,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drahnr%2Fcargo-spellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drahnr%2Fcargo-spellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drahnr%2Fcargo-spellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drahnr%2Fcargo-spellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drahnr","download_url":"https://codeload.github.com/drahnr/cargo-spellcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661706,"owners_count":21141450,"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":["cargo","cargo-plugin","cargo-spellcheck","grammar","grammar-mistakes","grammarchecker","hacktoberfest","hunspell","languagetool","nlp","spellchecker","spelling"],"created_at":"2024-08-20T21:02:08.252Z","updated_at":"2025-04-13T03:59:58.106Z","avatar_url":"https://github.com/drahnr.png","language":"Rust","funding_links":["https://github.com/sponsors/drahnr","https://patreon.com/drahnr","https://liberapay.com/drahnr","https://opencollective.com/bernhard-schuster"],"categories":["Rust","Programming Languages"],"sub_categories":[],"readme":"# cargo-spellcheck\n\n[![crates.io](https://img.shields.io/crates/v/cargo_spellcheck.svg)](https://crates.io/crates/cargo-spellcheck)\n[![CI](https://ci.fff.rs/api/v1/teams/main/pipelines/cargo-spellcheck/jobs/master-validate/badge)](https://ci.fff.rs/teams/main/pipelines/cargo-spellcheck/jobs/master-validate)\n![commits-since](https://img.shields.io/github/commits-since/drahnr/cargo-spellcheck/latest.svg)\n![Crates.io MSRV](https://img.shields.io/crates/msrv/cargo-spellcheck)\n\nCheck your spelling with `hunspell` and/or `nlprule`.\n\n## Use Cases\n\nRun `cargo spellcheck --fix` or `cargo spellcheck fix` to fix all your\ndocumentation comments in order to avoid nasty typos all over your source tree.\nMeant as a helper simplifying review as well as improving CI checks after a\nlearning phase for custom/topic specific lingo.\n\n`cargo-spellcheck` is also a valuable tool to run from git commit hooks or CI/CD\nsystems.\n\n### Check For Spelling and/or Grammar Mistakes\n\n```zsh\ncargo spellcheck check\n```\n\n\u003cpre\u003e\u003ccode\u003e\u003cspan style=\"color:#CC0000\"\u003e\u003cb\u003eerror\u003c/b\u003e\u003c/span\u003e\u003cspan style=\"color:#D3D7CF\"\u003e\u003cb\u003e: spellcheck\u003c/b\u003e\u003c/span\u003e\n\u003cspan style=\"color:#3465A4\"\u003e   --\u0026gt;\u003c/span\u003e src/main.rs:44\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e    |\u003c/b\u003e\u003c/span\u003e\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e 44 |\u003c/b\u003e\u003c/span\u003e Fun facets shalld cause some erroris.\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e    |\u003c/b\u003e\u003c/span\u003e\u003cspan style=\"color:#C4A000\"\u003e\u003cb\u003e            ^^^^^^\u003c/b\u003e\u003c/span\u003e\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e    |\u003c/b\u003e\u003c/span\u003e\u003cspan style=\"color:#CC0000\"\u003e\u003cb\u003e - \u003c/b\u003e\u003c/span\u003e\u003cspan style=\"color:#4E9A06\"\u003e\u003cb\u003eshall\u003c/b\u003e\u003c/span\u003e or \u003cspan style=\"color:#4E9A06\"\u003eshall d\u003c/span\u003e\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e    |\u003c/b\u003e\u003c/span\u003e\u003c/code\u003e\u003c/pre\u003e\n\n### Apply Suggestions Interactively\n\n```zsh\ncargo spellcheck fix\n```\n\n\u003cpre\u003e\u003ccode\u003e\u003cspan style=\"color:#CC0000\"\u003e\u003cb\u003eerror\u003c/b\u003e\u003c/span\u003e\u003cspan style=\"color:#D3D7CF\"\u003e\u003cb\u003e: spellcheck(Hunspell)\u003c/b\u003e\u003c/span\u003e\n\u003cspan style=\"color:#3465A4\"\u003e    --\u0026gt;\u003c/span\u003e /media/supersonic1t/projects/cargo-spellcheck/src/literalset.rs:291\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e     |\u003c/b\u003e\u003c/span\u003e\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e 291 |\u003c/b\u003e\u003c/span\u003e  Returns literl within the Err variant if not adjacent\n\u003cspan style=\"color:#3465A4\"\u003e\u003cb\u003e     |\u003c/b\u003e\u003c/span\u003e\u003cspan style=\"color:#C4A000\"\u003e\u003cb\u003e          ^^^^^^\u003c/b\u003e\u003c/span\u003e\n\n\u003cspan style=\"color:#729FCF\"\u003e\u003cb\u003e(13/14) Apply this suggestion [y,n,q,a,d,j,e,?]?\u003c/b\u003e\u003c/span\u003e\n\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003elite\u003c/span\u003e\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003elitter\u003c/span\u003e\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003elitterer\u003c/span\u003e\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003eliter l\u003c/span\u003e\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003eliters\u003c/span\u003e\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003eliteral\u003c/span\u003e\n   \u003cspan style=\"background-color:#2E3436;color:#729FCF;\"\u003eliter\u003c/span\u003e\n \u003cspan style=\"color:#8AE234\"\u003e\u003cb\u003e»\u003c/b\u003e\u003c/span\u003e \u003cspan style=\"background-color:#2E3436;color:#FCE94F\"\u003ea custom replacement literal\u003c/span\u003e\u003c/code\u003e\u003c/pre\u003e\n\n## Installation\n\n`cargo install --locked cargo-spellcheck`\n\nThe `--locked` flag is the preferred way of installing to get the tested set of\ndependencies.\n\non OS X, you need to ensure that `libclang.dylib` can be found by the linker\n\nwhich can be achieved by setting `DYLB_FALLBACK_LIBRARY_PATH`:\n\n```\nexport DYLD_FALLBACK_LIBRARY_PATH= \\\n    \"$(xcode-select --print-path)/Toolchains/XcodeDefault.xctoolchain/usr/lib/\"\n```\n\nIn Linux, the file is `libclang.so` which can be installed via:\n\n```\napt-get install libclang-dev\n``` \n\nAfterwards, you can set the variable `LIBCLANG_PATH` via:\n\n```\nexport LIBCLANG_PATH=/usr/lib/llvm-14/lib/\n```\n\n## Completions\n\n`cargo spellcheck completions` for autodetection of your current shell via\n`$SHELL`,\n\n or\n\n`cargo spellcheck completions --shell zsh`\n\nto explicitly specify your shell type.\n\nCommonly it's use like this from your shell's `.rc*` file:\n\n`source \u003c(cargo spellcheck completions)`\n\nNote: There is a [relevant clap issue\n(#3508)](https://github.com/clap-rs/clap/issues/3508) that makes this fail in\nsome cases.\n\n## 🎈 Contribute!\n\nContributions are very welcome!\n\nGenerally the preferred way of doing so, is to comment in an issue that you\nwould like to tackle the implementation/fix.\n\nThis is usually followed by an initial PR where the implementation is then\ndiscussed and iteratively refined. No need to get it all correct\nthe first time!\n\n## Documentation\n\n- [Features and Roadmap](docs/features.md)\n- [Remedies for common issues](docs/remedy.md)\n- [Configuration](docs/configuration.md)\n- [Available Checkers](docs/checkers.md)\n- [Automation of `cargo-spellcheck`](docs/automation.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrahnr%2Fcargo-spellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrahnr%2Fcargo-spellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrahnr%2Fcargo-spellcheck/lists"}