Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-12-24 12:03:23 +00:00
Code Issues Projects Releases Packages Wiki Activity
inspec/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template
History
Clinton Wolfe 36069943c4 Add ability to generate reporter plugins using inspec init 
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2020-05-12 17:00:44 -04:00
..
lib Add ability to generate reporter plugins using inspec init 2020-05-12 17:00:44 -04:00
test Corresponding fixes for the move from test/unit/mock to test/fixtures. 2019-11-08 19:20:12 -08:00
Gemfile Remove # encoding: utf8 magic comments 2019-05-07 16:06:23 -07:00
inspec-plugin-template.gemspec Remove more magic comments 2019-05-09 13:24:25 -07:00
LICENSE support for LICENSE 2019-02-06 11:58:10 -05:00
Rakefile PR feedback on product capitalization 2019-02-06 11:58:10 -05:00
README.md All templates work, but need to decide on hooks 2019-02-06 11:58:10 -05:00

README.md

<%= module_name %> Plugin

This plugin was generated by inspec init plugin, and apparently the author, '<%= author_name %>', did not update the README.

To Install This Plugin

Assuming it has been published to RubyGems, you can install this gem using:

you@machine $ inspec plugin install <%= plugin_name %>

What This Plugin Does

No idea.

Developing This Plugin

The generated plugin contains everything a real-world, industrial grade plugin would have, including:

  • an (possibly incomplete) implementation of one or more InSpec Plugin Types
  • documentation (you are reading it now)
  • tests, at the unit and functional level
  • a .gemspec, for packaging and publishing it as a gem
  • a Gemfile, for managing its dependencies
  • a Rakefile, for running development tasks
  • Rubocop linting support for using the base InSpec project rubocop.yml (See Rakefile)