{"id":21301708,"url":"https://github.com/funbox/languagetool-node","last_synced_at":"2025-06-11T18:08:06.750Z","repository":{"id":42663951,"uuid":"302359374","full_name":"funbox/languagetool-node","owner":"funbox","description":"CLI spell and grammar checker","archived":false,"fork":false,"pushed_at":"2023-10-02T10:22:18.000Z","size":364,"stargazers_count":13,"open_issues_count":2,"forks_count":2,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-10-13T11:08:44.722Z","etag":null,"topics":["grammar","grammar-checker","languagetool","spellcheck","spelling"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/funbox.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-10-08T14:01:41.000Z","updated_at":"2023-09-08T18:13:23.000Z","dependencies_parsed_at":"2023-01-22T05:00:14.637Z","dependency_job_id":null,"html_url":"https://github.com/funbox/languagetool-node","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Flanguagetool-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Flanguagetool-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Flanguagetool-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Flanguagetool-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/funbox","download_url":"https://codeload.github.com/funbox/languagetool-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225269842,"owners_count":17447600,"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":["grammar","grammar-checker","languagetool","spellcheck","spelling"],"created_at":"2024-11-21T15:50:27.624Z","updated_at":"2024-11-21T15:50:28.077Z","avatar_url":"https://github.com/funbox.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⛔ THIS REPO IS UNMAINTAINED\n\nFuture development moved to \u003chttps://github.com/343dev/languagetool-node\u003e.\n\n# @funboxteam/languagetool-node\n\n\u003cimg align=\"right\" width=\"192\" height=\"192\"\n     src=\"./logo.png\"\u003e\n\n[![npm](https://img.shields.io/npm/v/@funboxteam/languagetool-node.svg)](https://www.npmjs.com/package/@funboxteam/languagetool-node)\n\nCLI spell and grammar checker. \nUses [LanguageTool](https://github.com/languagetool-org/languagetool) under the hood.\n\n[По-русски](./README.ru.md)\n\n## Rationale\n\nSome projects have a lot of documentation inside the repos. Once we decided to start linting their\ngrammar and check for spelling errors. But we didn't want to send our docs \nto the unknown servers of the well-known services. \n\nHence, we decided to build our own CLI tool upon the LanguageTool.   \n\n## Getting Started\n\nLanguageTool requires Java to work, so first of all go to [java.com](https://www.java.com) and download it. \n\nThen install the package:\n\n```bash\nnpm i -g @funboxteam/languagetool-node\n```\n\nIt's recommended to install the package globally, because archive with LanguageTool will be downloaded\n(≈250 MB) and unzipped it into the package directory. \n\n## Usage\n\nThe tool can check the passed files or the text from STDIN. \n\nCheck files:\n\n```bash\nlanguagetool-node README.md CHANGELOG.md\n```\n\nCheck files defined using globs:\n\n```bash\nlanguagetool-node ~/project1/**/*.txt ~/project2/*.md\n```\n\nCheck the text from STDIN:\n\n```bash\necho \"Insert your text here .. or check this textt. LanguageTool 4.0 were releasd on Thursday 29 december 2017.\" | languagetool-node\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eOutput example\u003c/summary\u003e\n  \n  ```bash\n  $ echo \"Insert your text here .. or check this textt. LanguageTool 4.0 were releasd on Thursday 29 december 2017.\" | languagetool-node\n\n  \u003cstdin\u003e\n    1:23  warning  Two consecutive dots                                        typographical  spell\n  Context: «Insert your text here .. or check this textt. LanguageTool 4.0 w...»\n  Possible replacements: «.»\n  \n    1:26  warning  This sentence does not start with an uppercase letter       typographical  spell\n  Context: «Insert your text here .. or check this textt. LanguageTool 4.0 were...»\n  Possible replacements: «Or»\n  \n    1:40  warning  Possible spelling mistake found                             misspelling    spell\n  Context: «Insert your text here .. or check this textt. LanguageTool 4.0 were releasd on Thurs...»\n  Possible replacements: «text, texts, text t»\n  \n    1:69  warning  Possible spelling mistake found                             misspelling    spell\n  Context: «...check this textt. LanguageTool 4.0 were releasd on Thursday 29 december 2017. »\n  Possible replacements: «released, release»\n  \n    1:80  warning  The date 29 december 2017 is not a Thursday, but a Friday.  inconsistency  spell\n  Context: «...textt. LanguageTool 4.0 were releasd on Thursday 29 december 2017. »\n  \n  ⚠ 5 warnings\n  ```\n\u003c/details\u003e\n\n## External configuration file\n\nIt's possible to override default options by creating file `~/.languagetoolrc.js`.\nIt will be merged with default config.\n\nExample of external config:\n\n```javascript\nmodule.exports = {\n  // allowed words (regexps are supported)\n  ignore: [\n    '(T|O)TF',\n  ],\n};\n```\n\n## Credits\n\nThe picture for the project was made by [Sergey Mylnikov](https://www.behance.net/s_mylnikov) \u0026 [Igor Garybaldi](https://pandabanda.com/).\n\n[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunbox%2Flanguagetool-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffunbox%2Flanguagetool-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunbox%2Flanguagetool-node/lists"}