-
-
Notifications
You must be signed in to change notification settings - Fork 631
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
Remove js-yaml
peer dependency and mentions of removed webpackConfigLoader
#1678
Remove js-yaml
peer dependency and mentions of removed webpackConfigLoader
#1678
Conversation
WalkthroughThis pull request involves updates to documentation and dependency management for the React on Rails project. The changes primarily focus on removing the Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
💤 Files with no reviewable changes (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (4)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
@@ -17,7 +17,6 @@ The only requirements within this directory for basic React on Rails integration | |||
1. Your JavaScript code "registers" any components and stores per the ReactOnRails APIs of ReactOnRails.register(components) and ReactOnRails.registerStore(stores). See [our javascript API docs](https://www.shakacode.com/react-on-rails/docs/api/javascript-api/) and the [ReactOnRails.js source](https://github.com/shakacode/react_on_rails/tree/master/node_package/src/ReactOnRails.js). | |||
1. Set your registration file as an "entry" point in your Webpack configs. | |||
1. Add the [Manifest plugin](https://github.com/danethurber/webpack-manifest-plugin) to your config. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it actually a requirement? None of our examples seem to have it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shakapacker uses the webpack-assets-manifest plugin. If not using Shakapacker, then a manifest plugin isn't a requirement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CHANGELOG.md (1)
21-23
: Consider maintaining consistent blank lines between sections.While the blank line after the latest entry is good for readability, this pattern isn't consistent throughout the changelog. Consider maintaining this consistency across all version sections for better readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Gemfile.lock
is excluded by!**/*.lock
📒 Files selected for processing (4)
CHANGELOG.md
(1 hunks)docs/additional-details/manual-installation-overview.md
(0 hunks)docs/guides/webpack-configuration.md
(1 hunks)package.json
(0 hunks)
💤 Files with no reviewable changes (2)
- docs/additional-details/manual-installation-overview.md
- package.json
✅ Files skipped from review due to trivial changes (1)
- docs/guides/webpack-configuration.md
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: rspec-package-tests (newest)
- GitHub Check: build-dummy-app-webpack-test-bundles (oldest)
- GitHub Check: rspec-package-tests (oldest)
- GitHub Check: build
🔇 Additional comments (1)
CHANGELOG.md (1)
21-22
: LGTM! Changelog entry is well-formatted and accurate.The changelog entry properly documents the removal of the obsolete
js-yaml
peer dependency, follows the keepachangelog.com format, and correctly attributes the change to PR 1678 and contributor alexeyr-ci.
aac522b
to
0061016
Compare
0061016
to
e53311f
Compare
Summary
It looks like
js-yaml
was only needed forwebpackConfigLoader
, which was removed in 14.1.0.Pull Request checklist
Add/update test to cover these changesThis change is
Summary by CodeRabbit
Documentation
Dependency Management
js-yaml
peer dependency from project configuration.Changelog Updates