.\" Man page generated from reStructuredText.
.
.TH METADATA-JSON-LINT 1 "2020" "" ""
.SH NAME
metadata-json-lint \- Validate and lint metadata.json files in Puppet modules
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
metadata\-json\-lint [options] <path>
.fi
.sp
.SH DESCRIPTION
.sp
The \fBmetadata\-json\-lint\fP tool validates and lints \fBmetadata.json\fP files in
Puppet modules against style guidelines from the Puppet Forge module metadata
recommendations.
.sp
The tool can be used as a binary command, or it can be used as a rake task.
See the project\(aqs \fBREADME.md\fP file for instructions on how to use the rake
task.
.SH OPTIONS
.nf
\fB[no\-]strict\-dependencies\fP
.in +2
Whether to fail if module version dependencies are open\-ended. Defaults
to \fBfalse\fP\&.
.in -2
.fi
.sp
.nf
\fB[no\-]strict\-license\fP
.in +2
Whether to fail on strict license check. Defaults to \fItrue\fP\&.
.in -2
.fi
.sp
.nf
\fB[no\-]fail\-on\-warnings\fP
.in +2
Whether to fail on warnings. Defaults to \fItrue\fP\&.
.in -2
.fi
.sp
.nf
\fB[no\-]strict\-puppet\-version\fP
.in +2
Whether to fail if Puppet version requirements are open\-ended or no
longer supported. Defaults to \fIfalse\fP\&.
.in -2
.fi
.sp
.SH EXAMPLES
.sp
Test a metadata.json file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ metadata\-json\-lint /path/to/metadata.json
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fI\%https://docs.puppet.com/puppet/latest/modules_publishing.html#write\-a\-metadatajson\-file\fP
.SH AUTHOR
Gabriel Filion
.\" Generated by docutils manpage writer.
.