File: metadata-json-lint.man.1.rst

package info (click to toggle)
metadata-json-lint 5.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 516 kB
  • sloc: ruby: 540; sh: 108; makefile: 8
file content (56 lines) | stat: -rw-r--r-- 1,387 bytes parent folder | download | duplicates (2)
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
==================
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