{"id":23765938,"url":"https://github.com/datpmt/typo_checker","last_synced_at":"2025-04-12T15:02:12.657Z","repository":{"id":269899078,"uuid":"908806258","full_name":"datpmt/typo_checker","owner":"datpmt","description":"TypoChecker is a tool for scanning source code files for common typographical errors.","archived":false,"fork":false,"pushed_at":"2025-02-20T04:49:01.000Z","size":902,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T08:09:05.704Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/typo_checker","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/datpmt.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-27T02:44:42.000Z","updated_at":"2025-02-20T04:48:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4140010-5bf5-4b58-adaf-72a344ff3890","html_url":"https://github.com/datpmt/typo_checker","commit_stats":null,"previous_names":["datpmt/typo_checker"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datpmt%2Ftypo_checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datpmt%2Ftypo_checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datpmt%2Ftypo_checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datpmt%2Ftypo_checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datpmt","download_url":"https://codeload.github.com/datpmt/typo_checker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586249,"owners_count":21128997,"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":[],"created_at":"2024-12-31T23:31:07.996Z","updated_at":"2025-04-12T15:02:12.618Z","avatar_url":"https://github.com/datpmt.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypoChecker\n\nTypoChecker is a tool for scanning source code files for common typographical errors. The tool checks through text-based files in a given repository to identify and suggest corrections for any matches found.\n\n\u003cp align=\"center\" width=\"100%\"\u003e\n    \u003cimg src=\"typo_checker.png\" alt=\"TypoChecker Image\"\u003e\n\u003c/p\u003e\n\n## Features\n\n- **Automatic typo detection**: Scan through files in a repository for known typos.\n- **Support for multiple file types**: It checks various source code and text file extensions.\n- **Colorized output**: Provides color-coded feedback for easier identification of typos.\n- **Customization**: Allows you to exclude certain files or skip specific typos.\n\n## Installation\n\nTo install the TypoChecker gem, you can install it directly using `gem install`.\n\nRun the following command in your terminal to install the gem globally:\n\n```bash\ngem install typo_checker\n```\n\n## Usage\n\nOnce installed, you can use TypoChecker in your Ruby project to scan a directory (or the current directory by default) for typos.\n\n```bash\n# typo_checker scan /path/repo\ntypo_checker scan . # current repo\ntypo_checker scan . --excludes node_modules .git # or typo_checker scan . -e node_modules .git\ntypo_checker scan . --excludes node_modules .git --skips rspec defs # or typo_checker scan . -e node_modules .git -s rspec defs\n```\n\n### Output\nWhen a typo is found, the tool prints out the following information in a colorized format:\n\n- File path and line number in light blue.\n- Incorrect word in red.\n- Suggested correction in green.\n\nExample output:\n\n```bash\nTypo found in /path/to/file.rb:10:15: myFuncton -\u003e myFunction\n```\n\n## File Types Supported\n\nTypoChecker supports the following file types by default:\n- .rb (Ruby)\n- .txt (Text)\n- .md (Markdown)\n- .html (HTML)\n- .css (CSS)\n- .js (JavaScript)\n- .py (Python)\n- .java (Java)\n- .php (PHP)\n- .go (Go)\n- .swift (Swift)\n- .ts (TypeScript)\n- .scala (Scala)\n- .c (C)\n- .cpp (C++)\n- .csharp (C#)\n- .h (C Header)\n- .lua (Lua)\n- .pl (Perl)\n- .rs (Rust)\n- .kt (Kotlin)\n- .sh, .bash, .bat (Shell Scripts)\n- .json (JSON)\n- .yaml (YAML)\n- .xml (XML)\n- .scss (Sass/SCSS)\n- .tsv (Tab-separated values)\n- .ps1 (PowerShell)\n- .clj (Clojure)\n- .elixir (Elixir)\n- .f# (F#)\n- .vhdl, .verilog (Hardware description languages)\n- .ada (Ada)\n- .ml (OCaml)\n- .lisp (Lisp)\n- .prolog (Prolog)\n- .tcl (Tcl)\n- .rexx (Rexx)\n- .awk (AWK)\n- .sed (Sed)\n- .coffee (CoffeeScript)\n- .groovy (Groovy)\n- .dart (Dart)\n- .haxe (Haxe)\n- .zig (Zig)\n- .nim (Nim)\n- .crystal (Crystal)\n- .reason (Reason)\n- .ocaml (OCaml)\n- .forth (Forth)\n- .v (V)\n- .xhtml (XHTML)\n- .julia (Julia)\n- .racket (Racket)\n- .scheme (Scheme)\n- .rust (Rust)\n- .graphql (GraphQL)\n\n## Contributing\n\nWe welcome contributions to this project! To contribute:\n\n1. Fork the repository.\n2. Create a new feature branch (git checkout -b your-feature).\n3. Commit your changes (git commit -am 'Add some feature').\n4. Push the changes to your fork (git push origin your-feature).\n5. Open a pull request.\n\n## Contributors\n\n- Tran Dang Duc Dat ([datpmt](https://github.com/datpmt))\n\n## License\nThe gem is available as open source under the terms of the [MIT License](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatpmt%2Ftypo_checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatpmt%2Ftypo_checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatpmt%2Ftypo_checker/lists"}