Phase 3: Prepare core package for workspace structure

.circleci/config.yml

@@ -84,13 +84,13 @@ aliases:
   - &restore-package-node-modules-cache
     name: Restore cached node_modules directory (Pro)
     keys:
-      - v4-pro-package-node-modules-cache-{{ checksum "react_on_rails_pro/yarn.lock" }}
+      - v4-pro-package-node-modules-cache-{{ checksum "react_on_rails_pro/yarn.lock" }}-{{ checksum "yarn.lock" }}
 
   # Restore spec/dummy/node_modules dir from cache using yarn.lock checksum as a key.
   - &restore-dummy-app-node-modules-cache
     name: Restore cached spec/dummy/node_modules directory (Pro)
     keys:
-      - v4-pro-dummy-app-node-modules-cache-{{ checksum "react_on_rails_pro/spec/dummy/yarn.lock" }}
+      - v4-pro-dummy-app-node-modules-cache-{{ checksum "react_on_rails_pro/spec/dummy/yarn.lock" }}-{{ checksum "yarn.lock" }}
 
   # Restore vendor/bundle dir from cache using Gemfile.lock checksum as a key.
   - &restore-dummy-app-gem-cache

.github/workflows/lint-js-and-ruby.yml

@@ -45,7 +45,7 @@ jobs:
           yarn install --no-progress --no-emoji --frozen-lockfile
           sudo yarn global add yalc
       - name: yalc publish for react-on-rails
-        run: yalc publish
+        run: cd packages/react-on-rails && yalc publish
       - name: yalc add react-on-rails
         run: cd spec/dummy && yalc add react-on-rails
       - name: Install Node modules with Yarn for dummy app
@@ -81,12 +81,12 @@ jobs:
       - name: Type-check TypeScript
         run: yarn run type-check
       - name: Pack for attw and publint
-        run: yarn pack -f react-on-rails.tgz
+        run: cd packages/react-on-rails && yarn pack -f react-on-rails.tgz
       - name: Lint package types
         # our package is ESM-only
-        run: yarn run attw react-on-rails.tgz --profile esm-only
+        run: yarn run attw packages/react-on-rails/react-on-rails.tgz --profile esm-only
       - name: Lint package publishing
-        run: yarn run publint --strict react-on-rails.tgz
+        run: yarn run publint --strict packages/react-on-rails/react-on-rails.tgz
       # We only download and run Actionlint if there is any difference in GitHub Action workflows
       # https://github.com/rhysd/actionlint/blob/main/docs/usage.md#on-github-actions
       - name: Check GitHub Action changes

.github/workflows/main.yml

@@ -61,7 +61,7 @@ jobs:
           yarn install --no-progress --no-emoji ${{ matrix.dependency-level == 'latest' && '--frozen-lockfile' || '' }}
           sudo yarn global add yalc
       - name: yalc publish for react-on-rails
-        run: yalc publish
+        run: cd packages/react-on-rails && yalc publish
       - name: yalc add react-on-rails
         run: cd spec/dummy && yalc add react-on-rails
       - name: Install Node modules with Yarn for dummy app
@@ -159,7 +159,7 @@ jobs:
           yarn install --no-progress --no-emoji ${{ matrix.dependency-level == 'latest' && '--frozen-lockfile' || '' }}
           sudo yarn global add yalc
       - name: yalc publish for react-on-rails
-        run: yalc publish
+        run: cd packages/react-on-rails && yalc publish
       - name: yalc add react-on-rails
         run: cd spec/dummy && yalc add react-on-rails
       - name: Install Node modules with Yarn for dummy app

.gitignore

@@ -21,6 +21,7 @@ tmp/
 node_modules
 
 /node_package/lib
