mtuchowski / mdspell Goto Github PK

Hi,

I might just do something wrong, but travis doesn't fail on translation errors.

https://travis-ci.org/codingjoe/django-cc/jobs/122596051

The funny thing is, when I run the same command locally it works:

mdspell --en-us -ran "**/*.md"; echo $?
    howto/travis-ci.md
        4 | with Github. 
        9 | Travis-CI is free for OpenSource projects. We encourage you to 
       11 | OpenSource packages you rely on every da 
       20 | Next head over to [travis-ci.org](https://travis-ci.org/)  
       23 | If you have the [travis command line tool] installed  
       28 | ## Automatic PyPi deployment 
       31 | [PyPi deployment](https://docs.trav 
       34 | [travis command line tool] 
       43 | Type in your PyPi username and password and ans 
       46 | ew deployment section in your travis 
       47 | config. Similar to this: 
       65 | Github. 
       71 | Travis-CI will now do the PyPi deployment for you! 

    README.md
      114 | ### pydocstyle 
      116 | [pydocstyle][pydocstyle] checks doc strin 

>> 15 spelling errors found in 3 files
1

How do i ignore some word / whitelist word? So that for a particular word it won't be interpreted as typo.

Right now the implementation is highly coupled to calling via the command line interface.

This is a bit awkward if you want to invoke it from another library / gem (which I do).

I think it's simply a matter of adding a new class method to MdSpell that's an alternat entry point to 'run', ie:

• Accept the configuration options as kwargs
• Make spellchecker work on arbitrary strings instead of files (seems to be a leaky abstraction, it should only be concerned with checking strings)
• Refactor check_file to load file contents into a string
• Create check_string analog to check_file
• Be able to invoke check_file or check_string as public methods

I can create this PR if you agree with the approach @mtuchowski

Hi, i try to run mdspell but seems like the CLI is not working

vmuser@vm1:~/repo $ gem install mdspell
Successfully installed mdspell-0.1.2
Parsing documentation for mdspell-0.1.2
Done installing documentation for mdspell after 0 seconds
1 gem installed
vmuser@vm1:~/repo $ mdspell
mdspell: command not found