manValidity

Enforces that the man property is valid.

✅ This rule is included in the package-json logical presets.

This rule checks that the man property is a string or an array of strings. The string(s) must end with a number (and optionally .gz).

Examples

❌ Incorrect

{
  "man": ["./man/doc.md"]
}

✅ Correct

{
  "man": ["./man/doc.1", "./man/doc.2"]
}

{
  "man": "./man/doc.1"
}

When Not To Use It

If you don’t need compliance with npm’s main field specification, you can disable this rule. For example, if you use a different package manager that treats the field differently, this rule may not be correct for you.

Related Rules

• manPresence - Enforces that the man property is present.

Further Reading

• npm: package.json > man

Equivalents in Other Linters

• ESLint: package-json/valid-man