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

Remove js-yaml peer dependency and mentions of removed webpackConfigLoader #1678

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

alexeyr-ci
Copy link
Collaborator

@alexeyr-ci alexeyr-ci commented Jan 15, 2025

Summary

It looks like js-yaml was only needed for webpackConfigLoader, which was removed in 14.1.0.

Pull Request checklist

  • Add/update test to cover these changes
  • Update documentation
  • Update CHANGELOG file

This change is Reviewable

Summary by CodeRabbit

  • Documentation

    • Updated Webpack configuration guide with minor grammatical correction.
    • Removed specific line about default Webpack asset loading path in manual installation overview.
  • Dependency Management

    • Removed js-yaml peer dependency from project configuration.
  • Changelog Updates

    • Added details about version changes, including method renaming and server rendering improvements.
    • Documented fixes and enhancements for version 14.1.0.

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

This pull request involves updates to documentation and dependency management for the React on Rails project. The changes primarily focus on removing the js-yaml peer dependency, updating the changelog with method renaming and various improvements, and making minor grammatical corrections in documentation. Additionally, a line regarding the default Webpack asset loading path has been removed, which may affect user understanding of the setup process.

Changes

File Change Summary
CHANGELOG.md - Removed js-yaml peer dependency
- Renamed ReactOnRails.registerStore to registerStoreGenerators
- Updated version 14.1.0 sections with various fixes and improvements
docs/additional-details/manual-installation-overview.md Removed line about default Webpack asset loading path
docs/guides/webpack-configuration.md Corrected grammatical error in Shakapacker configuration description
package.json Removed js-yaml peer dependency

Possibly related PRs

Suggested reviewers

  • justin808

Poem

🐰 A rabbit's tale of code so bright,
Dependencies trimmed with delight,
Docs polished, grammar set just right,
React on Rails takes a nimble flight,
Coding magic in pure white! 🚀


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0061016 and e53311f.

⛔ 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 as they are similar to previous changes (2)
  • docs/guides/webpack-configuration.md
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: rspec-package-tests (newest)
  • GitHub Check: rspec-package-tests (oldest)
  • GitHub Check: build-dummy-app-webpack-test-bundles (oldest)
  • GitHub Check: build

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@@ -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.
Copy link
Collaborator Author

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.

Copy link
Contributor

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between fc789d9 and aac522b.

⛔ 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.

@alexeyr-ci alexeyr-ci force-pushed the alexeyr/remove-webpackConfigLoader-mentions branch from aac522b to 0061016 Compare January 16, 2025 14:16
@alexeyr-ci alexeyr-ci force-pushed the alexeyr/remove-webpackConfigLoader-mentions branch from 0061016 to e53311f Compare January 16, 2025 14:21
@alexeyr-ci alexeyr-ci merged commit 611b00e into master Jan 16, 2025
11 checks passed
@alexeyr-ci alexeyr-ci deleted the alexeyr/remove-webpackConfigLoader-mentions branch January 16, 2025 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants