require-funding

This rule checks for the existence of the "funding" property in a package.json, and reports a violation if it doesn’t exist.

Example of incorrect code for this rule:

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0"
}

Example of correct code for this rule:

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0",
  "funding": {
    "type": "patreon",
    "url": "https://patreon.com/treznor"
  }
}

Options

Name	Description	Type	Default
ignorePrivate	Determines if this rule should be enforced when the package’s private property is true.	Boolean	false

{
  "package-json/require-funding": [
    "error",
    {
      "ignorePrivate": false
    }
  ]
}

Example of incorrect code for this rule with the { "ignorePrivate": false } option:

{
  "private": true
}

Example of correct code for this rule with the { "ignorePrivate": false } option:

{
  "private": true,
  "funding": {
    "type": "patreon",
    "url": "https://patreon.com/treznor"
  }
}

Example of incorrect code for this rule with the { "ignorePrivate": true } option:

{
  "private": false
}

{}

Example of correct code for this rule with the { "ignorePrivate": true } option:

{
  "private": true
}