learn-tool 0.0.16 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d759f8eb4d52c7c0a73d3eb067320d66341085777d1e22cef08c026fc0d02e0
-  data.tar.gz: 339ede530dbd6f1a4e1aa62a816a91f6bf40b697250582ce549c58cb82dae4d5
+  metadata.gz: 71fe36246ba3b898eff013d99569d72091bd0e575ee5efa2d52135e4425bed67
+  data.tar.gz: ac8b171728f7ff943d58d6bbe334d406b02e87a6236c781aa96ffac0954c693a
 SHA512:
-  metadata.gz: 1c31b985672fa05ea1ed8350103fd00fd536715c2336686ac490aee10cfb33425a9490d4927453182256518f47ea856505825a54309cdb96c128c61bad8cd8df
-  data.tar.gz: ab74b388effd6db8844f8c6ba89596e4e2fcea0cdafecf468ac98c9952079522d06114d693c8f29fcca7b7573120eadb1cdb214b7f3272c5ad37af9d75eb1c2a
+  metadata.gz: 07af1813e35c0678cc0eee5645f79cd68a160b313e537c259e9e090767bf7e6619416df40e91841352d4d64ebc5e7e57d5d4c6960914b7233b07227404b6d7d6
+  data.tar.gz: c3b7f30f1e39ec94cad66695614d58de030a8895ccad61d9569a7905a268f71085db9add823aae700dd17d3c7399ff422d0aa553623335e0eb9335f17b5e193e

data/bin/learn-tool

@@ -12,9 +12,10 @@ OptionParser.new do |opts|
     A tool for creating, cloning and repairing repositories. This tool has
     three basic commands
     
-    learn-tool create
-    learn-tool duplicate
-    learn-tool repair
+    learn-tool --create
+    learn-tool --duplicate
+    learn-tool --lint <optional: filepath>
+    learn-tool --repair <optional: filepath>
 
     When creating, you will need to provide a name of the repository you are
     creating and choose from an existing template.
@@ -25,23 +26,43 @@ OptionParser.new do |opts|
    
   EOBANNER
 
-  opts.on("--create", "-c", "Create new repository"){ |v| options[:create] = true }
-  opts.on("--duplicate", "-d", "Clone from existing repository"){ |v| options[:duplicate] = true }
-  opts.on("--repair", "-r", "Fix current repository"){ |v| options[:repair] = true }
+  opts.on("-c", "--create", 
+          "Create new repository") do |v| 
+            options[:create] = true
+          end
+  opts.on("-d", "--duplicate", 
+          "Clone from existing repository") do |v| 
+            options[:duplicate] = true 
+          end
+  opts.on("-l", "--lint [ABSOLUTE_FILEPATH]",
+          "Lint a directory given its absolute path. If blank, lints current directory") do |filepath| 
+            filepath ? options[:lint] = filepath : options[:lint] = Dir.pwd
+          end
+  opts.on("-r", "--repair [ABSOLUTE_FILEPATH]", 
+          "Add correct files to a directory given its absolute path. If blank, edits current directory") do |filepath| 
+            filepath ? options[:repair] = filepath : options[:repair] = Dir.pwd
+          end
+  
 end.parse!
 
 puts options
 
 if options[:create]
-    LearnTool.new("create")
+  LearnTool.new(mode: "create", filepath: Dir.pwd)
 end
 
 if options[:duplicate]
-    LearnTool.new("duplicate")
+  LearnTool.new(mode: "duplicate", filepath: Dir.pwd)
 end
 
-if options[:repair]
-    LearnTool.new("repair")
+if options[:lint]
+  LearnTool.new(mode: "lint", filepath: options[:lint])
 end
 
+if options[:repair]
+  LearnTool.new(mode: "repair", filepath: options[:repair])
+end
 
+if options == {}
+  LearnTool.new(mode: "lint", filepath: Dir.pwd)
+end

data/lib/learn-tool.rb

@@ -1,238 +1,50 @@
 require 'faraday'
 require 'uri'
 require 'open3'
+require_relative './learn-tool/learn-base'
+require_relative './learn-tool/learn-repair'
+require_relative './learn-tool/learn-create'
+require_relative './learn-tool/learn-duplicate'
+require_relative './learn-tool/learn-lint'
+require_relative './learn-tool/learn-error'
+require_relative './learn-tool/license-linter'
+require_relative './learn-tool/readme-linter'
+require_relative './learn-tool/yaml-linter'
+require_relative './learn-tool/contributing-linter'
 
 class LearnTool
