react_on_rails 14.2.1 → 16.1.1

data/bin/lefthook/ruby-lint

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# Lint Ruby files with RuboCop
+set -euo pipefail
+
+CONTEXT="${1:-staged}"
+files="$(bin/lefthook/get-changed-files "$CONTEXT" '\.(rb|rake|ru)$')"
+
+if [ -z "$files" ]; then
+  echo "✅ No Ruby files to lint"
+  exit 0
+fi
+
+if [ "$CONTEXT" = "all-changed" ]; then
+  echo "🔍 RuboCop on all changed Ruby files:"
+else
+  echo "🔍 RuboCop on $CONTEXT Ruby files:"
+fi
+printf "  %s\n" $files
+
+if ! bundle exec rubocop --force-exclusion --display-cop-names -- $files; then
+  echo ""
+  echo "❌ RuboCop check failed!"
+  echo "💡 Auto-fix: bundle exec rubocop --auto-correct --force-exclusion -- $files"
+  echo "🚫 Skip hook: git commit --no-verify"
+  exit 1
+fi
+echo "✅ RuboCop checks passed for Ruby files"

data/eslint.config.ts

@@ -0,0 +1,232 @@
+import path from 'node:path';
+import { globalIgnores } from 'eslint/config';
+import jest from 'eslint-plugin-jest';
+import prettierRecommended from 'eslint-plugin-prettier/recommended';
+import testingLibrary from 'eslint-plugin-testing-library';
+import globals from 'globals';
+import tsEslint from 'typescript-eslint';
+import { includeIgnoreFile } from '@eslint/compat';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+const config = tsEslint.config([
+  includeIgnoreFile(path.resolve(__dirname, '.gitignore')),
+  globalIgnores([
+    // compiled code
+    'node_package/lib/',
+    // used for tests only
+    'spec/react_on_rails/dummy-for-generators',
+    // temporary and generated files
+    'spec/dummy/.yalc',
+    'spec/dummy/public',
+    'spec/dummy/vendor',
+    'spec/dummy/tmp',
+    'spec/dummy/app/assets/config/manifest.js',
+    'spec/dummy/client/app/packs/server-bundle.js',
+    '**/*.res.js',
+    '**/coverage',
+    '**/assets/webpack/',
+    '**/public/webpack/',
+    '**/generated/',
+    '**/app/assets/javascripts/application.js',
+    '**/cable.js',
+    '**/public/packs*/',
+    '**/gen-examples/',
+    '**/bundle/',
+    // dependencies
+    '**/node_modules/',
+    // fixtures
+    '**/fixtures/',
+    '**/.yalc/**/*',
+    // generator templates - exclude TypeScript templates that need tsconfig.json
+    '**/templates/**/*.tsx',
+    '**/templates/**/*.ts',
+  ]),
+  {
+    files: ['**/*.[jt]s', '**/*.[jt]sx', '**/*.[cm][jt]s'],
+  },
+  js.configs.recommended,
+  compat.extends('eslint-config-shakacode'),
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+
+      parserOptions: {
+        requireConfigFile: false,
+
+        babelOptions: {
+          presets: ['@babel/preset-env', '@babel/preset-react'],
+        },
+      },
+    },
+
+    settings: {
+      'import/core-modules': ['react-redux'],
+
+      'import/resolver': {
+        alias: [['Assets', './spec/dummy/client/app/assets']],
+
+        node: {
+          extensions: ['.js', '.jsx', '.ts', '.tsx', '.d.ts'],
+        },
+      },
+    },
+
+    rules: {
+      'no-shadow': 'off',
+      'no-console': 'off',
+      'function-paren-newline': 'off',
+      'object-curly-newline': 'off',
+      'no-restricted-syntax': ['error', 'SequenceExpression'],
+      'no-void': [
+        'error',
+        {
+          allowAsStatement: true,
+        },
+      ],
+
+      'import/extensions': [
+        'error',
+        'ignorePackages',
+        {
+          js: 'never',
+          jsx: 'never',
+          ts: 'never',
+          tsx: 'never',
+        },
+      ],
+
+      'import/first': 'off',
+      'import/no-extraneous-dependencies': 'off',
+      // The rule seems broken: it's reporting errors on imports in files using `export` too,
+      // not just `module.exports`.
+      'import/no-import-module-exports': 'off',
+      'import/no-unresolved': [
+        'error',
+        {
+          ignore: ['\\.res\\.js$'],
+        },
+      ],
+      'react/destructuring-assignment': [
+        'error',
+        'always',
+        {
+          ignoreClassFields: true,
+        },
+      ],
+      'react/forbid-prop-types': 'off',
+      'react/function-component-definition': [
+        'error',
+        {
+          namedComponents: ['arrow-function', 'function-declaration'],
+          unnamedComponents: 'arrow-function',
+        },
+      ],
+      'react/jsx-props-no-spreading': 'off',
+      'react/static-property-placement': 'off',
+      'jsx-a11y/anchor-is-valid': 'off',
+      'react/jsx-filename-extension': [
+        'error',
+        {
+          extensions: ['.jsx', '.tsx'],
+        },
+      ],
+    },
+  },
+  {
+    files: ['node_package/**/*'],
+    rules: {
+      'import/extensions': ['error', 'ignorePackages'],
+    },
+  },
+  {
+    files: ['lib/generators/react_on_rails/templates/**/*'],
+    rules: {
+      // It doesn't use package.json from the template
+      'import/no-unresolved': 'off',
+      // We have `const [name, setName] = useState(props.name)` so can't just destructure props
+      'react/destructuring-assignment': 'off',
+      // React 19 doesn't need PropTypes - we're targeting modern React
+      'react/prop-types': 'off',
+    },
+  },
+  {
+    files: ['spec/dummy/**/*'],
+    rules: {
+      // The dummy app dependencies are managed separately and may not be installed
+      'import/no-unresolved': 'off',
+    },
+  },
+  {
+    files: ['**/*.ts{x,}', '**/*.[cm]ts'],
+
+    extends: tsEslint.configs.strictTypeChecked,
+
+    languageOptions: {
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: ['eslint.config.ts', 'knip.ts', 'node_package/tests/*.test.{ts,tsx}'],
+          // Needed because `import * as ... from` instead of `import ... from` doesn't work in this file
+          // for some imports.
+          defaultProject: 'tsconfig.eslint.json',
+        },
+      },
+    },
+
+    rules: {
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-shadow': 'error',
+      '@typescript-eslint/no-confusing-void-expression': [
+        'error',
+        {
+          ignoreArrowShorthand: true,
+        },
+      ],
+      // Too many false positives
+      '@typescript-eslint/no-unnecessary-condition': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          caughtErrorsIgnorePattern: '^_',
+        },
+      ],
+      '@typescript-eslint/restrict-template-expressions': 'off',
+    },
+  },
+  {
+    files: ['**/app-react16/**/*'],
+    rules: {
+      'react/no-deprecated': 'off',
+    },
+  },
+  {
+    files: ['node_package/tests/**', '**/*.test.{js,jsx,ts,tsx}'],
+
+    extends: [
+      jest.configs['flat/recommended'],
+      jest.configs['flat/style'],
+      testingLibrary.configs['flat/dom'],
+    ],
+
+    rules: {
+      // Allows Jest mocks before import
+      'import/first': 'off',
+      // Avoiding these methods complicates tests and isn't useful for our purposes
+      'testing-library/no-node-access': 'off',
+    },
+  },
+  // must be the last config in the array
+  // https://github.com/prettier/eslint-plugin-prettier?tab=readme-ov-file#configuration-new-eslintconfigjs
+  prettierRecommended,
+]);
+
+export default config;

