Document package.json fields in the reference

[brody4hire]

I can see how there is a reference page for config.xml but don’t see a corresponding reference page for package.json. I think the reference page for Cordova-specific package.json fields is needed.

I also think that how and when the Cordova CLI would update each of the fields in package.json is needed, just like this was already done for config.xml.

This issue is triggered by #1004 (deprecated plugins element in config.xml).

[killroy42]

Does anybody know how I can change the "build" key for release and debug builds on package.json? I could not find the docs for this...

[rajanarahul93]

Request to Assign:
Please assign this issue to me, and I will work on documenting the Cordova-specific package.json fields and their behavior.

Approach:

1. Understand Requirements: Analyze the package.json fields relevant to Cordova, including those updated by the CLI (e.g., dependencies, cordova).
2. Reference Existing Documentation: Review the config.xml reference as a model for structuring the new package.json documentation.
3. Document Usage: Provide a clear explanation of each field, when and how it is updated by the Cordova CLI, and its purpose.
4. Draft and Test: Draft the documentation and validate by checking against Cordova projects for accuracy.

I’ll ensure this documentation is comprehensive and aligns with existing standards.

@brody4hire