[Docs] Add step to disable package.json synchronization while upgrading PHP package
#2698
Conversation
carsonbot
added
docs
carsonbot
added
Status: Reviewed
src/Autocomplete/assets/README.md
Outdated
| @@ -14,6 +14,18 @@ composer require symfony/ux-autocomplete:2.23.0 | |||
| npm add @symfony/[email protected] | |||
| ``` | |||
|
|
|||
| To prevent your `package.json` file from being overwritten by Symfony Flex when upgrading the PHP package, you must **use at least Symfony Flex ^1.22.0 or ^2.5.0**, and configure your `composer.json` file like this: | |||
There was a problem hiding this comment.
What about using the github markdown note ?
There was a problem hiding this comment.
Does it work on NPM website?
There was a problem hiding this comment.
I honestly dont know (same for packagist and other sf php repo readme)
But at least Github display info is clearer and denote this specific paragraph
|
I'm not sure here... as always by fear to make newcomers make mistake ... once this is enabled, installing packages will not work anymore, and then no documentation would help :| |
I see what you mean, but remember our UX npm packages are reserved for advanced users only, not newcomers. |
|
The problem is want to avoid is someone having no idea locally why they cannot install an UX package anymore. I do believe this is something we should address asap.. In the meantime i understand the need, so can we just add a warning ? Something like "Please be aware NONE of your installed paclages NOR the next you would install .... " (or something like that) ? |
A warning is displayed to the user when It should be enough no?
I will rewrite the paragraph to be more explicit about that |
…ding PHP package
Kocal
force-pushed
the
doc-npm-pkg-disable-pkg.json-sync
branch
from
5b4dab0 to
b3a15b4
Compare
|
PR updated |
Following symfony/symfony#58678 (comment)