data/knip.ts

@@ -4,11 +4,34 @@ const config: KnipConfig = {
   // ! at the end means files are used in production
   workspaces: {
     '.': {
-      entry: ['node_package/src/ReactOnRails.ts!', 'node_package/src/ReactOnRails.node.ts!'],
-      project: ['node_package/src/**/*.[jt]s!', 'node_package/tests/**/*.[jt]s'],
+      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!',
+        'eslint.config.ts',
+      ],
+      project: ['node_package/src/**/*.[jt]s{x,}!', 'node_package/tests/**/*.[jt]s{x,}'],
       babel: {
         config: ['node_package/babel.config.js'],
       },
+      ignore: [
+        'node_package/tests/emptyForTesting.js',
+        // 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',
+      ],
       ignoreBinaries: [
         // Knip fails to detect it's declared in devDependencies
         'nps',
@@ -18,14 +41,24 @@ const config: KnipConfig = {
       ignoreDependencies: [
         // Required for TypeScript compilation, but we don't depend on Turbolinks itself.
         '@types/turbolinks',
-        // used in package-scripts.yml
-        'concurrently',
         // The Knip ESLint plugin fails to detect these are transitively required by a config,
         // though we don't actually use its rules anywhere.
+        '@babel/eslint-parser',
+        '@babel/preset-react',
+        'eslint-config-shakacode',
+        'eslint-import-resolver-alias',
+        'eslint-plugin-import',
         'eslint-plugin-jsx-a11y',
         'eslint-plugin-react',
-        // Used in CI
-        '@arethetypeswrong/cli',
+        'eslint-plugin-react-hooks',
+        // These are used as transitive dependencies and missing from package.json
+        '@eslint/eslintrc',
+        '@eslint/js',
+        // used by Jest
+        'jsdom',
+        // This is an optional peer dependency because users without RSC don't need it
+        // but Knip doesn't like such dependencies to be referenced directly in code
+        'react-on-rails-rsc',
       ],
     },
     'spec/dummy': {
@@ -39,6 +72,7 @@ const config: KnipConfig = {
         // Declaring this as webpack.config instead doesn't work correctly
         'config/webpack/webpack.config.js',
       ],
+      ignore: ['**/app-react16/**/*'],
       project: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}!', 'config/webpack/*.js'],
       paths: {
         'Assets/*': ['client/app/assets/*'],

data/lib/generators/USAGE

@@ -1,9 +1,8 @@
 Description:
 
-The react_on_rails:install generator integrates webpack with rails with ease. You
-can pass the redux option if you'd like to have redux setup for you automatically.
+The react_on_rails:install generator integrates a React frontend, including SSR, with Rails.
 
-* Redux
+* Redux (Optional)
 
     Passing the --redux generator option causes the generated Hello World example
     to integrate the Redux state container framework. The necessary node modules
@@ -13,11 +12,11 @@ can pass the redux option if you'd like to have redux setup for you automaticall
 
 After running the generator, you will want to:
 
-    bundle && yarn
+    bundle && npm install     # or yarn install, or pnpm install
 
 Then you may run
 
-    foreman start -f Procfile.dev
+    ./bin/dev
 
 More Details:
 

data/lib/generators/react_on_rails/USAGE

@@ -0,0 +1,65 @@
+Description:
+    The `react_on_rails:doctor` generator diagnoses your React on Rails setup
+    and identifies potential configuration issues. It performs comprehensive
+    checks on your environment, dependencies, and configuration files.
+
+    This command is especially useful for:
+    • Troubleshooting setup issues
+    • Verifying installation after running react_on_rails:install
+    • Ensuring compatibility after upgrades
+    • Getting help with configuration problems
+
+Example:
+    # Basic diagnosis
+    rails generate react_on_rails:doctor
+
+    # Verbose output showing all checks
+    rails generate react_on_rails:doctor --verbose
+
+    # Show help
+    rails generate react_on_rails:doctor --help
+
+Checks performed:
+    Environment Prerequisites:
+    • Node.js installation and version compatibility
+    • JavaScript package manager availability (npm, yarn, pnpm, bun)
+    • Git working directory status
+
+    React on Rails Packages:
+    • React on Rails gem installation
+    • react-on-rails NPM package installation
+    • Version synchronization between gem and NPM package
+    • Shakapacker configuration and installation
+
+    Dependencies:
+    • React and React DOM installation
+    • Babel preset configuration
+    • Required development dependencies
+
+    Rails Integration:
+    • React on Rails initializer configuration
+    • Route and controller setup (Hello World example)
+    • View helper integration
+
+    Webpack Configuration:
+    • Webpack config file existence and structure
+    • React on Rails compatibility checks
+    • Environment-specific configuration validation
+
+    Development Environment:
+    • JavaScript bundle files
+    • Procfile.dev for development workflow
+    • .gitignore configuration for generated files
+
+Options:
+    --verbose, -v: Show detailed output for all checks, including successful ones
+    --fix, -f:     Attempt to fix simple issues automatically (planned feature)
+
+Exit codes:
+    0: All checks passed or only warnings found
+    1: Critical errors found that prevent React on Rails from working
+
+For more help:
+    • Documentation: https://github.com/shakacode/react_on_rails
+    • Issues: https://github.com/shakacode/react_on_rails/issues
+    • Discord: https://discord.gg/reactrails