{"id":14980822,"url":"https://github.com/yegor256/texsc","last_synced_at":"2025-10-08T20:22:05.046Z","repository":{"id":59157710,"uuid":"276389656","full_name":"yegor256/texsc","owner":"yegor256","description":"Spell checking for LaTeX documents with the help of GNU aspell","archived":false,"fork":false,"pushed_at":"2024-05-09T10:42:08.000Z","size":101,"stargazers_count":14,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-09T11:52:56.134Z","etag":null,"topics":["aspell","latex","latex-package","ruby","ruby-gem","spell-check","spell-checker","spellchecker","spelling-correction"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/texsc","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/yegor256.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2020-07-01T13:47:13.000Z","updated_at":"2024-05-27T12:06:42.434Z","dependencies_parsed_at":"2024-05-09T11:49:14.338Z","dependency_job_id":null,"html_url":"https://github.com/yegor256/texsc","commit_stats":{"total_commits":32,"total_committers":1,"mean_commits":32.0,"dds":0.0,"last_synced_commit":"d38c4e4b7a4df766ec90697035155e2107d6c8c4"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Ftexsc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Ftexsc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Ftexsc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Ftexsc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yegor256","download_url":"https://codeload.github.com/yegor256/texsc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238762759,"owners_count":19526463,"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":["aspell","latex","latex-package","ruby","ruby-gem","spell-check","spell-checker","spellchecker","spelling-correction"],"created_at":"2024-09-24T14:02:27.738Z","updated_at":"2025-10-08T20:22:05.033Z","avatar_url":"https://github.com/yegor256.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"/logo.svg\" width=\"64px\"/\u003e\n\n[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)\n[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/texsc)](https://www.rultor.com/p/yegor256/texsc)\n[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)\n\n[![rake](https://github.com/yegor256/texsc/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/texsc/actions/workflows/rake.yml)\n[![PDD status](https://www.0pdd.com/svg?name=yegor256/texsc)](https://www.0pdd.com/p?name=yegor256/texsc)\n[![Gem Version](https://badge.fury.io/rb/texsc.svg)](https://badge.fury.io/rb/texsc)\n[![Maintainability](https://api.codeclimate.com/v1/badges/7593273bfae71f87ea8c/maintainability)](https://codeclimate.com/github/yegor256/texsc/maintainability)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/takes/texsc/master/LICENSE.txt)\n[![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/texsc.svg)](https://codecov.io/github/yegor256/texsc?branch=master)\n[![Hits-of-Code](https://hitsofcode.com/github/yegor256/texsc)](https://hitsofcode.com/view/github/yegor256/texsc)\n\nRead this blog post: [_Spell Check Your LaTeX Writings Using GNU Aspell_](https://www.yegor256.com/2020/10/06/latex-spell-checking.html)\n\nThis tool simplies the usage of [GNU aspell](http://aspell.net/)\n(you must have it installed)\nfor spell-checking of LaTeX files.\n\nFirst, you install it:\n\n```bash\n$ gem install texsc\n```\n\nThen, you just run it like this for your LaTeX files:\n\n```bash\n$ texsc article.tex\n```\n\nYou may ignore certain tags or environments using `--ignore` option\n\n```bash\n$ texsc --ignore=citet,citep --ignore=newminted article.tex\n```\n\nYou can specify the method of ignoring,\nas [aspell suggests](http://aspell.net/man-html/The-Options.html#TeX_002fLaTeX-Filter)\n(by default it's 'p'):\n\n```bash\n$ texsc --ignore=newminted:opp article.tex\n```\n\nYou may also use your own additional dictionary, via `--pws` option.\nThe file must contain one word per line:\nthey will be ignored during spell checking. Don't forget that\nthe first line of the file\n[must contain](http://aspell.net/man-html/Format-of-the-Personal-and-Replacement-Dictionaries.html)\nthis:\n\n```\npersonal_ws-1.1 en 1 utf-8\n```\n\nTo make configuration easier, you can create `.texsc` file next to your\n`.tex` file and place all your command line configuration options over there,\neach one on its own line. You can also have a global configuration file\nat `~/.texsc`, which will be read first.\n\n## How to contribute\n\nRead [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).\nMake sure your build is green before you contribute\nyour pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and\n[Bundler](https://bundler.io/) installed. Then:\n\n```\n$ bundle update\n$ bundle exec rake\n```\n\nIf it's clean and you don't see any error messages, submit your pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyegor256%2Ftexsc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyegor256%2Ftexsc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyegor256%2Ftexsc/lists"}