{"id":17178549,"url":"https://github.com/bobbylight/spellchecker","last_synced_at":"2026-01-05T04:07:28.147Z","repository":{"id":9969286,"uuid":"11993995","full_name":"bobbylight/SpellChecker","owner":"bobbylight","description":"A spell checker add-on library for RSyntaxTextArea.","archived":false,"fork":false,"pushed_at":"2025-03-17T09:50:19.000Z","size":2092,"stargazers_count":39,"open_issues_count":6,"forks_count":11,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T07:35:53.627Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bobbylight.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2013-08-09T05:42:57.000Z","updated_at":"2025-03-17T09:50:23.000Z","dependencies_parsed_at":"2025-02-25T04:21:21.892Z","dependency_job_id":"1d7844ae-6840-4be3-b814-a9e7f4f5472a","html_url":"https://github.com/bobbylight/SpellChecker","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bobbylight%2FSpellChecker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bobbylight%2FSpellChecker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bobbylight%2FSpellChecker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bobbylight%2FSpellChecker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bobbylight","download_url":"https://codeload.github.com/bobbylight/SpellChecker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248743668,"owners_count":21154716,"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-10-15T00:07:40.760Z","updated_at":"2026-01-05T04:07:28.135Z","avatar_url":"https://github.com/bobbylight.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SpellChecker\r\n![Build](https://github.com/bobbylight/SpellChecker/actions/workflows/gradle.yml/badge.svg)\r\n![CodeQL](https://github.com/bobbylight/SpellChecker/actions/workflows/codeql-analysis.yml/badge.svg)\r\n![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fifesoft/spellchecker/badge.svg)\r\n[![codecov](https://codecov.io/gh/bobbylight/SpellChecker/graph/badge.svg?token=xzoUjtmmjf)](https://codecov.io/gh/bobbylight/SpellChecker)\r\n\r\nSpellChecker is a spell check add-on for `RSyntaxTextArea`.  For programming languages, it spell-checks text in\r\ncomments, and when editing plain text files, the entire file is spell-checked.  Spelling errors are squiggle-underlined\r\nin the color of your choosing, and hovering the mouse over a misspelled word displays a tool tip with suggested fixes\r\n(if any).  You can configure the library to also use a \"user dictionary\" file, allowing the user to add extra words to\r\nthe spell check white list.\r\n\r\nThis add-on is based on [Jazzy](http://jazzy.sourceforge.net), a Java spell checker.  Indeed, 99% of the code is just\r\nJazzy, with changes made for performance, bug fixes, and Java 8 syntax.\r\n\r\nThis library is built with Java 17, but runs on Java 8 and later.\r\n\r\n## Getting a dictionary file\r\nWhile the `SpellingParser` class can take any implementation of the `SpellDictionary` interface,\r\ntypically English users will use one of the `SpellingParser.createEnglishSpellingParser()`\r\noverloads.  These overloads take a zip file containing `.dic` files for either American or British\r\nEnglish.  Such a zip file is generated by this library when running `./gradlew clean build` -\r\n`src/main/dist/english_dic.zip`.  This file is not source controlled, but the `.dic` files that\r\nmake up its contents are, so we can easily track added words over time.\r\n\r\n## Usage\r\nAs mentioned above, building this project builds an `english_dic.zip` file that can be used\r\nfor both American and British English spellchecking.  Using this zip file, the easiest\r\nmethod to add spell checking to RSTA is as follows:\r\n\r\n```java\r\nimport org.fife.ui.rsyntaxtextarea.spell.*;\r\n// ...\r\nFile zip = new File(\"location/of/generated/english_dic.zip\");\r\nboolean usEnglish = true; // \"false\" will use British English\r\nSpellingParser parser = SpellingParser.createEnglishSpellingParser(zip, usEnglish);\r\ntextArea.addParser(parser);\r\n```\r\n\r\nSee the `SpellCheckerDemo` submodule for a working example.  \r\n\r\nJust like Jazzy itself, this add-on is licensed under the LGPL; see the included\r\n[LICENSE.md](https://github.com/bobbylight/SpellChecker/blob/master/LICENSE.md) file.\r\n\r\n## Sister Projects\r\n\r\n* [RSyntaxTextArea](https://github.com/bobbylight/RSyntaxTextArea) provides syntax highlighting, code folding, and many other features out-of-the-box.\r\n* [AutoComplete](https://github.com/bobbylight/AutoComplete) - Adds code completion to RSyntaxTextArea (or any other JTextComponent).\r\n* [RSTALanguageSupport](https://github.com/bobbylight/RSTALanguageSupport) - Code completion for RSTA for the following languages: Java, JavaScript, HTML, PHP, JSP, Perl, C, Unix Shell.  Built on both RSTA and AutoComplete.\r\n* [RSTAUI](https://github.com/bobbylight/RSTAUI) - Common dialogs needed by text editing applications: Find, Replace, Go to Line, File Properties.\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbobbylight%2Fspellchecker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbobbylight%2Fspellchecker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbobbylight%2Fspellchecker/lists"}