-  GITHUB_ORG = 'https://api.github.com/repos/learn-co-curriculum/'
-  README_TEMPLATE = 'readme-template'
-  RUBY_LAB_TEMPLATE = 'ruby-lab-template'
-  JAVASCRIPT_LAB_TEMPLATE = 'js-lab-template'
-  REACT_LAB_TEMPLATE = 'react-lab-template'
+  
 
-  def initialize(mode)
-    @ssh_configured  = check_ssh_config
-    puts mode
+  def initialize(mode:, filepath:Dir.pwd)
+    puts filepath
     if mode == 'create'
-      create
+      LearnCreate.new(filepath)
     end
 
     if mode == 'duplicate'
-      duplicate
+      LearnDuplicate.new(filepath)
     end
 
     if mode == 'repair'
-      repair
-    end
-  end
-
-  def create
-    puts 'Note: You must have write access to the learn-co-curriculum org on GitHub to use this tool'
-    until name_new_repo do
-      puts 'Careful - rate limiting can occur'
+      LearnRepair.new(filepath)
     end
 
-    choose_repo_template
-    create_new_repo
-    end_message
-  end
-
-  def choose_repo_template
-    puts 'Is the lesson you are creating a Readme? (Y/n)'
-    readme_input = gets.chomp.downcase
-    if readme_input == "n" || readme_input == "no" || readme_input == "N" || readme_input == "No"
-      language = choose_language
-      case language
-      when /^ru/
-        @old_repo_name = RUBY_LAB_TEMPLATE
-      when /^j/
-        @old_repo_name = JAVASCRIPT_LAB_TEMPLATE
-      when /^re/
-        @old_repo_name = REACT_LAB_TEMPLATE
-      else
-        @old_repo_name = README_TEMPLATE
-      end
-    else
-      @old_repo_name = README_TEMPLATE
+    if mode == 'lint'
+      LearnLinter.new(filepath).lint_directory
     end
-    @old_repo_name
   end
 
-  def choose_language
-    language = ''
-    loop do
-      puts 'What lab template would you like to use? (Ruby/JavaScript/React)'
-      language = gets.chomp.downcase
-      break if language =~ /^(ru|j|re)/
-      puts 'Please enter Ruby, JavaScript or React, or at minimum, the first two letters:'
-      puts ''
-    end
-    language
-  end
-
-  def duplicate
-    puts 'Note: You must have write access to the learn-co-curriculum org on GitHub to use this tool'
-    loop do
-      puts 'What is the name of the repository you would like to copy? Paste exactly as is shown in the URL (i.e. advanced-hashes-hashketball)'
-      old_repo_name_input = gets.strip
-      if repo_exists(old_repo_name_input)
-        @old_repo_name = old_repo_name_input
-        puts ''
-        puts 'Old repository: ' + @old_repo_name
-        until name_new_repo do
-          puts 'Careful - rate limiting can occur'
-        end
-        
-        
-        create_new_repo
-        end_message
-        break
-      else
-        puts 'Provided repository name is not a valid learn-co-curriculum repository. Please try again. Careful - rate limiting can be triggered'
-      end
-    end
-  end
+ 
 
