Skip to main content

CommentFormat

All Cookstyle Cops


The department is: Chef/Style

The full name of the cop is: Chef/Style/CommentFormat


Enabled by default Supports autocorrection Target Chef Version
Enabled Yes All Versions

Checks for incorrectly formatted headers

Examples

incorrect

Copyright 2013-2016 Chef Software, Inc.
Recipe default.rb
Attributes default.rb
License Apache2
Cookbook tomcat
Cookbook Name:: Tomcat
Attributes File:: default

correct

Copyright:: 2013-2016 Chef Software, Inc.
Recipe:: default.rb
Attributes:: default.rb
License:: Apache License, Version 2.0
Cookbook:: Tomcat

Configurable attributes

Name Default value Configurable values
Version Added 5.0.0 String
Exclude
  • **/Berksfile
Array

Was this page helpful?

×








Search Results