Phase 3: Prepare core package for workspace structure #1830
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ tmp/ | |
|
|
||
| node_modules | ||
|
|
||
| /packages/*/lib | ||
|
|
||
| yarn-debug.* | ||
| yarn-error.* | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -71,7 +71,7 @@ Changes since the last non-beta release. | |||||
|
|
||||||
| #### Pro License Features | ||||||
|
|
||||||
| - **Core/Pro separation**: Moved Pro features into dedicated `lib/react_on_rails/pro/` and `node_package/src/pro/` directories with clear licensing boundaries (now located at `packages/react-on-rails/src/pro/`) [PR 1791](https://github.com/shakacode/react_on_rails/pull/1791) by [AbanoubGhadban](https://github.com/AbanoubGhadban) | ||||||
| - **Runtime license validation**: Implemented Pro license gating with graceful fallback to core functionality when Pro license unavailable [PR 1791](https://github.com/shakacode/react_on_rails/pull/1791) by [AbanoubGhadban](https://github.com/AbanoubGhadban) | ||||||
| - **Enhanced immediate hydration**: Improved immediate hydration functionality with Pro license validation and warning badges [PR 1791](https://github.com/shakacode/react_on_rails/pull/1791) by [AbanoubGhadban](https://github.com/AbanoubGhadban) | ||||||
| - **License documentation**: Added NOTICE files in Pro directories referencing canonical `REACT-ON-RAILS-PRO-LICENSE.md` [PR 1791](https://github.com/shakacode/react_on_rails/pull/1791) by [AbanoubGhadban](https://github.com/AbanoubGhadban) | ||||||
|
|
@@ -400,6 +400,8 @@ _Major bump because dropping support for Ruby 2.7 and deprecated `webpackConfigL | |||||
| @ ./client/app/packs/client-bundle.js 5:0-42 32:0-23 35:0-21 59:0-26 | ||||||
| ``` | ||||||
|
|
||||||
| _Note: The `node_package/lib/` path in these error examples is now `packages/react-on-rails/lib/` in the current structure._ | ||||||
|
|
||||||
|
Comment on lines
+403
to
+404
There was a problem hiding this comment. Path note contradicts Phase 3 objective; keep output at node_package/lib The note says errors now point to packages/react-on-rails/lib/, but Phase 3 preserves build output at node_package/lib/ for backward compatibility. Update the note accordingly to avoid confusing users and tools relying on that path. - _Note: The `node_package/lib/` path in these error examples is now `packages/react-on-rails/lib/` in the current structure._
+ _Note: The build output path remains `node_package/lib/` for backward compatibility in this phase._Based on learnings. 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
| It can be safely [suppressed](https://webpack.js.org/configuration/other-options/#ignorewarnings) in your Webpack configuration. | ||||||
|
|
||||||
| ### [13.0.2] - 2022-03-09 | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,7 +36,7 @@ Git hooks will automatically run linting on **all changed files (staged + unstag | |
| - **Code Formatting**: | ||
| - Format code with Prettier: `rake autofix` | ||
| - Check formatting without fixing: `yarn start format.listDifferent` | ||
| - **Build**: `yarn run build` (compiles TypeScript to JavaScript in packages/react-on-rails/lib) | ||
| - **Type checking**: `yarn run type-check` | ||
| - **⚠️ MANDATORY BEFORE GIT PUSH**: `bundle exec rubocop` and fix ALL violations + ensure trailing newlines | ||
| - Never run `npm` commands, only equivalent Yarn Classic ones | ||
|
|
@@ -86,7 +86,7 @@ Git hooks will automatically run linting on **all changed files (staged + unstag | |
| This project maintains both a Ruby gem and an NPM package: | ||
|
|
||
| - **Ruby gem**: Located in `lib/`, provides Rails integration and server-side rendering | ||
| - **NPM package**: Located in `packages/react-on-rails/src/`, provides client-side React integration | ||
|
|
||
| ### Core Components | ||
|
|
||
|
|
@@ -98,7 +98,7 @@ This project maintains both a Ruby gem and an NPM package: | |
| - **`engine.rb`**: Rails engine integration | ||
| - **Generators**: Located in `lib/generators/react_on_rails/` | ||
|
|
||
| #### JavaScript/TypeScript Side (`packages/react-on-rails/src/`) | ||
|
|
||
| - **`ReactOnRails.ts`**: Main entry point for client-side functionality | ||
| - **`serverRenderReactComponent.ts`**: Server-side rendering logic | ||
|
|
@@ -108,7 +108,7 @@ This project maintains both a Ruby gem and an NPM package: | |
| ### Build System | ||
|
|
||
| - **Ruby**: Standard gemspec-based build | ||
| - **JavaScript**: TypeScript compilation to `packages/react-on-rails/lib/` | ||
| - **Testing**: Jest for JS, RSpec for Ruby | ||
| - **Linting**: ESLint for JS/TS, RuboCop for Ruby | ||
|
|
||
|
|
@@ -130,6 +130,6 @@ This project maintains both a Ruby gem and an NPM package: | |
|
|
||
| Exclude these directories to prevent IDE slowdowns: | ||
|
|
||
| - `/coverage`, `/tmp`, `/gen-examples`, `/packages/react-on-rails/lib` | ||
| - `/node_modules`, `/spec/dummy/node_modules`, `/spec/dummy/tmp` | ||
| - `/spec/dummy/app/assets/webpack`, `/spec/dummy/log` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -287,7 +287,7 @@ Use `gh pr create` with: | |
| When analyzing codebases, ignore these directories to avoid confusion: | ||
|
|
||
| - `/coverage`, `/tmp`, `/gen-examples` | ||
| - `/packages/react-on-rails/lib`, `/node_modules` | ||
| - `/spec/dummy/app/assets/webpack` | ||
| - `/spec/dummy/log`, `/spec/dummy/node_modules`, `/spec/dummy/tmp` | ||
| - `/spec/react_on_rails/dummy-for-generators` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,7 +40,7 @@ It's critical to configure your IDE/editor to ignore certain directories. Otherw | |
| - /coverage | ||
| - /tmp | ||
| - /gen-examples | ||
| - /packages/react-on-rails/lib | ||
| - /node_modules | ||
|
Comment on lines
40
to
44
There was a problem hiding this comment. Restore The TypeScript build still writes compiled output to 🤖 Prompt for AI Agents |
||
| - /spec/dummy/app/assets/webpack | ||
| - /spec/dummy/log | ||
|
|
@@ -121,7 +121,7 @@ Don't forget you may need to run yarn after adding packages with yalc to install | |
|
|
||
| #### Example: Testing NPM changes with the dummy app | ||
|
|
||
| 1. Add `console.log('Hello!')` to [clientStartup.ts, function render](https://github.com/shakacode/react_on_rails/blob/master/packages/react-on-rails/src/clientStartup.ts in `/packages/react-on-rails/src/clientStartup.js` to confirm we're getting an update to the node package client side. Do the same for function `serverRenderReactComponent` in `/packages/react-on-rails/src/serverRenderReactComponent.ts`. | ||
AbanoubGhadban marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 2. Refresh the browser if the server is already running or start the server using `foreman start` from `react_on_rails/spec/dummy` and navigate to `http://localhost:5000/`. You will now see the `Hello!` message printed in the browser's console. If you did not see that message, then review the steps above for the workflow of making changes and pushing them via yalc. | ||
|
|
||
| # Development Setup for Gem and Node Package Contributors | ||
|
|
@@ -134,7 +134,7 @@ After checking out the repo, making sure you have Ruby and Node version managers | |
|
|
||
| ### Local Node Package | ||
|
|
||
| Note, the example and dummy apps will use your local `packages/react-on-rails` folder as the `react-on-rails` node package. This will also be done automatically for you via the `rake examples:gen_all` rake task. | ||
|
|
||
| _Side note: It's critical to use the alias section of the Webpack config to avoid a double inclusion error. This has already been done for you in the example and dummy apps, but for reference:_ | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,17 +12,17 @@ This repository contains code under two different licenses: | |
| The following directories and all their contents are licensed under the **MIT License** (see full text below): | ||
|
|
||
| - `lib/react_on_rails/` (excluding `lib/react_on_rails/pro/`) | ||
| - `packages/react-on-rails/` (excluding `packages/react-on-rails/src/pro/`) | ||
| - `packages/react-on-rails/lib/` (excluding `packages/react-on-rails/lib/pro/`) | ||
| - All other directories in this repository not explicitly listed as Pro-licensed | ||
|
|
||
| ### Pro Licensed Code | ||
|
|
||
| The following directories and all their contents are licensed under the **React on Rails Pro License**: | ||
|
|
||
| - `lib/react_on_rails/pro/` | ||
| - `packages/react-on-rails/src/pro/` | ||
| - `packages/react-on-rails/lib/pro/` | ||
| - `react_on_rails_pro/` (entire directory) | ||
|
|
||
| See [REACT-ON-RAILS-PRO-LICENSE.md](./REACT-ON-RAILS-PRO-LICENSE.md) for complete Pro license terms. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,15 +11,15 @@ All directories in the `react_on_rails` repository are MIT licensed: | |
| ``` | ||
| react_on_rails/ | ||
| ├── lib/react_on_rails/ # Core Ruby code (MIT) | ||
| ├── packages/react-on-rails/src/ # Core JS/TS code (MIT) | ||
| │ └── pro/ # Pro features with license validation (Pro licensed) | ||
| ├── spec/ # Core tests (MIT) | ||
AbanoubGhadban marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ├── docs/ # Documentation (MIT) | ||
| ├── .github/ # GitHub workflows (MIT) | ||
| └── [all other directories] # MIT | ||
| ``` | ||
|
|
||
| **Exception:** The `packages/react-on-rails/src/pro/` directory contains Pro implementation code licensed under the React on Rails Pro License. This code is included in the package but requires a valid Pro license to use. | ||
|
|
||
| **Important Distinction:** | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -70,19 +70,18 @@ react_on_rails_pro/ | |
| react_on_rails/ (monorepo root) | ||
| ├── lib/ | ||
| │ ├── react_on_rails/ # Core Ruby (MIT) | ||
| │ │ └── spec/ # Core Ruby specs | ||
| │ └── react_on_rails_pro/ # Pro Ruby (Pro license) | ||
| │ └── spec/ # Pro Ruby specs | ||
| ├── packages/ # NPM packages (yarn workspace) | ||
| │ ├── react-on-rails/ # Core JS/TS (MIT) | ||
| │ │ └── tests/ # Core JS/TS tests | ||
| │ ├── react-on-rails-pro/ # Pro JS/TS (Pro license) | ||
| │ │ └── tests/ # Pro JS/TS tests | ||
| │ └── react-on-rails-pro-node-renderer/ # Pro node renderer | ||
| │ └── tests/ # Pro node renderer tests | ||
| ├── spec/ # Monorepo-level integration tests | ||
| │ └── dummy/ # Rails dummy app for testing | ||
| ├── tools/ # Shared development tools | ||
| ├── docs/ # Unified documentation | ||
| ├── react_on_rails.gemspec # Core gem | ||
|
|
@@ -306,6 +305,7 @@ After the initial merge, the following CI adjustments may be needed: | |
| - [ ] Update root `package.json` to workspace manager (packages/react-on-rails only) | ||
| - [ ] Update build scripts and import paths | ||
| - [ ] Update TypeScript configurations | ||
| - [ ] Move core JS tests to `packages/react-on-rails/tests/` | ||
| - [ ] Keep `react_on_rails_pro/` directory unchanged | ||
| - [ ] Update CI to build via workspace | ||
| - [ ] Update LICENSE.md to include new package path | ||
|
|
@@ -359,7 +359,7 @@ After the initial merge, the following CI adjustments may be needed: | |
| - [ ] Update root workspace to include all 3 NPM packages | ||
| - [ ] Update CI to test all packages | ||
| - [ ] Setup proper dependencies between packages | ||
| - [ ] Move pro JS tests to package directories (`packages/react-on-rails-pro/tests/`, `packages/react-on-rails-pro-node-renderer/tests/`) | ||
|
|
||
| **License Compliance:** | ||
|
|
||
|
|
@@ -368,14 +368,14 @@ After the initial merge, the following CI adjustments may be needed: | |
| ```md | ||
| ## MIT License applies to: | ||
|
|
||
| - `lib/react_on_rails/` (including specs) | ||
| - `packages/react-on-rails/` (including tests) | ||
|
|
||
| ## React on Rails Pro License applies to: | ||
|
|
||
| - `lib/react_on_rails_pro/` (including specs) | ||
| - `packages/react-on-rails-pro/` (including tests) (NEW) | ||
| - `packages/react-on-rails-pro-node-renderer/` (including tests) (NEW) | ||
| - `react_on_rails_pro/` (remaining files) | ||
| ``` | ||
|
|
||
|
|
@@ -414,13 +414,10 @@ After the initial merge, the following CI adjustments may be needed: | |
|
|
||
| - [ ] Move `react_on_rails_pro/lib/react_on_rails_pro/` to `lib/react_on_rails_pro/` | ||
| - [ ] Move `react_on_rails_pro/react_on_rails_pro.gemspec` to root as `react_on_rails_pro.gemspec` | ||
| - [ ] Move Ruby specs to gem directories: | ||
| - Core specs: `lib/react_on_rails/spec/` (or keep existing `spec/` location) | ||
| - Pro specs: `lib/react_on_rails_pro/spec/` | ||
| - [ ] JS tests remain in package directories (already handled in previous phases) | ||
| - [ ] Update root `Gemfile` to include both gemspecs | ||
|
Comment on lines
+468
to
472
There was a problem hiding this comment. 🛠️ Refactor suggestion | 🟠 Major 🧩 Analysis chainResolve indecision on Ruby spec location. “lib/.../spec (or keep existing spec location)” is ambiguous. Choose one and use it consistently across this doc and CI. Given your “Development Workflow” uses -- [ ] Move Ruby specs to gem directories:
- - Core specs: `lib/react_on_rails/spec/` (or keep existing `spec/` location)
- - Pro specs: `lib/react_on_rails_pro/spec/`
+- [ ] Move Ruby specs to root spec directories (preferred):
+ - Core specs: `spec/ruby/react_on_rails/`
+ - Pro specs: `spec/ruby/react_on_rails_pro/`🏁 Script executed: #!/bin/bash
# Ensure rspec config/globs match the chosen path
fd -a .rspec rspec*.rb spec_helper*.rb | xargs rg -n .Length of output: 291067 🏁 Script executed: #!/bin/bash
set -uo pipefail
echo "=== git ls-files matching spec paths ==="
git ls-files | rg -n --line-number '^spec/|/spec/' || echo "(no tracked paths under 'spec/')"
echo
echo "=== tracked files: spec_helper.rb, rails_helper.rb, .rspec ==="
git ls-files | rg -n '(^|/)(spec_helper|rails_helper)\.rb$|(^|/)\.rspec$' || echo "(none of those files tracked)"
echo
echo "=== find 'spec' directories (fd fallback to find) ==="
if command -v fd >/dev/null 2>&1; then
fd -H -t d --hidden '^spec$' || true
else
find . -type d -name spec -print || true
fi
echo
echo "=== occurrences of 'bundle exec rspec' and 'rspec' in repo ==="
rg -n -S --hidden --glob '!node_modules/**' 'bundle exec rspec' || echo "(no 'bundle exec rspec' matches)"
rg -n -S --hidden --glob '!node_modules/**' '\brspec\b' || echo "(no 'rspec' token matches)"
echo
echo "=== search .github/workflows for rspec ==="
rg -n -S --hidden --glob '!node_modules/**' '\brspec\b' .github || echo "(no rspec in .github/workflows or .github not present)"
echo
echo "=== root Gemfile (first 200 lines) ==="
if [ -f Gemfile ]; then
sed -n '1,200p' Gemfile
else
echo "(no Gemfile at repo root)"
fi
echo
echo "=== docs references to spec location ==="
rg -n -S --hidden --glob '!node_modules/**' 'Move Ruby specs|spec/ruby|lib/.*/spec' docs || echo "(no matching mentions in docs)"Length of output: 58534 Unify Ruby spec location — prefer root-level specs Replace the ambiguous "lib/.../spec (or keep existing 🤖 Prompt for AI Agents |
||
| - [ ] Remove empty `react_on_rails_pro/` directory | ||
| - [ ] Update all require paths in Ruby code | ||
|
|
@@ -433,19 +430,14 @@ After the initial merge, the following CI adjustments may be needed: | |
| ```md | ||
| ## MIT License applies to: | ||
|
|
||
| - `lib/react_on_rails/` (including specs) | ||
| - `packages/react-on-rails/` (including tests) | ||
|
|
||
| ## React on Rails Pro License applies to: | ||
|
|
||
| - `lib/react_on_rails_pro/` (including specs) | ||
| - `packages/react-on-rails-pro/` (including tests) | ||
| - `packages/react-on-rails-pro-node-renderer/` (including tests) | ||
| ``` | ||
|
|
||
| - [ ] Update both gemspec files with correct license: | ||
|
|
@@ -579,14 +571,14 @@ After the initial merge, the following CI adjustments may be needed: | |
|
|
||
| - `react_on_rails` Ruby gem | ||
| - `react-on-rails` NPM package | ||
| - Core functionality in `lib/react_on_rails/` and `packages/react-on-rails/` (including tests/specs) | ||
|
|
||
| ### Pro Licensed (Subscription Required for Production): | ||
|
|
||
| - `react_on_rails_pro` Ruby gem | ||
| - `react-on-rails-pro` NPM package | ||
| - `react-on-rails-pro-node-renderer` NPM package | ||
| - Pro functionality in `lib/react_on_rails_pro/` and `packages/react-on-rails-pro*/` (including tests/specs) | ||
|
|
||
| See [LICENSE.md](LICENSE.md) and [REACT-ON-RAILS-PRO-LICENSE.md](REACT-ON-RAILS-PRO-LICENSE.md) | ||
| ``` | ||
|
|
@@ -615,7 +607,7 @@ After the initial merge, the following CI adjustments may be needed: | |
|
|
||
| 1. **Directory Classification:** | ||
|
|
||
| - **MIT Licensed:** `lib/react_on_rails/` (including specs), `packages/react-on-rails/` (including tests) | ||
| - **Pro Licensed:** All directories explicitly listed in LICENSE.md under "React on Rails Pro License" | ||
|
|
||
| 2. **LICENSE.md Updates:** | ||
|
|
@@ -643,16 +635,11 @@ PRO_DIRECTORIES = %w[ | |
| lib/react_on_rails_pro | ||
| packages/react-on-rails-pro | ||
| packages/react-on-rails-pro-node-renderer | ||
| ].freeze | ||
|
|
||
| MIT_DIRECTORIES = %w[ | ||
| lib/react_on_rails | ||
| packages/react-on-rails | ||
| ].freeze | ||
|
|
||
| def check_pro_license_headers | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,7 +13,7 @@ The only requirements within this directory for basic React on Rails integration | |
| 1. Your Webpack configuration files: | ||
| 1. Create outputs in a directory like `/public/webpack`, which is customizable in your `config/initializers/react_on_rails.rb`. | ||
| 1. Provide server rendering if you wish to use that feature. | ||
| 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](../api/javascript-api.md) and the [React on Rails source](https://github.com/shakacode/react_on_rails/tree/master/packages/react-on-rails/src/ReactOnRails.client.ts). | ||
| 1. Set your registration file as an "entry" point in your Webpack configs. | ||
| 1. Configure scripts in `client/package.json` as shown in the example apps. These are used for building your Webpack assets. Also do this for your top-level `package.json`. | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Build before yalc publish to ensure lib exists
The workflow publishes via yalc without building first. Insert a build step before publishing.
📝 Committable suggestion
🤖 Prompt for AI Agents