Skip to content
ESLint Plugin: Package JSON

require-author

🔧 This rule is automatically fixable by the --fix CLI option.

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

Examples

Section titled “Examples”
{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0"
}

Options

Section titled “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-author": [
    "error",
    {
      "ignorePrivate": false
    }
  ]
}

Examples

Section titled “Examples”

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

{
  "private": true
}

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

{
  "private": false
}
{}

Fixing

Section titled “Fixing”

This rule is automatically fixable and will create a new author property, when it’s missing. The author will have name and email, populated by data from git config. If the calls to git config fail, the fixer won’t make the change. In order to be more performant in monorepos, the author values retrieved from git config will be cached at the module level and will be reused across multiple runs.

Section titled “Related Rules”
  • require-attribution - Ensures that proper attribution is included in a package, requiring that either author or contributors is defined, and that if contributors is present, it should include at least one contributor.
  • valid-author - Enforces that the author property is valid.

Further Reading

Section titled “Further Reading”