Update rails-ujs readme #31881
Update rails-ujs readme #31881
Conversation
Add a note on using `yarn autoclean`.
|
Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @pixeltrix (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review. Please see the contribution instructions for more information. |
|
I tested this and it seems |
|
The problem is that rails-ujs's
This behavior is defined in the package.json. |
Tools like [yarn autoclean]() and [node-prune]() list `assets` as a directory to prune, and just because `rails-ujs.js` is placed under `lib/assets/compiled` it is deleted by them. In my case, rails-ujs was the only package out of more than 1300 packages that got dysfunctional after running `node-prune` (or `yarn autoclean --init && yarn install`). A warning is added to the README document by [rails#31881](), but it is easily missed. If there is no strong reason to use the subdirectory name `assets`, the path name should be changed so that no user attention or action is required. [yarn autoclean]: https://github.com/yarnpkg/yarn/blob/master/src/cli/commands/autoclean.js#L28 [node-prune]: https://github.com/tj/node-prune/blob/master/prune.go#L101 [rails#31881]: rails#31881
Summary
Add a note on using
yarn autoclean.Other Information
yarn autoclean --initcreates.yarncleanincludingassetsas for current stable version.