learn-co/learn-lint

Name: learn-lint

Owner: Learn.co

Description: null

Created: 2015-09-08 13:34:06.0

Updated: 2017-06-23 18:46:19.0

Pushed: 2017-09-24 21:36:56.0

Homepage: null

Size: 63

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

LearnLinter

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

• precense of .learn file
• valid yaml in .learn file
• valid whitespace for Learn in .learn file. 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.

Installation

From the command line, gem install learn_linter.

Usage

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) :)

Contributing

• 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).

License

The gem is available as open source under the terms of the MIT License.