{"id":26180065,"url":"https://github.com/jellydn/cspell-tool","last_synced_at":"2025-04-14T22:43:48.106Z","repository":{"id":200175462,"uuid":"705298169","full_name":"jellydn/cspell-tool","owner":"jellydn","description":"Keep your project's spelling in check with cspell-tool.","archived":false,"fork":false,"pushed_at":"2025-04-09T18:38:54.000Z","size":714,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T19:40:23.265Z","etag":null,"topics":["cli","cspell","spell-check"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jellydn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-10-15T16:17:54.000Z","updated_at":"2025-04-09T18:38:57.000Z","dependencies_parsed_at":"2023-11-20T22:27:34.844Z","dependency_job_id":"5d86c172-9c0e-4133-93cc-019de667f434","html_url":"https://github.com/jellydn/cspell-tool","commit_stats":null,"previous_names":["jellydn/cspell-tool"],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fcspell-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fcspell-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fcspell-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fcspell-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jellydn","download_url":"https://codeload.github.com/jellydn/cspell-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248975305,"owners_count":21192198,"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":["cli","cspell","spell-check"],"created_at":"2025-03-11T21:54:21.842Z","updated_at":"2025-04-14T22:43:48.089Z","avatar_url":"https://github.com/jellydn.png","language":"TypeScript","funding_links":["https://ko-fi.com/dunghd","https://paypal.me/dunghd","https://www.buymeacoffee.com/dunghd"],"categories":[],"sub_categories":[],"readme":"# cspell-tool\n\n[![Version](https://img.shields.io/npm/v/cspell-tool.svg)](https://npmjs.org/package/cspell-tool)\n[![Downloads/week](https://img.shields.io/npm/dw/cspell-tool.svg)](https://npmjs.org/package/cspell-tool)\n[![License](https://img.shields.io/npm/l/cspell-tool.svg)](https://github.com/jellydn/cspell-tool/blob/master/package.json)![Prerequisite](https://img.shields.io/badge/node-%3E%3D18.17.0-blue.svg)\n[![Twitter: jellydn](https://img.shields.io/twitter/follow/jellydn.svg?style=social)](https://twitter.com/jellydn)\n\n\u003cp align=\"center\"\u003e\n  \u003cem\u003eKeep your project's spelling in check with cspell-tool.\u003c/em\u003e\n\u003c/p\u003e\n\n[![IT Man - Eliminate Typos in Your Code with Neovim [Vietnamese]](https://i.ytimg.com/vi/3IwMd77_P8E/hqdefault.jpg)](https://www.youtube.com/watch?v=3IwMd77_P8E)\n\n## Table of Contents\n\n\u003c!--toc:start--\u003e\n\n- [Usage](#usage)\n- [Features](#features)\n  - [Usage with Neovim and null-ls](#usage-with-neovim-and-null-ls)\n- [Contributing](#contributing)\n- [License](#license)\n- [Acknowledgements](#acknowledgements)\n- [Author](#author)\n- [Show Your Support](#show-your-support)\n\u003c!--toc:end--\u003e\n\n## Usage\n\nRun the following command in your project's root directory to check for spelling issues:\n\n```sh\nnpx cspell-tool@latest\n```\n\n[![Usage](https://i.gyazo.com/b045cd1e89712ee2268fe27d9786fdfe.gif)](https://gyazo.com/b045cd1e89712ee2268fe27d9786fdfe)\n\n## Features\n\n- Supports common programming languages.\n- Easily customizable via `cspell.json`.\n- Extends your project-specific dictionary.\n\n### Usage with Neovim and null-ls\n\nThis assumes you have [`mason.nvim`](https://github.com/williamboman/mason.nvim) and [`null-ls.nvim`](https://github.com/nvimtools/none-ls.nvim) installed.\n\n1. **Installing cSpell with Mason**\n\n   Make sure your `mason.nvim` configuration in your `init.lua` includes `cspell` under `ensure_installed`:\n\n   ```lua\n   ensure_installed = {\n     -- code spell\n     \"codespell\",\n     \"misspell\",\n     \"cspell\",\n   },\n   ```\n\n2. **Setting Up null-ls**\n\n   Add the following code to your `init.lua` to set up `null-ls` for spell checking:\n\n   ```lua\n   local cspell = require(\"cspell\")\n   local ok, none_ls = pcall(require, \"null-ls\")\n   if not ok then\n     return\n   end\n\n   local b = none_ls.builtins\n   local sources = {\n     -- spell check\n     b.diagnostics.codespell,\n     b.diagnostics.misspell,\n     -- cspell\n     cspell.diagnostics.with({\n       diagnostics_postprocess = function(diagnostic)\n         diagnostic.severity = vim.diagnostic.severity[\"HINT\"]\n       end,\n     }),\n     cspell.code_actions,\n   }\n\n   return {\n     sources = sources,\n     debounce = 200,\n     debug = true,\n   }\n   ```\n\nMore details can be found in [`cspell example config with lazyvim`](./cspell.lua).\n\n[![Neovim Demo](https://i.gyazo.com/99f48ffbd1d3577d45e3474a98801120.gif)](https://gyazo.com/99f48ffbd1d3577d45e3474a98801120)\n\n## Contributing\n\nContributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nDistributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.\n\n## Acknowledgements\n\n- [zx](https://github.com/google/zx) for making scripting easier.\n- [cspell](https://github.com/streetsidesoftware/cspell) for being the backbone of this tool.\n- [cspell.nvim](https://github.com/davidmh/cspell.nvim) a companion plugin for null-ls, adding support for CSpell diagnostics and code actions.\n\n## Author\n\n👤 **Huynh Duc Dung**\n\n- Website: [productsway.com](https://productsway.com)\n- Twitter: [@jellydn](https://twitter.com/jellydn)\n- GitHub: [@jellydn](https://github.com/jellydn)\n\n## Show Your Support\n\nIf this guide has been helpful, please give it a ⭐️.\n\n[![kofi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge\u0026logo=ko-fi\u0026logoColor=white)](https://ko-fi.com/dunghd)\n[![paypal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://paypal.me/dunghd)\n[![buymeacoffee](https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge\u0026logo=buy-me-a-coffee\u0026logoColor=black)](https://www.buymeacoffee.com/dunghd)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjellydn%2Fcspell-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjellydn%2Fcspell-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjellydn%2Fcspell-tool/lists"}