jekyll-pre-commit 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dce7e91d65ca281e50108205b57b036bea686231
-  data.tar.gz: b043f4fa3a65ee9e742fbcfc810de61cdd06c8d7
+  metadata.gz: 4f4f3db30d40cd9cf23c3bbc314def54359f3e87
+  data.tar.gz: e5415dd6ac9e548ccb2aad6ddd66d21f9c27b8c0
 SHA512:
-  metadata.gz: 2de2a293d7cca27ab1f382581c190eb85c881b3f936122bb374b7a5f466f696020916d8ffe9a0f5ab6fe775f08eac06626d69f3b3992c579d8574d4085ce53bd
-  data.tar.gz: 5f13d172dac25c2195237761cb520d0576b7f3441d56cd594ac9ab06a7e120092c19d17022418c4a693f186906afa6a0cf96a14657077acb7d7439cec443c4b4
+  metadata.gz: ecd3cd9d201390b564056828afd1095ed5dd102b3c30e5e0823dce375bb4ca9bd3dad914eabb90811b17756bf6caede1d954aba993e9d4edf447552f0cacc21a
+  data.tar.gz: 731583822f3ca9883617c9a3136ca05f88f26870579e98f3594991e305da8444ea82eefd6d54c2d01c5d468add747c83f603bb66339f7d0d2ae21a89df142fad

data/README.md

@@ -39,6 +39,8 @@ pre-commit:
   - check: NoDuplicateTags
 ```
 
+**NOTE:** Depending on your configuration, you may need use `bundle exec git commit` to ensure Ruby libraries are properly loaded to run the pre-commit checks.
+
 ## Available Checks
 
 #### FrontMatterVariableExists
@@ -81,6 +83,10 @@ In the above, there would be a maximum length of 50 characters for the title (ra
 
 Checks that you have not accidentally introduced a duplicate tag. For example, if you have posts that are already using "MySQL" as a tag and you attempt to commit a post with the tag "mysql"  (notice the difference in case-sensitivity) you will not be allowed to commit.
 
+#### NoTodos
+
+This check ensures that you haven't left and "todos" in your post. It does so by doing a case-insensitive check against the entire post content for the string "todo".
+
 ## Roll Your Own
 
 You can also add your own checks. To do so, create a class in the `Jekyll::PreCommit::Checks` module and and define a `check` method. Your class should extend the `Jekyll::PreCommit::Checks::Check` class and return the `@result` instance variable. 

data/lib/jekyll-pre-commit.rb

@@ -11,3 +11,4 @@ require 'jekyll-pre-commit/checks/front_matter_variable_exists.rb'
 require 'jekyll-pre-commit/checks/front_matter_variable_is_not_duplicate.rb'
 require 'jekyll-pre-commit/checks/front_matter_variable_meets_length_requirements.rb'
 require 'jekyll-pre-commit/checks/no_duplicate_tags.rb'
+require 'jekyll-pre-commit/checks/no_todos.rb'

data/lib/jekyll-pre-commit/checks/no_todos.rb

@@ -0,0 +1,18 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      class NoTodos < Check
+        def check(staged, not_staged, site, args)
+          staged.each do |post|
+            if post.to_s.downcase.include? 'todo'
+              @result[:ok] = false
+              @result[:message] += "A todo was found in #{post.data["title"]}. "
+            end
+          end
+
+          @result
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-pre-commit/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module PreCommit
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pre-commit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Chadwick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -89,6 +89,7 @@ files:
 - lib/jekyll-pre-commit/checks/front_matter_variable_is_not_duplicate.rb
 - lib/jekyll-pre-commit/checks/front_matter_variable_meets_length_requirements.rb
 - lib/jekyll-pre-commit/checks/no_duplicate_tags.rb
+- lib/jekyll-pre-commit/checks/no_todos.rb
 - lib/jekyll-pre-commit/checks/spell_check.rb
 - lib/jekyll-pre-commit/commands.rb
 - lib/jekyll-pre-commit/pre-commit
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to make sure your post is _really_ ready for publishing