Gem to accompany Learn curriculum development. Install gem and run from command line with learn-lint < directory name >. Given a directory, the gem will lint for
- presence of
.learnfile - valid yaml in
.learnfile - valid whitespace for Learn in
.learnfile. Learn requires two whitespace before a-in any lines containing a-. - precense of
LICENSE.md - valid license content in that file.
- precense of
README.md - valid code snippets in
README.md - precense of
CONTRIBUTING.md - valid contributing content in that file.
From the command line, gem install learn_linter.
Run from command line with learn-lint < directory name >.
Or, from within the directory you want to line, learn-lint
To turn off error message output to termina, use learn-lint <directory name> quiet or learn-lint quiet from within directory you want to lint.
Successes and failures will be printed out to your terminal (in color) :)
- Fork and clone this repo
- Bundle install and then run rspec
- If you add to the gem functionality, please be sure that any changes are tested. In your commit message/PR message, describe the change and describe the test, pointing out where to find the test (what file, what line).
The gem is available as open source under the terms of the MIT License.