Electron Builder: Please specify author 'email' in the application package.json

You must add an author object containing both a name and an email property to your application's package.json file. Electron Builder requires this metadata for proper package identification, license verification, and distribution signing. Without it, the build process will fail with a configuration error preventing artifact generation.

Understanding the Requirement

Electron Builder relies heavily on the standard Node.js package.json structure to gather information about your application. While many developers focus solely on the main, scripts, and dependencies fields, the author field is critical for several reasons. First, it serves as the primary contact point for users or distributors who may need to report issues or request support. Second, during the packaging phase, tools like npm and yarn use this data to populate metadata in the final executable or installer. The specific error "Please specify author 'email' in the application package.json" occurs because the builder cannot locate a valid email address within the author definition. This is not merely a suggestion; it is a validation check enforced by the build script. If the email is missing, the build aborts immediately. This requirement ensures that every distributed package has traceable origin information, which is particularly important for enterprise environments or when publishing to app stores that require strict metadata compliance.

Locating the Configuration File

To resolve this issue, you need to edit the root package.json file of your Electron project. This file is located in the top-level directory of your project workspace, alongside your source code files. It is a JSON-formatted text file that defines the project's name, version, dependencies, and scripts. You can open it using any standard text editor, such as VS Code, Sublime Text, or even a simple command-line editor like nano or vim. Ensure you are editing the correct package.json. If your project uses a monorepo structure or has nested packages, verify that you are modifying the one associated with the main Electron application entry point. Incorrectly editing a dependency's package.json will have no effect on the build process and may break other parts of your system. Once opened, look for the existing author field. In many starter templates, this field might be a simple string, such as "author": "John Doe", or it might be completely absent.

Common Mistakes in Author Formatting

A frequent cause of this error is formatting the author as a plain string rather than an object. The npm specification allows the author field to be either a string or an object. However, Electron Builder explicitly parses the object format to extract the email. If your file contains:

"author": "Jane Smith"

You must change it to:

"author": {
  "name": "Jane Smith",
  "email": "[email protected]"
}

Another common mistake is leaving the email value empty, such as "email": "". While this is syntactically valid JSON, some validators treat an empty string as undefined or missing. Always provide a valid, non-empty email address. Additionally, ensure there are no trailing commas in your JSON structure, as this is a syntax error that will prevent the entire file from being parsed correctly.

Implementing the Fix

Open your package.json file and locate the author key. If it does not exist, add it at the same level as name, version, and description. If it exists as a string, replace the entire line with the object structure shown below. Replace the placeholder values with your actual details.

{
  "name": "my-electron-app",
  "version": "1.0.0",
  "description": "My awesome app",
  "main": "src/main.js",
  "author": {
    "name": "Your Name",
    "email": "[email protected]"
  },
  "dependencies": {
    "electron": "^28.0.0"
  }
}

After saving the file, clear your npm cache if necessary, though usually, a direct rebuild is sufficient. Run your build command again, typically npm run build or npx electron-builder. The error should now be resolved. If you encounter further issues, ensure that the email format is valid (contains an @ symbol and a domain). For more complex configuration scenarios, you might also need to adjust how Electron Builder handles metadata. For instance, if you are dealing with runtime errors related to undefined properties in your preload scripts, you can refer to our guide on fixing TypeError issues in Electron applications. See: How to Fix TypeError: Cannot read properties of undefined (reading 'whenReady').

Verifying the Build Output

Once the build succeeds, you can verify that the metadata was correctly embedded into your application artifacts. For Windows installers, right-click the generated .exe or .msi file and select Properties. Go to the Details tab, and you should see the Author name and Email populated correctly. On macOS, you can use the defaults command in the terminal to inspect the app's info.plist file.

defaults read /path/to/YourApp.app/Contents/Info.plist Author

This step confirms that Electron Builder successfully extracted the data from your package.json and integrated it into the final product. Proper metadata inclusion is essential for professional distribution and helps avoid rejection from certain software repositories or internal IT approval processes that scan executables for publisher information.

Best Practices for Maintenance

Maintaining accurate metadata in package.json should be part of your release checklist. Consider using environment variables or a separate configuration file if you need to manage different author details for development, staging, and production builds. However, for most single-developer or small-team projects, hardcoding the correct author object in the root package.json is the simplest and most reliable approach. Regularly audit your dependencies and project configurations to ensure they remain compliant with the latest versions of Electron Builder.

Frequently Asked Questions

Can I omit the author field entirely?

No, Electron Builder requires the author field to contain both a name and an email. Omitting it or providing an incomplete object will cause the build to fail. The email is mandatory for generating valid package metadata and ensuring traceability of the distributed software.

What if my email changes frequently?

If you need to update your contact information often, consider using a generic support email address or a role-based alias like [email protected]. This avoids the need to modify your codebase every time a team member leaves or changes roles, ensuring consistent build stability.

Does this affect the app's functionality at runtime?

No, the author metadata in package.json is used exclusively during the build and packaging phase. It does not impact the runtime behavior of your Electron application. Users will not see this information in the UI unless you explicitly display it in your About dialog or settings screen.

How do I handle multiple authors in one project?

The standard npm package.json schema supports only a single author object. If you have multiple contributors, list the primary maintainer in the author field and include a contributors array instead. Electron Builder will still validate the single author object for the required email field.

Why do I get a JSON parsing error after adding the author?

JSON is strict about syntax. Ensure you have added commas between all properties and enclosed strings in double quotes. A missing comma after the previous line or a trailing comma after the last property in the object will cause the parser to fail. Use a JSON validator tool to check your file before running the build.