yegor256 / texsc

Spell checking for LaTeX documents with the help of GNU aspell

Read this blog post: Spell Check Your LaTeX Writings Using GNU Aspell

This tool simplies the usage of GNU aspell (you must have it installed) for spell-checking of LaTeX files.

First, you install it:

$ gem install texsc

Then, you just run it like this for your LaTeX files:

$ texsc article.tex

You may ignore certain tags or environments using --ignore option

$ texsc --ignore=citet,citep --ignore=newminted article.tex

You can specify the method of ignoring, as aspell suggests (by default it's 'p'):

$ texsc --ignore=newminted:opp article.tex

You may also use your own additional dictionary, via --pws option. The file must contain one word per line: they will be ignored during spell checking. Don't forget that the first line of the file must contain this:

personal_ws-1.1 en 1 utf-8

To make configuration easier, you can create .texsc file next to your .tex file and place all your command line configuration options over there, each one on its own line. You can also have a global configuration file at ~/.texsc, which will be read first.

How to contribute

Read these guidelines. Make sure your build is green before you contribute your pull request. You will need to have Ruby 2.3+ and Bundler installed. Then:

$ bundle update
$ bundle exec rake

If it's clean and you don't see any error messages, submit your pull request.

texsc's Issues

slop 4.8.2

skeleton

STAR breaks the parsing

print the entire content if --verbose

fine-grained config for --ignore

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

bundler

Gemfile

• cucumber '9.2.0'
• rake '13.2.1'
• rubocop '1.63.1'
• rubocop-rspec '2.29.1'
• simplecov '0.22.0'

github-actions

.github/workflows/codecov.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• ruby/setup-ruby v1
• codecov/codecov-action v4.0.0-beta.3
• ubuntu 22.04

.github/workflows/rake.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• ruby/setup-ruby v1

---

• Check this box to trigger a request for Renovate to run again on this repository

prevent inline commands

check the existence of --pws

global config

file names are not quoted properly

ignore environments don't work

no arguments should mean spell checking of all visible .tex files

better reporting

refresh

config file

broken parsing of command line

Due to mistake in command line

Traceback (most recent call last):
	9: from /Users/yegor/.rvm/gems/ruby-2.6.0/bin/texsc:23:in `<main>'
	8: from /Users/yegor/.rvm/gems/ruby-2.6.0/bin/texsc:23:in `load'
	7: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/texsc-0.1.0/bin/texsc:36:in `<top (required)>'
	6: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop.rb:23:in `parse'
	5: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop/options.rb:72:in `parse'
	4: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop/parser.rb:49:in `parse'
	3: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop/parser.rb:49:in `each_with_index'
	2: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop/parser.rb:49:in `each'
	1: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop/parser.rb:59:in `block in parse'
/Users/yegor/.rvm/gems/ruby-2.6.0/gems/slop-4.8.1/lib/slop/parser.rb:131:in `try_process': unknown option `--ignorenewminted:opp' (Slop::UnknownOption)
	3: from /Users/yegor/.rvm/gems/ruby-2.6.0/bin/texsc:23:in `<main>'
	2: from /Users/yegor/.rvm/gems/ruby-2.6.0/bin/texsc:23:in `load'
	1: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/texsc-0.1.0/bin/texsc:35:in `<top (required)>'
/Users/yegor/.rvm/gems/ruby-2.6.0/gems/texsc-0.1.0/bin/texsc:54:in `rescue in <top (required)>': unknown option `--ignorenewminted:opp' (RuntimeError)
	3: from /Users/yegor/.rvm/gems/ruby-2.6.0/bin/texsc:23:in `<main>'
	2: from /Users/yegor/.rvm/gems/ruby-2.6.0/bin/texsc:23:in `load'
	1: from /Users/yegor/.rvm/gems/ruby-2.6.0/gems/texsc-0.1.0/bin/texsc:33:in `<top (required)>'
/Users/yegor/.rvm/gems/ruby-2.6.0/gems/texsc-0.1.0/bin/texsc:95:in `rescue in <top (required)>': undefined method `[]' for nil:NilClass (NoMethodError)