-  def name_new_repo
-    puts 'What is the name of the repository you would like to create?'
-    new_name = gets.strip.gsub(/\s+/, '-').downcase
-
-    if name_length_is_good(new_name)
-      if !repo_exists(new_name)
-        @new_repo_name = new_name
-      else
-        puts 'A repository with that name already exists. Please try again.'
-        return false
-      end
-    else
-      puts 'Repository names must be shorter than 100 characters'
-      return false
-    end
-    @new_repo_name
-  end
-
-  def create_new_repo
-    # 'cd' doesn't work the way it would in the shell, must be used before every command
-    puts 'Cloning old repository'
-    git_clone
-    # puts "Renaming old directory with new name: #{@new_repo_name}"
-    # rename_repo
-    puts ''
-    puts 'Creating new remote learn-co-curriculum repository'
-    git_create_and_set_new_origin
-    puts ''
-    puts 'Setting new git remote based on SSH settings'
-    git_set_remote
-    puts ''
-    puts 'Pushing all old-remote branches to new remote'
-    git_push
-  end
-
-  def end_message
-    puts ''
-    puts 'To access local folder, change directory into ' + @new_repo_name + '/'
-    puts "Repository available at #{GITHUB_ORG}" + @new_repo_name
-  end
-
-  private
-
-  def git_clone
-    cmd = "git clone https://github.com/learn-co-curriculum/#{@old_repo_name} #{@new_repo_name}"
-    puts cmd
-    `#{cmd}`
-  end
-
-  def git_create_and_set_new_origin
-    # Creates repo **and** assigns new remote to 'origin' shortname
-    cmd = cd_into_and("hub create learn-co-curriculum/#{@new_repo_name}")
-    puts cmd
-    `#{cmd}`
-  end
-
-  def git_set_remote
-    remote = check_ssh_config ? "git@github.com:learn-co-curriculum/#{@new_repo_name}.git" : "https://github.com/learn-co-curriculum/#{@new_repo_name}"
-    cmd = cd_into_and("git remote set-url origin #{remote}")
-    puts cmd
-    `#{cmd}`
-  end
-
-  def git_push
-    # Copy `master`, attempt to copy `solution`, but if it's not there, no complaints
-    cmds = [
-      %q|git push origin 'refs/remotes/origin/master:refs/heads/master' > /dev/null 2>&1|,
-      %q|git push origin 'refs/remotes/origin/solution:refs/heads/solution' > /dev/null 2>&1|
-    ]
-    cmds.each { |cmd| `#{cd_into_and(cmd)}` }
-  end
-
-  def repo_exists(repo_name)
-    url = GITHUB_ORG + repo_name
-    encoded_url = URI.encode(url).slice(0, url.length)
-    check_existing = Faraday.get URI.parse(encoded_url)
-    !check_existing.body.include? '"Not Found"'
-  end
-
-  def cd_into_and(command)
-    "cd #{@new_repo_name} && #{command}"
-  end
-
-  def create_support_file(name_of_file)
-    # copies a template folder from the learn_create gem to a subfolder of the current directory
-    gem_template_location = File.dirname(__FILE__)
-    template_path = File.expand_path(gem_template_location) + "/support_files/#{name_of_file.upcase}"
-    cmd = "cp #{template_path} #{Dir.pwd}"
-    `#{cmd}`
-  end
-
-  def create_dot_learn_file
-    `
-cat > .learn <<EOL
-languages:
-- none
-    `
-  end
   
-#   def create_dot_gitignore_file
-#     `
-# cat > .gitignore <<EOL
-# .DS_Store
-# logs
-# *.log
-# npm-debug.log*
-# pids
-# *.pid
-# *.seed
-# lib-cov
-# build/Release
-# node_modules
-# jspm_packages
-# .npm
-# .node_repl_history
-# .results.json
-# /.bundle
-# /db/*.sqlite3
-# /db/*.sqlite3-journal
-# /log/*
-# !/log/.keep
-# /tmp
-#     `
-#   end
 
   
 
-  def repair
-    create_dot_learn_file
-    create_support_file("LICENSE.md")
-    create_support_file("CONTRIBUTING.md")
-  end
+  
 
-  def name_length_is_good(name)
-    name.length < 100
-  end
+  
 
-  def check_ssh_config
-    result = Open3.capture2e('ssh -T git@github.com').first
-    result.include?("You've successfully authenticated")
-  end
+  
 
   
 end

data/lib/learn-tool/contributing-linter.rb

@@ -0,0 +1,23 @@
+class ContributingLinter 
+
+    VALID_FILE = File.open(File.expand_path(File.dirname(__FILE__)) + '/support_files/CONTRIBUTING.md')
+  
+    def self.parse_file(file, learn_error)
+      directory_file = sanitize_whitespace(File.open(file).read)
+      valid_file_array = sanitize_whitespace(VALID_FILE.read)
+      diff = directory_file - valid_file_array
+  
+      if diff.empty?
+        learn_error.contributing_error[:valid_contributing] = true
+        learn_error.valid_contributing = {message: "valid CONTRIBUTING.md", color: :green}
+      else
+        learn_error.contributing_error[:valid_contributing] = false
+        learn_error.valid_contributing = {message: "invalid CONTRIBUTING.md - Errors: #{diff}", color: :red}
+      end
+    end
+  
+    def self.sanitize_whitespace(file)
+      file.split.delete_if {|char| char.empty? || char == "\n"}
+    end
+  
+  end

