jsii icon indicating copy to clipboard operation
jsii copied to clipboard

Documentation missing mandatory metadata

Open ajchili opened this issue 2 years ago • 2 comments

Describe the bug

When running npx jsii-config, main is a mandatory field for my package.json file.

Expected Behavior

I would expect the documentation to state this as a required field.

Current Behavior

Process fails and I have added main to my package.json file.

Reproduction Steps

  1. Create a package
  2. Exclude the main field from the package.json file
  3. Run npx jsii-config

Possible Solution

Update the author set-up guide to specify that main is a required field.

Additional Information/Context

No response

SDK version used

Not sure, failed before jsii was configured.

Environment details (OS name and version, etc.)

MacOS 12.2 + Node.JS 14.18.3 + NPM 6.14.15

ajchili avatar Sep 01 '22 18:09 ajchili

Perhaps there can be two author guides, one for new packages and one for existing packages?

ajchili avatar Sep 01 '22 20:09 ajchili

Related to #4259

mrgrain avatar Apr 09 '24 11:04 mrgrain