Commit 0f6bdcc
Add Shakapacker precompile hook with ReScript support to Pro dummy app (#1977)
## Summary
Adds a Shakapacker precompile hook to the Pro dummy app to support
automatic ReScript builds and React on Rails pack generation before
webpack compilation.
## Changes
### 1. Added Precompile Hook Script (`bin/shakapacker-precompile-hook`)
- Cross-platform Ruby script that runs before Shakapacker compilation
- **ReScript build support**: Detects both `bsconfig.json` (legacy) and
`rescript.json` config files
- **Automatic pack generation**: Runs `react_on_rails:generate_packs`
when `auto_load_bundle` or `components_subdirectory` are configured
- **Rails root resolution**: Properly finds Rails root directory and
runs commands from correct location
- **Error handling**: Graceful warnings and proper exit codes
- **Package manager detection**: Supports both yarn and npm
### 2. Configured Shakapacker (`config/shakapacker.yml`)
- Added `precompile_hook: 'bin/shakapacker-precompile-hook'` setting
- Includes security comment about trusted script paths
## Technical Details
### ReScript Build Logic
- Resolves Rails root directory early
- Uses `File.join(rails_root, ...)` for proper path resolution
- Executes build commands from Rails root using `Dir.chdir(rails_root)`
- Ensures yarn/npm can find the correct `package.json`
- Aborts gracefully if Rails root cannot be found
### Pack Generation Logic
- Checks for React on Rails initializer existence
- Parses config for `auto_load_bundle` or `components_subdirectory`
settings (ignores comments)
- Only runs if `react_on_rails:generate_packs` rake task exists
- Uses array form for system calls to prevent shell injection
## Why This Matters
The precompile hook ensures that:
1. ReScript code is compiled before webpack attempts to bundle it
2. Generated component packs are created before compilation in
production
3. Developer experience is seamless - no manual build steps required
4. Works consistently across development and production environments
## Test Plan
- [x] RuboCop passes with zero offenses
- [x] Pre-commit hooks pass
- [ ] Verify hook runs during `bin/shakapacker` compilation
- [ ] Confirm ReScript builds when config files present
- [ ] Check pack generation when auto_load_bundle configured
- [ ] Test production asset precompilation workflow
## Related
- Follows pattern from open-source dummy app
- Aligns with Shakapacker 9.x precompile hook feature
- See:
https://github.com/shakacode/shakapacker/blob/main/docs/precompile_hook.md
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- Reviewable:start -->
- - -
This change is [<img src="https://reviewable.io/review_button.svg"
height="34" align="absmiddle"
alt="Reviewable"/>](https://reviewable.io/reviews/shakacode/react_on_rails/1977)
<!-- Reviewable:end -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Adds a configurable precompile hook to run before webpack compilation.
* Conditional ReScript compilation is detected and built automatically
when present.
* React on Rails pack generation now auto-detects configuration and runs
when needed; improved yarn/npm compatibility.
* **Chores**
* Template hook updated to a streamlined, shell-based implementation and
dummy app now delegates to a shared precompile hook.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude <[email protected]>1 parent d3ddb49 commit 0f6bdcc
File tree
4 files changed
+155
-94
lines changed- react_on_rails_pro/spec/dummy
- bin
- config
- spec
- dummy/bin
- support
4 files changed
+155
-94
lines changedLines changed: 19 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
22 | 27 | | |
23 | 28 | | |
24 | 29 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
5 | | - | |
6 | | - | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
7 | 8 | | |
8 | | - | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
9 | 12 | | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | | - | |
94 | | - | |
95 | | - | |
96 | | - | |
97 | | - | |
98 | | - | |
99 | | - | |
| 13 | + | |
| 14 | + | |
100 | 15 | | |
101 | 16 | | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
0 commit comments