-
Notifications
You must be signed in to change notification settings - Fork 37
Make esbuild to default for angular #47
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
base: v11
Are you sure you want to change the base?
Conversation
WalkthroughThe README.md file was updated to correct the git clone command, changing the repository and target directory names to accurately reflect the Angular starter project. No other instructions or content were modified. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
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.
| {% tab title="Angular" %} | ||
| ```bash | ||
| git clone https://github.com/keycloakify/keycloakify-starter-angular-vite keycloakify-starter | ||
| git clone https://github.com/keycloakify/keycloakify-starter-angular keycloakify-starter-angular-vite | ||
| ``` | ||
|
|
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.
💡 Verification agent
🧩 Analysis chain
cd instructions now point to a non-existent directory
The updated clone command checks out into keycloakify-starter-angular-vite, but the global “Quick Start” section still instructs users to
cd keycloakify-starter (line 86). Following the docs verbatim will therefore fail for Angular users.
Please update the subsequent path (and any other hard-coded references) or add Angular-specific instructions inside the tab.
Additionally, footnote [^3] (line 157) still claims that Esbuild is not currently supported—the opposite of this PR’s objective. Make sure the footnote reflects the new default.
🏁 Script executed:
#!/bin/bash
# Display the top of README.md to inspect Quick Start instructions and Angular tab section
sed -n '1,200p' README.md | nl
# Locate occurrences of the Angular clone target directory
rg -n 'keycloakify-starter-angular-vite' README.md
# Locate any 'cd keycloakify-starter' instructions
rg -n 'cd keycloakify-starter' README.md
# Locate footnote [^3] and its content
rg -n '\[\^3\]' -n README.md
sed -n '150,180p' README.md | nlLength of output: 956
Fix incorrect directory reference and update Esbuild support footnote
The Angular tab’s clone target (keycloakify-starter-angular-vite) doesn’t match the subsequent cd keycloakify-starter instruction (line 86). Following the docs verbatim will fail for Angular users. Also, footnote [^3] (line 157) still states that Esbuild “is not currently supported,” which contradicts this PR’s addition of Esbuild support.
Please address both issues:
• Under the Angular tab (around line 68–86):
- Replace or augment the
cd keycloakify-starterstep with:cd keycloakify-starter-angular-vite - Ensure any other hard-coded paths in that section are Angular-specific.
• Update footnote [^3] (line 157) to reflect that Esbuild support is now available by default (or remove the outdated remark).
🤖 Prompt for AI Agents
In README.md around lines 66 to 86, fix the directory inconsistency by changing
the `cd keycloakify-starter` command to `cd keycloakify-starter-angular-vite`
under the Angular tab to match the clone target. Also, review and update any
other hard-coded paths in this section to be Angular-specific. Additionally, at
line 157, update footnote [^3] to remove or revise the outdated statement that
Esbuild is not supported, reflecting that Esbuild support is now available by
default.
Summary by CodeRabbit