Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional keys appearing in the package.json after running chromatic publish for the first time #723

Open
Kamratow opened this issue Mar 6, 2023 · 1 comment
Assignees
Labels
bug Classification: Something isn't working CLI Cool-down needs triage Tracking: Issue needs confirmation

Comments

@Kamratow
Copy link

Kamratow commented Mar 6, 2023

Well, I guess this is not a bug but I cannot find any explanation regarding this.
When I try to run chromatic publish without "chromatic" in my package.json scripts I get prompted with question if I want to add "chromatic" to scripts. If I will confirm then the script is added but along with it there are some additional key added to package.json.
Tried it with the test repo (https://github.com/storybookjs/design-system) and there were 4 new keys added: "bugs", "homepage", "readme", "_id".

Can you tell me where does it come from and is it needed in any way for Chromatic to work properly? Just wondering as if this is not needed then I would prefer to remove this from package.json in my project as there will be no point in keeping those. For example for "readme" value is always "ERROR: No README data found!" and the "_id" key value is the current package name with version (this info is already present in the package.json so not sure why we should duplicate this). For me this looks like some kind of unwanted side effect of the script responsible for adding the chromatic command to package.json but still maybe it's somehow useful

I'm using chromatic 6.15.0 as the project I'm going to use it for is running on some older version of node and which is not compatible with newest version of chromatic.

An example of keys added to test repo package.json (they were added to the bottom as last keys):
"bugs": { "url": "https://github.com/storybookjs/design-system/issues" }, "readme": "ERROR: No README data found!", "homepage": "https://github.com/storybookjs/design-system#readme", "_id": "@storybook/[email protected]"

@Kamratow Kamratow added bug Classification: Something isn't working needs triage Tracking: Issue needs confirmation labels Mar 6, 2023
@bylertall
Copy link

It would be helpful to get an update on this. My team just ran into this with version 10.1.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Classification: Something isn't working CLI Cool-down needs triage Tracking: Issue needs confirmation
Projects
None yet
Development

No branches or pull requests

4 participants