require-repository

💼 This rule is enabled in the following configs: ✔️ legacy-recommended, ✅ recommended, 📦 recommended-publishable.

This rule checks for the existence of the "repository" 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"
}

Examples of correct code for this rule:

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0",
  "repository": "github:owner/project"
}

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0",
  "repository": {
    "type": "git",
    "url": "https://github.com/owner/project"
  }
}

Options

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

{
  "package-json/require-repository": [
    "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,
  "repository": "github:owner/project"
}

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
}