1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
Description: create man page for metadata-json-lint
The metadata-json-lint binary doesn't have a man page. The project's README
file has an example usage and information about options so we can reuse that
information.
.
This patch creates a man page for the binary that will get compiled with the
rules file.
Author: Gabriel Filion <gabriel@koumbit.org>
Forwarded: https://github.com/voxpupuli/metadata-json-lint/pull/158
--- /dev/null
+++ b/metadata-json-lint.man.1.rst
@@ -0,0 +1,56 @@
+==================
+metadata-json-lint
+==================
+
+-------------------------------------------------------
+Validate and lint metadata.json files in Puppet modules
+-------------------------------------------------------
+
+:Author: Gabriel Filion
+:Date: 2020
+:Manual section: 1
+
+Synopsis
+========
+
+| metadata-json-lint [options] <path>
+
+Description
+===========
+
+The ``metadata-json-lint`` tool validates and lints ``metadata.json`` files in
+Puppet modules against style guidelines from the Puppet Forge module metadata
+recommendations.
+
+The tool can be used as a binary command, or it can be used as a rake task.
+See the project's ``README.md`` file for instructions on how to use the rake
+task.
+
+Options
+=======
+
+| **[no-]strict-dependencies**
+| Whether to fail if module version dependencies are open-ended. Defaults
+| to ``false``.
+
+| **[no-]strict-license**
+| Whether to fail on strict license check. Defaults to `true`.
+
+| **[no-]fail-on-warnings**
+| Whether to fail on warnings. Defaults to `true`.
+
+| **[no-]strict-puppet-version**
+| Whether to fail if Puppet version requirements are open-ended or no
+| longer supported. Defaults to `false`.
+
+Examples
+========
+
+Test a metadata.json file::
+
+ $ metadata-json-lint /path/to/metadata.json
+
+See also
+========
+
+https://docs.puppet.com/puppet/latest/modules_publishing.html#write-a-metadatajson-file
|