data/lib/learn-tool/learn-base.rb

@@ -0,0 +1,112 @@
+require 'pry'
+class LearnBase
+
+  GITHUB_ORG = 'https://api.github.com/repos/learn-co-curriculum/'
+  README_TEMPLATE = 'readme-template'
+  RUBY_LAB_TEMPLATE = 'ruby-lab-template'
+  JAVASCRIPT_LAB_TEMPLATE = 'js-lab-template'
+  REACT_LAB_TEMPLATE = 'react-lab-template'
+
+  def initialize(filepath)
+    @filepath = filepath
+    @old_repo_name = ''
+    @new_repo_name = ''
+  end
+
+  def repo_is_available(repo_name)
+    url = GITHUB_ORG + repo_name
+    encoded_url = URI.encode(url).slice(0, url.length)
+    check_existing = Faraday.get URI.parse(encoded_url)
+    check_existing.body.include? '"Not Found"'
+  end
+
+  def cd_into_and(filepath, command)
+    puts filepath, command
+    cmd = "cd #{filepath} && #{command}"
+    `#{cmd}`
+  end
+
+  def name_new_repo
+    puts 'What is the name of the repository you would like to create?'
+    new_name = gets.strip.gsub(/\s+/, '-').downcase
+
+    if name_length_is_good(new_name)
+      if repo_is_available(new_name)
+        @new_repo_name = new_name
+      else
+        puts 'A repository with that name already exists. Please try again.'
+        return false
+      end
+    else
+      puts 'Repository names must be shorter than 100 characters'
+      return false
+    end
+    @new_repo_name
+  end
+
+  def get_new_name
+    puts 'Note: You must have write access to the learn-co-curriculum org on GitHub to use this tool'
+    until name_new_repo do
+      puts 'Careful - rate limiting can occur'
+    end
+  end
+
+  def create_new_repo
+    # 'cd' doesn't work the way it would in the shell, must be used before every command
+    puts 'Cloning old repository'
+    git_clone
+    # puts "Renaming old directory with new name: #{new_repo_name}"
+    # rename_repo
+    puts ''
+    puts 'Creating new remote learn-co-curriculum repository'
+    git_create_and_set_new_origin
+    puts ''
+    puts 'Setting new git remote based on SSH settings'
+    git_set_remote
+    puts ''
+    puts 'Pushing all old-remote branches to new remote'
+    git_push
+  end
+
+  def end_message
+    puts ''
+    puts 'To access local folder, change directory into ' + @new_repo_name + '/'
+    puts "Repository available at #{GITHUB_ORG}" + @new_repo_name
+  end
+
+  private
+
+  def git_clone
+    cmd = "git clone https://github.com/learn-co-curriculum/#{@old_repo_name} #{@new_repo_name}"
+    puts cmd
+    `#{cmd}`
+  end
+
+  def git_create_and_set_new_origin
+    # Creates repo **and** assigns new remote to 'origin' shortname
+    cd_into_and(@filepath + "/#{@new_repo_name}", "hub create learn-co-curriculum/#{@new_repo_name}")
+  end
+
+  def git_set_remote
+    remote = check_ssh_config ? "git@github.com:learn-co-curriculum/#{@new_repo_name}.git" : "https://github.com/learn-co-curriculum/#{new_repo_name}"
+    cd_into_and(@filepath + "/#{@new_repo_name}", "git remote set-url origin #{remote}")
+  end
+
+  def git_push
+    # Copy `master`, attempt to copy `solution`, but if it's not there, no complaints
+    cmds = [
+      %q|git push origin 'refs/remotes/origin/master:refs/heads/master' > /dev/null 2>&1|,
+      %q|git push origin 'refs/remotes/origin/solution:refs/heads/solution' > /dev/null 2>&1|
+    ]
+    cmds.each { |cmd| cd_into_and(@filepath + "/#{@new_repo_name}", cmd) }
+  end
+
+  def name_length_is_good(name)
+    name.length < 100
+  end
+
+  def check_ssh_config
+    result = Open3.capture2e('ssh -T git@github.com').first
+    result.include?("You've successfully authenticated")
+  end
+end

data/lib/learn-tool/learn-create.rb

