puppet-lint-param-docs 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac9245ad58468d4c5d12ad908c1be44b419fbd6e
-  data.tar.gz: cebcc59f5a6d1600ba3ef2820f79d96309a8ff6f
+  metadata.gz: fe4696949ca7caeccf27cb18d522a4813218dc4d
+  data.tar.gz: 812dba9986c2cd858376fb452b4d05617fcd5c09
 SHA512:
-  metadata.gz: 0e3d0109f4e5223651116dbe771034ee026584b1a4d4c411bd2e16087f152326510f68bd1880e8e022f217bd54663d4ab107ed7446276bc833ce98e34b0df2e6
-  data.tar.gz: 4407de443fdff750b3b4049e5561d367f201e5a0d348baafdeeec10a416d42f6a68cf4d570893641d83865232edb8d76abb932794a77389ccef53b70c294c357
+  metadata.gz: eca1b30cb791537f7b47695629e3161bb6d584f239054c61eef830b3a3671e28dc4c7e37efcf97f4916d9ee59a38f27cbd240671b31b7902588d88d89a92caf5
+  data.tar.gz: 86641b2086ef5b0eff3dd076fe5ad1d032787394f72b5950896a8b3c87017b075e2477fa32dfb50c61d2e738e2fbf32a4bcd7ece3cfb08899bf4268349362d9a

data/README.md

@@ -30,3 +30,20 @@ don't have an RDoc description.
 WARNING: missing documentation for class parameter foo::bar
 WARNING: missing documentation for defined type parameter foo::baz
 ```
+
+### Selective rake task
+
+The usual puppet-lint rake task checks all manifests, which isn't always
+desirable with this particular check.  If your module contains many classes,
+some of which you don't wish to document, then you can exclude them using
+[control comments](http://puppet-lint.com/controlcomments/) or by using this
+helper to customise the lint rake task:
+
+  require 'puppet-lint-param-docs/tasks'
+  PuppetLintParamDocs.define_selective do |config|
+    config.pattern = ['manifests/init.pp', 'manifests/other/**/*.pp']
+  end
+
+This would disable the parameter_documentation check by default, but then
+defines a new rake task (which runs after `lint`) specifically for the files
+given in `config.pattern`.

data/lib/puppet-lint-param-docs.rb

@@ -0,0 +1 @@
+require 'puppet-lint-param-docs/tasks'

data/lib/puppet-lint-param-docs/tasks.rb

@@ -0,0 +1,40 @@
+module PuppetLintParamDocs
+  # A helper to define a more specific rake task that runs after the
+  # usual 'lint' task, but only with param docs checks.  It disables
+  # the param docs checks in the main lint task.
+  #
+  # Allows users to define a more restrictive pattern for param docs
+  # checks.
+  def self.define_selective(&task_block)
+    RakeTask.new.define_selective(&task_block)
+  end
+
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    def define_selective(&task_block)
+      PuppetLint::RakeTask.new(:lint_param_docs) do |config|
+        config.fail_on_warnings = true
+        config.disable_checks = (PuppetLint.configuration.checks - [:parameter_documentation])
+        yield config
+      end
+
+      # Explicitly enable check as "lint" task will disable it
+      task :lint_param_docs_enable do
+        PuppetLint.configuration.enable_parameter_documentation
+      end
+      Rake::Task[:lint_param_docs].enhance [:lint_param_docs_enable]
+
+      # Explicitly disable param doc in general lint task
+      task :lint_param_docs_disable do
+        PuppetLint.configuration.disable_parameter_documentation
+      end
+      Rake::Task[:lint].enhance [:lint_param_docs_disable]
+
+      # Run param docs lint after main lint
+      Rake::Task[:lint].enhance do
+        Rake::Task[:lint_param_docs].invoke
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -89,6 +89,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/puppet-lint-param-docs.rb
+- lib/puppet-lint-param-docs/tasks.rb
 - lib/puppet-lint/plugins/check_parameter_documentation.rb
 - spec/puppet-lint/plugins/check_parameter_documentation_spec.rb
 - spec/spec_helper.rb