+/packages/*/lib
 
 yarn-debug.*
 yarn-error.*

LICENSE.md

@@ -12,7 +12,7 @@ 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/`)
-- `node_package/src/` (excluding `node_package/src/pro/`)
+- `packages/react-on-rails/` (excluding `packages/react-on-rails/src/pro/`)
 - `node_package/lib/` (excluding `node_package/lib/pro/`)
 - All other directories in this repository not explicitly listed as Pro-licensed
 
@@ -21,7 +21,7 @@ The following directories and all their contents are licensed under the **MIT Li
 The following directories and all their contents are licensed under the **React on Rails Pro License**:
 
 - `lib/react_on_rails/pro/`
-- `node_package/src/pro/`
+- `packages/react-on-rails/src/pro/`
 - `node_package/lib/pro/`
 - `react_on_rails_pro/` (entire directory)
 

eslint.config.ts

@@ -150,6 +150,12 @@ const config = tsEslint.config([
       'import/extensions': ['error', 'ignorePackages'],
     },
   },
+  {
+    files: ['packages/react-on-rails/src/**/*'],
+    rules: {
+      'import/extensions': ['error', 'ignorePackages'],
+    },
+  },
   {
     files: ['lib/generators/react_on_rails/templates/**/*'],
     rules: {

knip.ts

@@ -5,36 +5,40 @@ const config: KnipConfig = {
   workspaces: {
     '.': {
       entry: [
-        'node_package/src/ReactOnRails.node.ts!',
-        'node_package/src/pro/ReactOnRailsRSC.ts!',
-        'node_package/src/pro/registerServerComponent/client.tsx!',
-        'node_package/src/pro/registerServerComponent/server.tsx!',
-        'node_package/src/pro/registerServerComponent/server.rsc.ts!',
-        'node_package/src/pro/wrapServerComponentRenderer/server.tsx!',
-        'node_package/src/pro/wrapServerComponentRenderer/server.rsc.tsx!',
-        'node_package/src/pro/RSCRoute.tsx!',
-        'node_package/src/pro/ServerComponentFetchError.ts!',
-        'node_package/src/pro/getReactServerComponent.server.ts!',
-        'node_package/src/pro/transformRSCNodeStream.ts!',
-        'node_package/src/loadJsonFile.ts!',
+        'packages/react-on-rails/src/ReactOnRails.node.ts!',
+        'packages/react-on-rails/src/pro/ReactOnRailsRSC.ts!',
+        'packages/react-on-rails/src/pro/registerServerComponent/client.tsx!',
+        'packages/react-on-rails/src/pro/registerServerComponent/server.tsx!',
+        'packages/react-on-rails/src/pro/registerServerComponent/server.rsc.ts!',
+        'packages/react-on-rails/src/pro/wrapServerComponentRenderer/server.tsx!',
+        'packages/react-on-rails/src/pro/wrapServerComponentRenderer/server.rsc.tsx!',
+        'packages/react-on-rails/src/pro/RSCRoute.tsx!',
+        'packages/react-on-rails/src/pro/ServerComponentFetchError.ts!',
+        'packages/react-on-rails/src/pro/getReactServerComponent.server.ts!',
+        'packages/react-on-rails/src/pro/transformRSCNodeStream.ts!',
+        'packages/react-on-rails/src/loadJsonFile.ts!',
         'eslint.config.ts',
       ],
       project: [
-        'node_package/src/**/*.[jt]s{x,}!',
+        'packages/react-on-rails/src/**/*.[jt]s{x,}!',
         'node_package/tests/**/*.[jt]s{x,}',
         '!react_on_rails_pro/**',
+        '!packages/react-on-rails/lib/**',
       ],
       babel: {
         config: ['node_package/babel.config.js'],
       },
       ignore: [
         'node_package/tests/emptyForTesting.js',
+        // Build output directories that should be ignored
+        'packages/react-on-rails/lib/**',
+        'node_package/lib/**',
         // Pro features exported for external consumption
-        'node_package/src/pro/streamServerRenderedReactComponent.ts:transformRenderStreamChunksToResultObject',
-        'node_package/src/pro/streamServerRenderedReactComponent.ts:streamServerRenderedComponent',
-        'node_package/src/pro/ServerComponentFetchError.ts:isServerComponentFetchError',
-        'node_package/src/pro/RSCRoute.tsx:RSCRouteProps',
-        'node_package/src/pro/streamServerRenderedReactComponent.ts:StreamingTrackers',
+        'packages/react-on-rails/src/pro/streamServerRenderedReactComponent.ts:transformRenderStreamChunksToResultObject',
+        'packages/react-on-rails/src/pro/streamServerRenderedReactComponent.ts:streamServerRenderedComponent',
+        'packages/react-on-rails/src/pro/ServerComponentFetchError.ts:isServerComponentFetchError',
+        'packages/react-on-rails/src/pro/RSCRoute.tsx:RSCRouteProps',
+        'packages/react-on-rails/src/pro/streamServerRenderedReactComponent.ts:StreamingTrackers',
         // Exclude entire pro directory - it has its own package.json with dependencies
         'react_on_rails_pro/**',
       ],

node_package/tests/Authenticity.test.js

@@ -1,4 +1,4 @@
-import ReactOnRails from '../src/ReactOnRails.client.ts';
+import ReactOnRails from '../../packages/react-on-rails/src/ReactOnRails.client.ts';
 
 const testToken = 'TEST_CSRF_TOKEN';
 

node_package/tests/ComponentRegistry.test.js

@@ -6,12 +6,12 @@
 import * as React from 'react';
 import * as createReactClass from 'create-react-class';
 
-import * as ComponentRegistry from '../src/pro/ComponentRegistry.ts';
+import * as ComponentRegistry from '../../packages/react-on-rails/src/pro/ComponentRegistry.ts';
 
 const onPageLoadedCallbacks = [];
 const onPageUnloadedCallbacks = [];
 
-jest.mock('../src/pageLifecycle.ts', () => ({
+jest.mock('../../packages/react-on-rails/src/pageLifecycle.ts', () => ({
   onPageLoaded: jest.fn((cb) => {
     onPageLoadedCallbacks.push(cb);
     cb();
@@ -22,7 +22,7 @@ jest.mock('../src/pageLifecycle.ts', () => ({
   }),
 }));
 
-jest.mock('../src/context.ts', () => ({
+jest.mock('../../packages/react-on-rails/src/context.ts', () => ({
   getRailsContext: () => ({ componentRegistryTimeout: 100 }),
 }));
 

node_package/tests/ReactOnRails.test.jsx

@@ -4,7 +4,7 @@
 import { createStore } from 'redux';
 import * as React from 'react';
 import * as createReactClass from 'create-react-class';
-import ReactOnRails from '../src/ReactOnRails.client.ts';
+import ReactOnRails from '../../packages/react-on-rails/src/ReactOnRails.client.ts';
 
 describe('ReactOnRails', () => {
   it('render returns a virtual DOM element for component', () => {

node_package/tests/StoreRegistry.test.js

@@ -1,6 +1,6 @@
 import { createStore } from 'redux';
 
-import * as StoreRegistry from '../src/pro/StoreRegistry.ts';
+import * as StoreRegistry from '../../packages/react-on-rails/src/pro/StoreRegistry.ts';
 
 function reducer() {
   return {};

node_package/tests/buildConsoleReplay.test.js

@@ -1,4 +1,4 @@
-import buildConsoleReplay, { consoleReplay } from '../src/buildConsoleReplay.ts';
+import buildConsoleReplay, { consoleReplay } from '../../packages/react-on-rails/src/buildConsoleReplay.ts';
 
 describe('consoleReplay', () => {
   it('does not throw an exception if no console.history object', () => {

node_package/tests/injectRSCPayload.test.ts

@@ -1,7 +1,7 @@
 import { Readable, PassThrough } from 'stream';
-import { RailsContextWithServerStreamingCapabilities } from '../src/types/index.ts';
-import injectRSCPayload from '../src/pro/injectRSCPayload.ts';
-import RSCRequestTracker from '../src/pro/RSCRequestTracker.ts';
+import { RailsContextWithServerStreamingCapabilities } from '../../packages/react-on-rails/src/types/index.ts';
+import injectRSCPayload from '../../packages/react-on-rails/src/pro/injectRSCPayload.ts';
+import RSCRequestTracker from '../../packages/react-on-rails/src/pro/RSCRequestTracker.ts';
 
 // Shared utilities
 const createMockStream = (chunks: (string | Buffer)[] | { [key: number]: string | string[] }) => {

node_package/tests/jest.setup.js

@@ -23,11 +23,11 @@ if (typeof window !== 'undefined') {
   // Node's fetch and polyfills like jest-fetch-mock return Node's Readable stream,
   // so we convert it to a web-standard ReadableStream for consistency
   // Note: Node's Readable stream exists in node 'stream' built-in module, can be imported as `import { Readable } from 'stream'`
-  jest.mock('../src/utils', () => ({
-    ...jest.requireActual('../src/utils'),
+  jest.mock('../../packages/react-on-rails/src/utils', () => ({
+    ...jest.requireActual('../../packages/react-on-rails/src/utils'),
     fetch: (...args) =>
       jest
-        .requireActual('../src/utils')
+        .requireActual('../../packages/react-on-rails/src/utils')
         .fetch(...args)
         .then((res) => {
           const originalBody = res.body;

node_package/tests/pageLifecycle.test.js

@@ -3,7 +3,7 @@
  */
 
 // Mock the turbolinksUtils module before importing pageLifecycle
-jest.mock('../src/turbolinksUtils.ts', () => ({
+jest.mock('../../packages/react-on-rails/src/turbolinksUtils.ts', () => ({
   debugTurbolinks: jest.fn(),
   turbolinksInstalled: jest.fn(() => false),
   turbolinksSupported: jest.fn(() => false),
@@ -29,7 +29,7 @@ describe('pageLifecycle', () => {
   // We use require here instead of a global import at the top because we need to dynamically reload the module in each test.
   // This allows us to reset the module state between tests using jest.resetModules(), ensuring test isolation and preventing state leakage.
   // eslint-disable-next-line global-require
-  const importPageLifecycle = () => require('../src/pageLifecycle.ts');
+  const importPageLifecycle = () => require('../../packages/react-on-rails/src/pageLifecycle.ts');
 
   // Helper function to create navigation library mock
   const createNavigationMock = (overrides = {}) => ({
@@ -109,15 +109,15 @@ describe('pageLifecycle', () => {
 
   describe('with Turbo navigation library', () => {
     beforeEach(() => {
-      jest.doMock('../src/turbolinksUtils.ts', () =>
+      jest.doMock('../../packages/react-on-rails/src/turbolinksUtils.ts', () =>
         createNavigationMock({
           turboInstalled: jest.fn(() => true),
         }),
       );
     });
 
     afterEach(() => {
-      jest.dontMock('../src/turbolinksUtils.ts');
+      jest.dontMock('../../packages/react-on-rails/src/turbolinksUtils.ts');
     });
 
     it('should set up Turbo event listeners when Turbo is installed', () => {
@@ -137,7 +137,7 @@ describe('pageLifecycle', () => {
 
   describe('with Turbolinks 5 navigation library', () => {
     beforeEach(() => {
-      jest.doMock('../src/turbolinksUtils.ts', () =>
+      jest.doMock('../../packages/react-on-rails/src/turbolinksUtils.ts', () =>
         createNavigationMock({
           turbolinksInstalled: jest.fn(() => true),
           turbolinksSupported: jest.fn(() => true),
@@ -147,7 +147,7 @@ describe('pageLifecycle', () => {
     });
 
     afterEach(() => {
-      jest.dontMock('../src/turbolinksUtils.ts');
+      jest.dontMock('../../packages/react-on-rails/src/turbolinksUtils.ts');
     });
 
     it('should set up Turbolinks 5 event listeners when Turbolinks 5 is installed', () => {
@@ -167,7 +167,7 @@ describe('pageLifecycle', () => {
 
   describe('with Turbolinks 2 navigation library', () => {
     beforeEach(() => {
-      jest.doMock('../src/turbolinksUtils.ts', () =>
+      jest.doMock('../../packages/react-on-rails/src/turbolinksUtils.ts', () =>
         createNavigationMock({
           turbolinksInstalled: jest.fn(() => true),
           turbolinksSupported: jest.fn(() => true),
@@ -176,7 +176,7 @@ describe('pageLifecycle', () => {
     });
 
     afterEach(() => {
-      jest.dontMock('../src/turbolinksUtils.ts');
+      jest.dontMock('../../packages/react-on-rails/src/turbolinksUtils.ts');
     });
 
     it('should set up Turbolinks 2 event listeners when Turbolinks 2 is installed', () => {

node_package/tests/registerServerComponent.client.test.jsx

@@ -10,9 +10,9 @@ import '@testing-library/jest-dom';
 import * as path from 'path';
 import * as fs from 'fs';
 import { createNodeReadableStream, getNodeVersion } from './testUtils.js';
-import ReactOnRails from '../src/ReactOnRails.client.ts';
-import registerServerComponent from '../src/pro/registerServerComponent/client.tsx';
-import { clear as clearComponentRegistry } from '../src/pro/ComponentRegistry.ts';
+import ReactOnRails from '../../packages/react-on-rails/src/ReactOnRails.client.ts';
+import registerServerComponent from '../../packages/react-on-rails/src/pro/registerServerComponent/client.tsx';
+import { clear as clearComponentRegistry } from '../../packages/react-on-rails/src/pro/ComponentRegistry.ts';
 
 enableFetchMocks();
 
@@ -44,7 +44,7 @@ enableFetchMocks();
 
     expect(() => {
       // Re-import to trigger the check
-      jest.requireActual('../src/pro/wrapServerComponentRenderer/client.tsx');
+      jest.requireActual('../../packages/react-on-rails/src/pro/wrapServerComponentRenderer/client.tsx');
     }).toThrow('React.use is not defined');
   });
 

node_package/tests/renderFunction.test.jsx

@@ -5,7 +5,7 @@
 import * as React from 'react';
 import * as createReactClass from 'create-react-class';
 
-import isRenderFunction from '../src/isRenderFunction.ts';
+import isRenderFunction from '../../packages/react-on-rails/src/isRenderFunction.ts';
 
 describe('isRenderFunction', () => {
   it('returns false for a ES5 React Component', () => {

node_package/tests/scriptSanitizedVal.test.js

@@ -1,4 +1,4 @@
-import scriptSanitizedVal from '../src/scriptSanitizedVal.ts';
+import scriptSanitizedVal from '../../packages/react-on-rails/src/scriptSanitizedVal.ts';
 
 describe('scriptSanitizedVal', () => {
   it('returns no </script if spaces, uppercase 1', () => {

node_package/tests/serverRenderReactComponent.test.ts

@@ -1,13 +1,13 @@
 import * as React from 'react';
-import serverRenderReactComponent from '../src/serverRenderReactComponent.ts';
-import * as ComponentRegistry from '../src/pro/ComponentRegistry.ts';
+import serverRenderReactComponent from '../../packages/react-on-rails/src/serverRenderReactComponent.ts';
+import * as ComponentRegistry from '../../packages/react-on-rails/src/pro/ComponentRegistry.ts';
 import type {
   RenderParams,
   RenderResult,
   RailsContext,
   RenderFunction,
   RenderFunctionResult,
-} from '../src/types/index.ts';
+} from '../../packages/react-on-rails/src/types/index.ts';
 
 const assertIsString: (value: unknown) => asserts value is string = (value: unknown) => {
   if (typeof value !== 'string') {

node_package/tests/streamServerRenderedReactComponent.test.jsx

@@ -4,9 +4,9 @@
 
 import * as React from 'react';
 import * as PropTypes from 'prop-types';
-import streamServerRenderedReactComponent from '../src/pro/streamServerRenderedReactComponent.ts';
-import * as ComponentRegistry from '../src/pro/ComponentRegistry.ts';
-import ReactOnRails from '../src/ReactOnRails.node.ts';
+import streamServerRenderedReactComponent from '../../packages/react-on-rails/src/pro/streamServerRenderedReactComponent.ts';
+import * as ComponentRegistry from '../../packages/react-on-rails/src/pro/ComponentRegistry.ts';
+import ReactOnRails from '../../packages/react-on-rails/src/ReactOnRails.node.ts';
 
 const AsyncContent = async ({ throwAsyncError }) => {
   await new Promise((resolve) => {

node_package/tests/utils.test.js

@@ -1,6 +1,6 @@
 import { enableFetchMocks } from 'jest-fetch-mock';
 
-import { fetch } from '../src/utils.ts';
+import { fetch } from '../../packages/react-on-rails/src/utils.ts';
 import { createNodeReadableStream, getNodeVersion } from './testUtils.js';
 
 enableFetchMocks();