@@ -0,0 +1,44 @@
+class LearnCreate < LearnBase
+
+    def initialize(filepath)
+      super(filepath)
+      get_new_name
+      choose_repo_template
+      create_new_repo
+      end_message
+    end
+
+    def choose_repo_template
+      puts 'Is the lesson you are creating a Readme? (Y/n)'
+      readme_input = gets.chomp.downcase
+      if readme_input == "n" || readme_input == "no" || readme_input == "N" || readme_input == "No"
+        language = choose_language
+        case language
+        when /^ru/
+          @old_repo_name = RUBY_LAB_TEMPLATE
+        when /^j/
+          @old_repo_name = JAVASCRIPT_LAB_TEMPLATE
+        when /^re/
+          @old_repo_name = REACT_LAB_TEMPLATE
+        else
+          @old_repo_name = README_TEMPLATE
+        end
+      else
+        @old_repo_name = README_TEMPLATE
+      end
+      @old_repo_name
+    end
+  
+    def choose_language
+      language = ''
+      loop do
+        puts 'What lab template would you like to use? (Ruby/JavaScript/React)'
+        language = gets.chomp.downcase
+        break if language =~ /^(ru|j|re)/
+        puts 'Please enter Ruby, JavaScript or React, or at minimum, the first two letters:'
+        puts ''
+      end
+      language
+    end
+
+end

data/lib/learn-tool/learn-duplicate.rb

@@ -0,0 +1,31 @@
+class LearnDuplicate < LearnBase
+
+  def initialize(filepath)
+    super(filepath)
+    puts 'Note: You must have write access to the learn-co-curriculum org on GitHub to use this tool'
+    get_old_repo
+  end
+
+  def get_old_repo  
+    loop do
+      puts 'What is the name of the repository you would like to copy? Paste exactly as is shown in the URL (i.e. advanced-hashes-hashketball)'
+      old_repo_name_input = gets.strip
+      if !repo_is_available(old_repo_name_input)
+        @old_repo_name = old_repo_name_input
+        puts ''
+        puts 'Old repository: ' + @old_repo_name
+        until name_new_repo do
+          puts 'Careful - rate limiting can occur'
+        end
+        
+        
+        create_new_repo
+        end_message
+        break
+      else
+        puts 'Provided repository name is not a valid learn-co-curriculum repository. Please try again. Careful - rate limiting can be triggered'
+      end
+    end
+  end
+
+end

data/lib/learn-tool/learn-error.rb

@@ -0,0 +1,69 @@
+class LearnError < StandardError
+  attr_accessor :filepath, :valid_yaml, :valid_license, 
+  :present_learn, :present_license, :present_readme, :yaml_error, 
+  :readme_error, :license_error, :valid_readme, :correct_yaml_content, 
+  :valid_contributing, :present_contributing, :contributing_error
+
+  ESCAPES = { :green  => "\033[32m",
+              :yellow => "\033[33m",
+              :red    => "\033[31m",
+              :reset  => "\033[0m" }
+
+
+  def initialize
+    @yaml_error = {present_dotlearn: false, valid_yaml: false, valid_whitespace: false, attributes: false}
+    @readme_error = {present_readme: false, valid_readme: false}
+    @license_error = {present_license: false, valid_license: false}
+    @contributing_error = {present_contributing: false, valid_contributing: false}
+
+    @correct_yaml_content = {message: ".learn file must have 'languages' key", color: :red}
+
+    @valid_yaml = {message: "invalid yaml", color: :red}
+    @valid_license = {message: "invalid or missing license content", color: :yellow}
+    @valid_readme = {message: [], color: :red}
+    @valid_contributing = {message: "invalid or missing contributing content", color: :yellow}
+
+    @present_learn = {message: "missing .learn file", color: :red}
+    @present_license = {message: "missing LICENSE.md", color: :red}
+    @present_readme = {message: "missing README.md", color: :red}
+    @present_contributing = {message: "missing CONTRIBUTING.md", color: :red}
+
+  end
+
+  def emit(opts={})
+    color   = opts[:color]
+    message = opts[:message]
+    print ESCAPES[color]
+    print message
+    print ESCAPES[:reset]
+    print "\n"
+  end
+
+  def total_errors
+    {
+      dot_learn: yaml_error,
+      license: license_error,
+      readme: readme_error,
+      contributing: contributing_error
+    }
+    
+  end
+
+  def result_message
+    [present_learn, valid_yaml, correct_yaml_content, present_license, valid_license, present_readme, valid_readme, present_contributing, valid_contributing ]
+  end
+
+
+  def result_output
+    result_message.each do |result|
+      if result[:message].is_a?(Array)
+        result[:message].each do |result_message| 
+          emit({message: result_message, color: result[:color]})
+        end
+      else
+        emit(result)
+      end
+    end
+  end
+
+end

