Improve naming clarity in pageLifecycle.ts (#1762)

* Improve naming clarity in pageLifecycle.ts

The main improvements:
- Rename setupTurbolinksEventListeners() to setupPageNavigationListeners()
  to better reflect that it handles multiple navigation libraries, not just Turbolinks
- Rename isEventListenerInitialized to isPageLifecycleInitialized for clarity
- Extract hasNavigationLibrary variable to make the conditional logic clearer
- Update debug messages to be more descriptive ("DETECTED" vs "USING")
- Emphasize that the normal use case is NO navigation library

These changes make the code more self-documenting and easier to understand,
especially given that most users don't use Turbolinks at all.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

* Fix prettier formatting in CLAUDE.md

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

---------

Co-authored-by: Claude <[email protected]>

Author: justin808

CLAUDE.md

@@ -5,8 +5,9 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 ## Development Commands
 
 ### Essential Commands
+
 - **Install dependencies**: `bundle && yarn`
-- **Run tests**: 
+- **Run tests**:
   - Ruby tests: `rake run_rspec`
   - JavaScript tests: `yarn run test` or `rake js_tests`
   - All tests: `rake` (default task runs lint and all tests except examples)
@@ -18,58 +19,69 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 - **Type checking**: `yarn run type-check`
 
 ### Development Setup Commands
+
 - **Initial setup**: `bundle && yarn && rake shakapacker_examples:gen_all && rake node_package && rake`
 - **Prepare examples**: `rake shakapacker_examples:gen_all`
 - **Generate node package**: `rake node_package`
 - **Run single test example**: `rake run_rspec:example_basic`
 
 ### Test Environment Commands
+
 - **Dummy app tests**: `rake run_rspec:dummy`
 - **Gem-only tests**: `rake run_rspec:gem`
 - **All tests except examples**: `rake all_but_examples`
 
 ## Project Architecture
 
 ### Dual Package Structure
+
 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 `node_package/src/`, provides client-side React integration
 
 ### Core Components
 
 #### Ruby Side (`lib/react_on_rails/`)
+
 - **`helper.rb`**: Rails view helpers for rendering React components
 - **`server_rendering_pool.rb`**: Manages Node.js processes for server-side rendering
 - **`configuration.rb`**: Global configuration management
 - **`engine.rb`**: Rails engine integration
 - **Generators**: Located in `lib/generators/react_on_rails/`
 
 #### JavaScript/TypeScript Side (`node_package/src/`)
+
 - **`ReactOnRails.ts`**: Main entry point for client-side functionality
 - **`serverRenderReactComponent.ts`**: Server-side rendering logic
 - **`ComponentRegistry.ts`**: Manages React component registration
 - **`StoreRegistry.ts`**: Manages Redux store registration
 
 ### Build System
+
 - **Ruby**: Standard gemspec-based build
 - **JavaScript**: TypeScript compilation to `node_package/lib/`
 - **Testing**: Jest for JS, RSpec for Ruby
 - **Linting**: ESLint for JS/TS, RuboCop for Ruby
 
 ### Examples and Testing
+
 - **Dummy app**: `spec/dummy/` - Rails app for testing integration
 - **Examples**: Generated via rake tasks for different webpack configurations
 - **Rake tasks**: Defined in `rakelib/` for various development operations
 
 ## Important Notes
+
 - Use `yalc` for local development when testing with external apps
 - The project supports both Webpacker and Shakapacker
 - Server-side rendering uses isolated Node.js processes
 - React Server Components support available in Pro version
 - Generated examples are in `gen-examples/` (ignored by git)
 
 ## IDE Configuration
+
 Exclude these directories to prevent IDE slowdowns:
+
 - `/coverage`, `/tmp`, `/gen-examples`, `/node_package/lib`
 - `/node_modules`, `/spec/dummy/node_modules`, `/spec/dummy/tmp`
-- `/spec/dummy/app/assets/webpack`, `/spec/dummy/log`
+- `/spec/dummy/app/assets/webpack`, `/spec/dummy/log`

node_package/src/pageLifecycle.ts

@@ -28,48 +28,49 @@ function runPageUnloadedCallbacks(): void {
   });
 }
 
-function setupTurbolinksEventListeners(): void {
+function setupPageNavigationListeners(): void {
   // Install listeners when running on the client (browser).
-  // We must do this check for turbolinks AFTER the document is loaded because we load the
+  // We must check for navigation libraries AFTER the document is loaded because we load the
   // Webpack bundles first.
-  if ((!turbolinksInstalled() || !turbolinksSupported()) && !turboInstalled()) {
-    debugTurbolinks('NOT USING TURBOLINKS: calling reactOnRailsPageLoaded');
+  const hasNavigationLibrary = (turbolinksInstalled() && turbolinksSupported()) || turboInstalled();
+  if (!hasNavigationLibrary) {
+    debugTurbolinks('NO NAVIGATION LIBRARY: running page loaded callbacks immediately');
     runPageLoadedCallbacks();
     return;
   }
 
   if (turboInstalled()) {
-    debugTurbolinks('USING TURBO: document added event listeners turbo:before-render and turbo:render.');
+    debugTurbolinks('TURBO DETECTED: adding event listeners for turbo:before-render and turbo:render.');
     document.addEventListener('turbo:before-render', runPageUnloadedCallbacks);
     document.addEventListener('turbo:render', runPageLoadedCallbacks);
     runPageLoadedCallbacks();
   } else if (turbolinksVersion5()) {
     debugTurbolinks(
-      'USING TURBOLINKS 5: document added event listeners turbolinks:before-render and turbolinks:render.',
+      'TURBOLINKS 5 DETECTED: adding event listeners for turbolinks:before-render and turbolinks:render.',
     );
     document.addEventListener('turbolinks:before-render', runPageUnloadedCallbacks);
     document.addEventListener('turbolinks:render', runPageLoadedCallbacks);
     runPageLoadedCallbacks();
   } else {
-    debugTurbolinks('USING TURBOLINKS 2: document added event listeners page:before-unload and page:change.');
+    debugTurbolinks('TURBOLINKS 2 DETECTED: adding event listeners for page:before-unload and page:change.');
     document.addEventListener('page:before-unload', runPageUnloadedCallbacks);
     document.addEventListener('page:change', runPageLoadedCallbacks);
   }
 }
 
-let isEventListenerInitialized = false;
+let isPageLifecycleInitialized = false;
 function initializePageEventListeners(): void {
   if (typeof window === 'undefined') return;
 
-  if (isEventListenerInitialized) {
+  if (isPageLifecycleInitialized) {
     return;
   }
-  isEventListenerInitialized = true;
+  isPageLifecycleInitialized = true;
 
   if (document.readyState === 'complete') {
-    setupTurbolinksEventListeners();
+    setupPageNavigationListeners();
   } else {
-    document.addEventListener('DOMContentLoaded', setupTurbolinksEventListeners);
+    document.addEventListener('DOMContentLoaded', setupPageNavigationListeners);
   }
 }