Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 1.6 KB

File metadata and controls

82 lines (62 loc) · 1.6 KB

require-homepage

This rule checks for the existence of the "homepage" 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",
	"homepage": "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-homepage": [
		"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,
	"homepage": "https://github.com/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
}