data/lib/learn-tool/learn-lint.rb

@@ -0,0 +1,55 @@
+class LearnLinter
+    def initialize(filepath)
+        @learn_error = LearnError.new
+        @filepath = filepath
+    end
+
+    def result_message
+      @learn_error.result_message
+    end
+  
+    def has_file?(file)
+      Dir.entries(@filepath).include?(file) || Dir.entries(@filepath).include?(file.upcase) || Dir.entries(@filepath).include?(file.downcase)
+    end
+
+    def lint_directory
+      self.yaml_lint
+      self.license_lint
+      self.readme_lint
+      self.contributing_lint
+      @learn_error.result_output
+      @learn_error.total_errors
+    end
+
+    def yaml_lint
+      if self.has_file?(".learn")
+        @learn_error.yaml_error[:present_dotlearn] = true
+        @learn_error.present_learn = {message: "present .learn file", color: :green}
+        YamlLint.parse_file("#{@filepath}/.learn", @learn_error)
+      end
+    end
+  
+    def license_lint
+      if self.has_file?("LICENSE.md")
+        @learn_error.license_error[:present_license] = true
+        @learn_error.present_license = {message: "present LICENSE.md", color: :green}
+        LicenseLinter.parse_file("#{@filepath}/LICENSE.md", @learn_error)
+      end
+    end
+  
+    def readme_lint
+      if self.has_file?("README.md")
+        @learn_error.readme_error[:present_readme] = true
+        @learn_error.present_readme = {message: "present README.md", color: :green}
+        ReadmeLinter.parse_file("#{@filepath}/README.md", @learn_error)
+      end
+    end
+  
+    def contributing_lint
+      if self.has_file?("CONTRIBUTING.md")
+        @learn_error.contributing_error[:present_contributing] = true
+        @learn_error.present_contributing = {message: "present CONTRIBUTING.md", color: :green}
+        ContributingLinter.parse_file("#{@filepath}/CONTRIBUTING.md", @learn_error)
+      end
+    end
+end

data/lib/learn-tool/learn-repair.rb

@@ -0,0 +1,25 @@
+class LearnRepair < LearnBase
+
+    def initialize(filepath)
+      super(filepath)
+      cd_into_and(filepath, create_dot_learn_file)
+      cd_into_and(filepath, create_support_file("LICENSE.md"))
+      cd_into_and(filepath, create_support_file("CONTRIBUTING.md"))
+    end
+
+    def create_dot_learn_file
+    `
+cat > .learn <<- EOL
+languages:
+  - none
+`
+    end
+
+    def create_support_file(name_of_file)
+      # copies a template folder from the learn_create gem to a subfolder of the current directory
+      gem_template_location = File.dirname(__FILE__)
+      template_path = File.expand_path(gem_template_location) + "/support_files/#{name_of_file}"
+      "cp #{template_path} #{@filepath}"
+    end
+    
+end

data/lib/learn-tool/license-linter.rb

@@ -0,0 +1,27 @@
+class LicenseLinter 
+
+    VALID_FILE = File.open(File.expand_path(File.dirname(__FILE__)) + '/support_files/LICENSE.md')
+    VALID_YEARS = ["2015","2016","2017","2018","2019","2020","2021","2022","2023","2024","2025"]
+  
+    def self.parse_file(file, learn_error)
+      directory_file_array = sanitize_whitespace(File.open(file).read)
+      valid_file_array = sanitize_whitespace(VALID_FILE.read)
+      diff = directory_file_array - valid_file_array
+      
+      VALID_YEARS.each do |year| 
+        diff.delete(year)
+      end
+  
+      if diff.empty?
+        learn_error.license_error[:valid_license] = true
+        learn_error.valid_license = {message: "valid LICENSE.md", color: :green}
+      else
+        learn_error.license_error[:valid_license] = false
+        learn_error.valid_license = {message: "invalid LICENSE.md - Errors: #{diff}", color: :red}
+      end
+    end
+  
+    def self.sanitize_whitespace(file)
+      file.split.delete_if {|char| char.empty? || char == "\n"}
+    end
+  end

