Fix: esbuild loader documentation error

[adriangohjw]

should be webpack_loader instead, similar to https://github.com/shakacode/shakapacker/blob/main/docs/using_swc_loader.md

Summary

Pull Request checklist

- [ ] Add/update test to cover these changes

• Update documentation
• Update CHANGELOG file

Other Information

N.A.

Summary by CodeRabbit

• Documentation
  • Corrected esbuild loader documentation to update configuration value from shakapacker_loader to webpack_loader.
  • Fixed an incorrect instruction in the esbuild loader documentation in the CHANGELOG.md file.

[coderabbitai]

Walkthrough

The changes involve a correction in the esbuild loader documentation within the CHANGELOG.md and docs/using_esbuild_loader.md files. Specifically, an instruction in the esbuild loader setup was modified to reflect the accurate configuration value. This update replaces shakapacker_loader with webpack_loader in the shakapacker.yml configuration file to properly utilize esbuild instead of babel.

Changes

File	Change Summary
CHANGELOG.md	Fixed incorrect instruction in esbuild loader documentation.
docs/using_esbuild_loader.md	Updated configuration value from shakapacker_loader to webpack_loader in the guide.

Poem

In the land of code, a change did loom,
To clear the docs of esbuild's gloom.
With webpack_loader, bright and clear,
The setup sings, no quirks to fear.
Thanks to Adrian's guiding light,
The path to build is now set right. 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[adriangohjw]

Failing specs is an ongoing issue independent of this change

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

CHANGELOG.md (1)

15-15: Change list item style to asterisk for consistency.

The rest of the file uses asterisks for unordered list items. Change the dash to an asterisk to maintain consistency.

- - Fix wrong instruction in esbuild loader documentation [PR 504](https://github.com/shakacode/shakapacker/pull/504) by [adriangohjw](https://github.com/adriangohjw)
+ * Fix wrong instruction in esbuild loader documentation [PR 504](https://github.com/shakacode/shakapacker/pull/504) by [adriangohjw](https://github.com/adriangohjw)

Tools

Markdownlint

15-15: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e97561f and e235fb2.

Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• docs/using_esbuild_loader.md (1 hunks)

Files skipped from review due to trivial changes (1)

• docs/using_esbuild_loader.md

Additional context used

Markdownlint

CHANGELOG.md

15-15: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

[justin808]

@Judahmeek @adriangohjw loader key should not have changed.

Did it?

[adriangohjw]

@Judahmeek @adriangohjw loader key should not have changed.

Did it?

I think it might have been updated incorrectly in the previous changes. It's inconsistent with the swc loader README too

[justin808]

@adriangohjw maybe changing back that key is the right thing! asap!

[tomdracz]

Looks like just the docs are incorrect. It was always webpack_loader as the option key as far as I can see