Skip to content

require-publishConfig

This rule checks for the existence of the "publishConfig" 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",
"publishConfig": {
"exports": {
".": "./index.js"
}
}
}
NameDescriptionTypeDefault
ignorePrivateDetermines if this rule should be enforced when the package’s private property is true.Booleantrue
{
"package-json/require-publishConfig": [
"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,
"publishConfig": {
"exports": {
".": "./index.js"
}
}
}

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
}