data/lib/learn-tool/readme-linter.rb

@@ -0,0 +1,55 @@
+class ReadmeLinter
+
+    def self.parse_file(file, learn_error)
+      if has_code_snippets?(file)
+        lines = collect_lines(file)
+        validate_snippets(lines, learn_error)
+      else
+         green_light(learn_error)
+      end
+    end
+  
+    def self.green_light(learn_error)
+      learn_error.readme_error[:valid_readme] = true
+      learn_error.valid_readme = {message: "valid readme", color: :green}
+    end
+  
+    def self.has_code_snippets?(file)
+      file_content = File.open(file).read
+      file_content.match(/``/)
+    end
+  
+    def self.collect_lines(file)
+      lines = {}
+      File.foreach(file) do |line_content|
+        lines["#{$.}"] = line_content
+      end
+      lines
+    end
+  
+    def self.validate_snippets(lines, learn_error)
+      lint_lines(lines, learn_error)
+      total_errors?(learn_error)
+    end
+  
+    def self.lint_lines(lines, learn_error)
+      lines.each do |line_num, line_content|
+        if line_content.match(/``/)
+          if !(line_content.match(/^```(ruby|rb|bash|sh|swift|html|erb|js|javascript|objc|java|sql|css|text|python)?$/)) 
+            learn_error.valid_readme[:message] << "INVALID CODE SNIPPET - line #{line_num}: #{line_content}"
+          end
+        end
+      end
+    end
+  
+    def self.total_errors?(learn_error)
+      if error_free?(learn_error)
+          green_light(learn_error)
+      end
+    end
+  
+    def self.error_free?(learn_error)
+      learn_error.valid_readme[:message].empty?
+    end
+  end
+  

data/lib/learn-tool/yaml-linter.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+class YamlLint
+
+
+  def self.parse_file(file, learn_error)
+    begin
+      YAML.load_file(file)
+    rescue Exception => err
+      learn_error.valid_yaml = {message: "#{err}", color: :red}
+    else
+      learn_error.yaml_error[:valid_yaml] = true
+      if check_attributes(file)
+        learn_error.yaml_error[:attributes] = true
+        learn_error.correct_yaml_content = {message: "valid attribute key names", color: :green}
+      end
+      if self.validate_whitespace_for_learn(file)
+        learn_error.yaml_error[:valid_whitespace] = true
+        learn_error.valid_yaml = {message: "valid yaml and valid whitespace.", color: :green}
+      else 
+        learn_error.valid_yaml = {message: "valid yaml but invalid whitespace", color: :red}
+      end
+    end
+  end
+
+  def self.validate_whitespace_for_learn(file)
+    lines = file_lines(file).split("\n")
+    attributes = lines.select { |line| line.include?("-") }
+    attributes.each do |attribute| 
+      return false unless attribute[0..3] == "  - "
+    end
+    true
+  end 
+
+   def self.check_attributes(file)
+    file_string = file_lines(file)
+    file_string.match(/languages/)
+  end
+
+  def self.file_lines(file)
+    f = File.read(file)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: learn-tool
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.20
 platform: ruby
 authors:
 - flatironschool
@@ -38,8 +38,18 @@ files:
 - Rakefile
 - bin/learn-tool
 - lib/learn-tool.rb
-- lib/support_files/CONTRIBUTING.md
-- lib/support_files/LICENSE.md
+- lib/learn-tool/contributing-linter.rb
+- lib/learn-tool/learn-base.rb
+- lib/learn-tool/learn-create.rb
+- lib/learn-tool/learn-duplicate.rb
+- lib/learn-tool/learn-error.rb
+- lib/learn-tool/learn-lint.rb
+- lib/learn-tool/learn-repair.rb
+- lib/learn-tool/license-linter.rb
+- lib/learn-tool/readme-linter.rb
+- lib/learn-tool/support_files/CONTRIBUTING.md
+- lib/learn-tool/support_files/LICENSE.md
+- lib/learn-tool/yaml-linter.rb
 homepage: https://github.com/learn-co-curriculum/learn-tool
 licenses:
 - MIT