Bad error when trying to swizzle a theme component

[slorber]

🐛 Bug Report

Run yarn workspace docusaurus-2-website swizzle @docusaurus/theme-classic Layout on this repo

The error is expected as it's an internal theme component, not necessarily recommended for swizzling (at your own risks).

But this message seems unexpected to me.

Component "Layout" doesn't exists. "Layout" is swizzled instead of "Layout".

[compojoom]

I just ran into the same thing. The message is rather confusing, but what is even more confusing is that the suggested --danger flag doesn't work.

I can make component swizzling work only for the provided example in the docs - Footer - for anything else it fails to find the component.

> docusaurus swizzle "@docusaurus/theme-classic" "NavbarItem"

Component "NavbarItem" doesn't exists. "NavbarItem" is swizzled instead of "NavbarItem".
Error: NavbarItem is an internal component, and have a higher breaking change probability. If you want to swizzle it, use the "--danger" flag.

[compojoom]

Well, actually I was running this with yarn run swizzle -> which in terms calls docusaurus swizzle, but the arguments I was passing --danger` was not passed over.

[slorber]

@compojoom yes this is confusing, we'll fix this.

Afaik older npm/yarn might need -- --danger, the -- permit to pass extra args.

[idontknowjs]

hey @slorber I also faced this error "${INTERNAL_COMPONENT} is an internal component, and have a higher breaking change probability. If you want to swizzle it, use the "--danger" flag."

I think we could bring more clarity in the Error message by saying something like "If the error still exists, try -- --danger.
If yes, I would like to file a PR for the same.

[slorber]

I'm not sure what you mean @CovalentBond .
"If the error still exists" does not look correct to me and I prefer the current wording.
About -- --danger, the double -- is needed for npm only, not yarn, but would be happy, to adapt to the user's package manager automatically