react-manifest-rails 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c76e23ad95cdf498e89dd0d63862c8d39b0acdf956df8dbf271a6157871e10f4
-  data.tar.gz: 68bb10eb5f7900798f4775db3399e9252879bdeb53e786b9d29e016e9e45600b
+  metadata.gz: 36adf78621e6d6b409a6242cccfe34fc7ab916357771c81683c17ef58c80b9a7
+  data.tar.gz: 4a4f18f2c4b3749376bb2c3adae8c9be6a881f9df04411a49c903c01d917282f
 SHA512:
-  metadata.gz: fdf7e42fb7ea57bfa28d818f53d387ac1dc6fbeb8015bf34a563fd095f1cd70edd966013a36996fe864f56d2fc3c21c97030b136f6b547d317a2555998484198
-  data.tar.gz: 36055fab58f773760266ad9e706a52dfe71e333e0dbd3e61db234e65095cb54709b82b031071ca78576db54ed9afb042ab72a232496c24bb5defd058f6169f63
+  metadata.gz: 665b92d9ba95e189fbc7791ad3a620df282df1ac9d865ccdd481618f41d47f53d86cb013881f5beac312115b73a7f862933145980ba6b4d9cda872ec3cd3e938
+  data.tar.gz: 2be3a86848583a94dcf49cd0b1f637b20d9f88ed8f2ca5abafe357f50ae51589d74c14164024a46e4c0ef6b9f969baa0e76017ba79518b4d98d1ff8a72716e59

data/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2026-04-15
+
+### Changed
+- Lowered required Ruby version from >= 3.2.0 to >= 3.0.0
+
 ## [0.1.0] - 2026-04-13
 
 ### Added

data/README.md

@@ -228,9 +228,118 @@ rails react_manifest:report
 - Consider splitting large bundles into smaller, more focused ones
 - Adjust `config.size_threshold_kb` in your initializer if needed
 
+## TypeScript / Custom Extensions
+
+By default the gem scans `*.js` and `*.jsx` files. To add TypeScript support:
+
+```ruby
+ReactManifest.configure do |config|
+  config.extensions = %w[js jsx ts tsx]
+end
+```
+
+This affects file scanning, manifest generation, and the development file watcher.
+
+## File Watching (`listen` gem)
+
+The development file watcher requires the `listen` gem, which is **not** a hard dependency. If `listen` is absent the watcher is silently disabled and you must regenerate manifests manually.
+
+To enable watching, add `listen` to the development group in your app's `Gemfile`:
+
+```ruby
+gem "listen", "~> 3.0", group: :development
+```
+
+> **Note:** Changes to `config/initializers/react_manifest.rb` are not picked up by the watcher — you must restart the server after editing the initializer.
+
+## Migrating an Existing `application.js`
+
+If you are adding this gem to an app that already has a monolithic `application.js`, use the built-in migration tools:
+
+**Step 1 — Analyse what's there:**
+
+```bash
+rails react_manifest:analyze
+```
+
+This classifies each `//= require` line as `:vendor` (keep), `:ux_code` (remove), or `:unknown` (review manually). No files are modified.
+
+**Step 2 — Preview changes:**
+
+```bash
+REACT_MANIFEST_DRY_RUN=1 rails react_manifest:migrate_application
+```
+
+**Step 3 — Apply changes:**
+
+```bash
+rails react_manifest:migrate_application
+```
+
+A `.bak` backup is created next to each modified file before any write.
+
+**Step 4 — Generate bundles and verify:**
+
+```bash
+rails react_manifest:generate
+rails assets:precompile  # or just start the dev server
+```
+
+**Rolling back:** Simply restore the `.bak` file and remove the generated `ux_*.js` manifests.
+
+## Troubleshooting
+
+### Bundle not being generated
+- Verify components live under `ux/app/<controller>/` (not directly under `ux/`)
+- Run `rails react_manifest:report` to see detected bundles
+- Check Rails logs for file watcher errors
+
+### Components not loading
+- Confirm `react_bundle_tag` is present in your layout
+- Check that the bundle name matches your controller path
+- Run `rails react_manifest:generate` to force regeneration
+
+### Bundle appears more than once in HTML output
+- A bundle name in `config.always_include` that is also the controller bundle will be deduplicated automatically. Check whether both the shared bundle name and a specific bundle are listed in `always_include`.
+
+### Watcher stops responding
+- This is usually resolved by restarting the development server
+- Ensure the `listen` gem is installed (see above)
+
+### Generator crashes on first run
+- Check that the process has write permission to `config.output_dir`
+- Verify `config.ux_root` exists; the generator is a no-op if the directory is missing
+
+### Size warnings
+- The gem warns when bundles exceed `config.size_threshold_kb` (default 500 KB)
+- Consider splitting large controller directories or moving shared code into the shared bundle
+- Adjust the threshold: `config.size_threshold_kb = 1000`
+
+## Performance
+
+| Scenario | Typical time |
+|----------|-------------|
+| Initial generation (small project, ~20 controllers) | < 1 s |
+| Initial generation (large project, ~100 controllers) | 2–5 s |
+| Watcher debounce (regeneration after file change) | ~300 ms |
+| Memory overhead (symbol index, large project) | < 10 MB |
+
+Scanning is purely regex-based — no Node.js or transpilation step required.
+
+## Compatibility
+
+| Dependency | Supported versions |
+|------------|-------------------|
+| Ruby | 3.2, 3.3 |
+| Rails / Railties | 6.1 – 8.x |
+| Sprockets | 3.x, 4.x |
+| listen (optional) | ~> 3.0 |
+
+> **Pre-1.0 notice:** The public API (configuration keys, rake task names, view helper signature) may change in minor versions until 1.0 is released. Pin to a patch version if stability is critical: `gem "react-manifest-rails", "~> 0.1.0"`.
+
 ## Requirements
 
-- Ruby >= 2.6.0
+- Ruby >= 3.2
 - Rails >= 6.1
 - Sprockets
 - react-rails

data/lib/react_manifest/application_analyzer.rb

@@ -6,26 +6,34 @@ module ReactManifest
   #
   # Produces a human-readable report without writing anything.
   class ApplicationAnalyzer
-    DIRECTIVE_PATTERN = /^\s*\/\/=\s+(require(?:_tree|_directory)?)\s+(.+)$/.freeze
+    DIRECTIVE_PATTERN = %r{^\s*//=\s+(require(?:_tree|_directory)?)\s+(.+)$}
 
     # Libs we recognise as vendor (case-insensitive partial match on the require path)
     VENDOR_HINTS = %w[
       react react-dom react_dom reactdom
       mui material-ui
-      redux redux-thunk
+      redux redux-thunk redux-saga redux-toolkit
       axios lodash underscore
       jquery backbone handlebars
       turbo stimulus
       vendor
+      bootstrap tailwind tailwindcss
+      moment date-fns dayjs
+      formik react-hook-form
+      recharts chartjs chart.js
+      framer-motion
+      i18next
+      classnames clsx
+      uuid
     ].freeze
 
     ClassifiedDirective = Struct.new(:original_line, :directive, :path, :classification, :note, keyword_init: true)
 
     Result = Struct.new(:file, :directives, keyword_init: true) do
-      def vendor_lines;   directives.select { |d| d.classification == :vendor };   end
-      def ux_code_lines;  directives.select { |d| d.classification == :ux_code };  end
-      def unknown_lines;  directives.select { |d| d.classification == :unknown };  end
-      def clean?;         ux_code_lines.empty? && unknown_lines.empty?;             end
+      def vendor_lines = directives.select { |d| d.classification == :vendor }
+      def ux_code_lines = directives.select { |d| d.classification == :ux_code }
+      def unknown_lines = directives.select { |d| d.classification == :unknown }
+      def clean? = ux_code_lines.empty? && unknown_lines.empty?
     end
 
     def initialize(config = ReactManifest.configuration)
@@ -47,17 +55,14 @@ module ReactManifest
       end
 
       results.each do |result|
-        rel = result.file.sub(Rails.root.to_s + "/", "")
+        rel = result.file.sub("#{Rails.root}/", "")
         status = result.clean? ? "✓ already clean" : "⚠ needs migration"
         puts "\n#{rel} [#{status}]"
         puts "-" * 60
 
+        icon_map = { vendor: "  ✓ KEEP   ", ux_code: "  ✗ REMOVE ", unknown: "  ? REVIEW " }
         result.directives.each do |d|
-          icon = case d.classification
-                 when :vendor   then "  ✓ KEEP   "
-                 when :ux_code  then "  ✗ REMOVE "
-                 when :unknown  then "  ? REVIEW "
-                 end
+          icon = icon_map[d.classification]
           puts "#{icon} #{d.original_line.strip}"
           puts "           → #{d.note}" if d.note
         end
@@ -86,26 +91,26 @@ module ReactManifest
         unless match
           # Non-directive lines (comments, blank) — pass through as :vendor (keep)
           directives << ClassifiedDirective.new(
-            original_line:  raw,
-            directive:      nil,
-            path:           nil,
+            original_line: raw,
+            directive: nil,
+            path: nil,
             classification: :passthrough,
-            note:           nil
+            note: nil
           )
           next
         end
 
-        directive = match[1]  # require, require_tree, require_directory
+        directive = match[1] # require, require_tree, require_directory
         path      = match[2].strip
 
         classification, note = classify_directive(directive, path)
 
         directives << ClassifiedDirective.new(
-          original_line:  raw,
-          directive:      directive,
-          path:           path,
+          original_line: raw,
+          directive: directive,
+          path: path,
           classification: classification,
-          note:           note
+          note: note
         )
       end
 
@@ -115,27 +120,22 @@ module ReactManifest
     def classify_directive(directive, path)
       # require_tree is almost always too greedy
       if directive.include?("tree") || directive.include?("directory")
-        if path_is_ux?(path)
-          return [:ux_code, "require_tree over ux/ — will be replaced by ux_*.js bundles"]
-        else
-          return [:unknown, "require_tree/require_directory — review manually: #{path}"]
-        end
+        return [:ux_code, "require_tree over ux/ — will be replaced by ux_*.js bundles"] if path_is_ux?(path)
+
+        return [:unknown, "require_tree/require_directory — review manually: #{path}"]
+
       end
 
       # Explicit require
-      if path_is_ux?(path)
-        return [:ux_code, "ux/ code — will be served by ux_*.js bundles"]
-      end
+      return [:ux_code, "ux/ code — will be served by ux_*.js bundles"] if path_is_ux?(path)
 
-      if path_is_vendor?(path)
-        return [:vendor, nil]
-      end
+      return [:vendor, nil] if path_is_vendor?(path)
 
       [:unknown, "Could not auto-classify — review manually"]
     end
 
     def path_is_ux?(path)
-      ux_prefix = @config.ux_root.split("/").last  # e.g. "ux"
+      ux_prefix = @config.ux_root.split("/").last # e.g. "ux"
       path.include?(ux_prefix) ||
         path.start_with?("./ux") ||
         path.start_with?("ux/")

data/lib/react_manifest/application_migrator.rb

@@ -8,7 +8,7 @@ module ReactManifest
   #   - Never removes :vendor or :passthrough lines
   #   - Adds a managed-by comment at the top
   class ApplicationMigrator
-    MANAGED_COMMENT = <<~JS
+    MANAGED_COMMENT = <<~JS.freeze
       // Vendor libraries — loaded on every page.
       // React app code is now served per-controller via react_bundle_tag.
       // Managed by react-manifest-rails — do not add require_tree.
@@ -54,8 +54,9 @@ module ReactManifest
       bak_path = "#{file}.bak"
       begin
         FileUtils.cp(file, bak_path)
+        File.chmod(0o600, bak_path)
         $stdout.puts "[ReactManifest] Backup: #{short(bak_path)}"
-      rescue => e
+      rescue StandardError => e
         $stdout.puts "[ReactManifest] ERROR: Could not create backup of #{short(file)}: #{e.message}"
         $stdout.puts "[ReactManifest] Migration aborted for #{short(file)} — original file unchanged."
         return { file: file, status: :backup_failed, error: e.message }
@@ -69,8 +70,11 @@ module ReactManifest
 
     def build_new_content(result)
       kept_lines = result.directives
-        .select { |d| %i[vendor passthrough].include?(d.classification) }
-        .map(&:original_line)
+                         .select do |d|
+        %i[vendor
+           passthrough].include?(d.classification)
+      end
+                                          .map(&:original_line)
 
       # Remove leading blank lines from kept_lines
       kept_lines.shift while kept_lines.first&.strip&.empty?
@@ -78,7 +82,7 @@ module ReactManifest
       lines = []
       lines << MANAGED_COMMENT
       lines += kept_lines
-      lines << ""  # trailing newline
+      lines << "" # trailing newline
 
       lines.join("\n")
     end
@@ -95,7 +99,7 @@ module ReactManifest
     end
 
     def short(path)
-      path.to_s.sub(Rails.root.to_s + "/", "")
+      path.to_s.sub("#{Rails.root}/", "")
     end
   end
 end

data/lib/react_manifest/configuration.rb

@@ -1,4 +1,12 @@
 module ReactManifest
+  # Holds all configuration for the gem. Obtain via {ReactManifest.configure}.
+  #
+  # @example
+  #   ReactManifest.configure do |c|
+  #     c.ux_root           = "app/assets/javascripts/ux"
+  #     c.extensions        = %w[js jsx ts tsx]
+  #     c.size_threshold_kb = 1000
+  #   end
   class Configuration
     # Root of the ux/ tree to scan (relative to Rails.root)
     attr_accessor :ux_root
@@ -24,6 +32,9 @@ module ReactManifest
     # Warn if a bundle exceeds this size in KB (0 = disabled)
     attr_accessor :size_threshold_kb
 
+    # File extensions to scan (default: js and jsx; add "ts", "tsx" for TypeScript)
+    attr_accessor :extensions
+
     # Print what would change, write nothing
     attr_accessor :dry_run
 
@@ -39,6 +50,7 @@ module ReactManifest
       @ignore            = []
       @exclude_paths     = %w[react react_dev vendor]
       @size_threshold_kb = 500
+      @extensions        = %w[js jsx]
       @dry_run           = false
       @verbose           = false
     end
@@ -51,6 +63,16 @@ module ReactManifest
       !!@verbose
     end
 
+    # Glob fragment used by Dir.glob, e.g. "*.{js,jsx}" or "*.{js,jsx,ts,tsx}"
+    def extensions_glob
+      "*.{#{extensions.join(',')}}"
+    end
+
+    # Regexp used by the file watcher to filter events, e.g. /\.(js|jsx)$/
+    def extensions_pattern
+      Regexp.new("\\.(#{extensions.map { |e| Regexp.escape(e) }.join('|')})$")
+    end
+
     # Absolute path helpers (requires Rails.root to be set)
     def abs_ux_root
       Rails.root.join(ux_root).to_s

data/lib/react_manifest/dependency_map.rb

@@ -1,6 +1,13 @@
 module ReactManifest
-  # Wraps scanner results into a queryable dependency map.
-  # Used by the analyze rake task and reporter for diagnostics.
+  # Wraps {Scanner} results into a queryable dependency map.
+  #
+  # Used by +react_manifest:analyze+ rake task and {Reporter} for diagnostics.
+  #
+  # @example
+  #   result = ReactManifest::Scanner.new.scan(classifier.classify)
+  #   map    = ReactManifest::DependencyMap.new(result)
+  #   map.shared_files_for("users")      # => ["ux/components/...", ...]
+  #   map.controllers_using("ux/lib/api_helpers") # => ["users", "admin"]
   class DependencyMap
     attr_reader :symbol_index, :controller_usages, :warnings
 
@@ -8,6 +15,12 @@ module ReactManifest
       @symbol_index      = scan_result.symbol_index
       @controller_usages = scan_result.controller_usages
       @warnings          = scan_result.warnings
+
+      # Inverted index: shared_file → [controllers] for O(1) lookup
+      @controllers_by_file = {}
+      @controller_usages.each do |ctrl, files|
+        files.each { |f| (@controllers_by_file[f] ||= []) << ctrl }
+      end
     end
 
     # All shared files used by the given controller
@@ -15,9 +28,9 @@ module ReactManifest
       @controller_usages.fetch(controller_name, [])
     end
 
-    # Which controllers use a given shared file
+    # Which controllers use a given shared file (O(1) via inverted index)
     def controllers_using(shared_file)
-      @controller_usages.select { |_, files| files.include?(shared_file) }.keys
+      @controllers_by_file.fetch(shared_file, [])
     end
 
     # Symbols defined in shared dirs
@@ -31,7 +44,10 @@ module ReactManifest
 
       puts "Shared Symbol Index (#{@symbol_index.size} symbols):"
       @symbol_index.each do |sym, file|
-        puts "  #{sym.ljust(40)} #{file}"
+        # Strip non-printable/control characters to prevent terminal manipulation
+        safe_sym  = sym.gsub(/[^\x20-\x7E]/, "?")
+        safe_file = file.gsub(/[^\x20-\x7E]/, "?")
+        puts "  #{safe_sym.ljust(40)} #{safe_file}"
       end
 
       puts "\nPer-Controller Usage:"

data/lib/react_manifest/generator.rb

@@ -1,11 +1,19 @@
 require "digest"
-require "set"
 require "time"
 require "tmpdir"
 
 module ReactManifest
   # Generates all ux_*.js Sprockets manifest files.
   #
+  # Instantiate with a {Configuration} and call {#run!}:
+  #
+  #   ReactManifest::Generator.new(ReactManifest.configuration).run!
+  #
+  # Returns an array of result hashes:
+  #   [{path: "/abs/path/ux_shared.js", status: :written}, ...]
+  #
+  # Possible +status+ values: +:written+, +:unchanged+, +:skipped_pinned+, +:dry_run+.
+  #
   # Generates:
   #   ux_shared.js   — requires all files from shared dirs (components/, hooks/, lib/, etc.)
   #   ux_<ctrl>.js   — one per controller subdir, requires ux_shared + controller files
@@ -16,7 +24,7 @@ module ReactManifest
   #
   # Never touches application.js, application_dev.js, or files in exclude_paths.
   class Generator
-    HEADER = <<~JS
+    HEADER = <<~JS.freeze
       // AUTO-GENERATED — DO NOT EDIT
       // react-manifest-rails %<version>s | %<timestamp>s
       // Run `rails react_manifest:generate` to regenerate.
@@ -28,17 +36,20 @@ module ReactManifest
     end
 
     # Run full generation. Returns array of {path:, status:} hashes.
+    #
+    # All manifest content is built first (no filesystem writes), then written
+    # in a second pass so that a failure midway does not leave some bundles
+    # written and others stale/missing.
     def run!
-      results        = []
       classification = @classifier.classify
 
-      # 1. Generate ux_shared.js
-      results << generate_shared(classification.shared_dirs)
+      # Phase 1: build all content in memory — no I/O.
+      manifests = []
+      manifests << build_shared(classification.shared_dirs)
+      classification.controller_dirs.each { |ctrl| manifests << build_controller(ctrl) }
 
-      # 2. Generate one ux_<controller>.js per controller dir
-      classification.controller_dirs.each do |ctrl|
-        results << generate_controller(ctrl)
-      end
+      # Phase 2: write — each write is atomic (tmp + rename).
+      results = manifests.map { |m| write_manifest(m[:filename], m[:content]) }
 
       print_summary(results) if @config.verbose?
       results
@@ -48,7 +59,7 @@ module ReactManifest
 
     # ------------------------------------------------------------------ shared
 
-    def generate_shared(shared_dirs)
+    def build_shared(shared_dirs)
       lines     = header_lines
       any_files = false
 
@@ -60,17 +71,14 @@ module ReactManifest
         files.each { |f| lines << "//= require #{relative_require_path(f)}" }
       end
 
-      unless any_files
-        lines << "// (no shared files found)"
-      end
+      lines << "// (no shared files found)" unless any_files
 
-      bundle_name = @config.shared_bundle
-      write_manifest("#{bundle_name}.js", lines.join("\n") + "\n")
+      { filename: "#{@config.shared_bundle}.js", content: "#{lines.join("\n")}\n" }
     end
 
     # --------------------------------------------------------------- controller
 
-    def generate_controller(ctrl)
+    def build_controller(ctrl)
       lines = header_lines
       lines << "//= require #{@config.shared_bundle}"
       lines << ""
@@ -82,7 +90,7 @@ module ReactManifest
         files.each { |f| lines << "//= require #{relative_require_path(f)}" }
       end
 
-      write_manifest("#{ctrl[:bundle_name]}.js", lines.join("\n") + "\n")
+      { filename: "#{ctrl[:bundle_name]}.js", content: "#{lines.join("\n")}\n" }
     end
 
     # --------------------------------------------------------------- write
@@ -92,17 +100,13 @@ module ReactManifest
 
       # Safety: never touch files not bearing our AUTO-GENERATED header
       # (unless they don't exist yet)
-      if File.exist?(dest) && !auto_generated?(dest)
-        return { path: dest, status: :skipped_pinned }
-      end
+      return { path: dest, status: :skipped_pinned } if File.exist?(dest) && !auto_generated?(dest)
 
       new_digest = Digest::SHA256.hexdigest(content)
 
       if File.exist?(dest)
         existing_digest = Digest::SHA256.hexdigest(File.read(dest, encoding: "utf-8"))
-        if existing_digest == new_digest
-          return { path: dest, status: :unchanged }
-        end
+        return { path: dest, status: :unchanged } if existing_digest == new_digest
       end
 
       if @config.dry_run?
@@ -119,8 +123,8 @@ module ReactManifest
       begin
         File.write(tmp, content, encoding: "utf-8")
         File.rename(tmp, dest)
-      rescue => e
-        File.unlink(tmp) if File.exist?(tmp)
+      rescue StandardError => e
+        FileUtils.rm_f(tmp)
         raise e
       end
 
@@ -131,7 +135,7 @@ module ReactManifest
 
     def header_lines
       [
-        HEADER % { version: ReactManifest::VERSION, timestamp: Time.now.utc.iso8601 },
+        format(HEADER, version: ReactManifest::VERSION, timestamp: Time.now.utc.iso8601),
         ""
       ].flatten
     end
@@ -139,11 +143,11 @@ module ReactManifest
     def js_files_in(dir)
       return [] unless Dir.exist?(dir)
 
-      files = Dir.glob(File.join(dir, "**", "*.{js,jsx}"))
-        .reject { |f| File.directory?(f) }
-        .reject { |f| auto_generated?(f) }
-        .reject { |f| excluded_path?(f) }
-        .sort
+      files = Dir.glob(File.join(dir, "**", @config.extensions_glob))
+                 .reject { |f| File.directory?(f) }
+                 .reject { |f| auto_generated?(f) }
+                 .reject { |f| excluded_path?(f) }
+                 .sort
 
       # Deduplicate by logical require path: if both foo.js and foo.jsx exist,
       # keep foo.js (sorted first) to avoid duplicate //= require directives
@@ -152,6 +156,7 @@ module ReactManifest
       files.each_with_object([]) do |f, uniq|
         logical = relative_require_path(f)
         next if seen.include?(logical)
+
         seen << logical
         uniq << f
       end
@@ -174,11 +179,12 @@ module ReactManifest
     end
 
     def auto_generated?(path)
-      return false unless File.exist?(path)
-      # Read up to first 2 lines — handles empty files (first.to_s returns "")
-      # without incorrectly treating them as user-pinned.
+      # Avoid TOCTOU: don't check existence separately — just attempt the read
+      # and treat a missing/unreadable file as not auto-generated.
       first_two = File.foreach(path).first(2).join
       first_two.include?("AUTO-GENERATED")
+    rescue Errno::ENOENT, Errno::EACCES
+      false
     end
 
     def print_diff(dest, new_content)

data/lib/react_manifest/railtie.rb

@@ -12,7 +12,7 @@ module ReactManifest
       if Rails.env.development? && !ReactManifest::Watcher.running?
         begin
           ReactManifest::Watcher.start(ReactManifest.configuration)
-        rescue => e
+        rescue StandardError => e
           Rails.logger.warn "[ReactManifest] Could not start file watcher: #{e.message}"
         end
       end
@@ -36,7 +36,7 @@ module ReactManifest
     # (which is subject to parallel task ordering under rake -j).
     # ----------------------------------------------------------------
     rake_tasks do
-      load File.expand_path("../../../tasks/react_manifest.rake", __FILE__)
+      load File.expand_path("../../tasks/react_manifest.rake", __dir__)
 
       if Rake::Task.task_defined?("assets:precompile")
         Rake::Task["assets:precompile"].enhance(["react_manifest:generate"])

data/lib/react_manifest/reporter.rb

@@ -63,8 +63,8 @@ module ReactManifest
         gzip_kb = File.exist?(gz_path) ? (File.size(gz_path) / 1024.0).round(1) : nil
 
         bundles << {
-          name:    logical_path,
-          raw_kb:  raw_kb,
+          name: logical_path,
+          raw_kb: raw_kb,
           gzip_kb: gzip_kb
         }
       end
@@ -75,13 +75,13 @@ module ReactManifest
     def print_table(bundles)
       gzip_available = bundles.any? { |b| b[:gzip_kb] }
 
-      puts "\n#{"Bundle".ljust(35)} #{"Raw (KB)".rjust(10)}#{gzip_available ? "   #{"Gzip (KB)".rjust(10)}" : ""}"
+      puts "\n#{'Bundle'.ljust(35)} #{'Raw (KB)'.rjust(10)}#{"   #{'Gzip (KB)'.rjust(10)}" if gzip_available}"
       puts "-" * (gzip_available ? 62 : 48)
 
       bundles.each do |b|
-        over_threshold = @config.size_threshold_kb > 0 && b[:raw_kb] > @config.size_threshold_kb
+        over_threshold = @config.size_threshold_kb.positive? && b[:raw_kb] > @config.size_threshold_kb
         flag           = over_threshold ? "  ⚠ exceeds #{@config.size_threshold_kb}KB threshold" : ""
-        gzip_col       = gzip_available ? "   #{(b[:gzip_kb] || "n/a").to_s.rjust(10)}" : ""
+        gzip_col       = gzip_available ? "   #{(b[:gzip_kb] || 'n/a').to_s.rjust(10)}" : ""
 
         puts "#{b[:name].ljust(35)} #{b[:raw_kb].to_s.rjust(10)}#{gzip_col}#{flag}"
       end

data/lib/react_manifest/scanner.rb

@@ -1,7 +1,10 @@
-require "set"
-
 module ReactManifest
-  # Scans JSX/JS files using regex (no AST, no Node.js required).
+  # Scans JS/JSX (and optionally TS/TSX) files using regex — no AST, no Node.js required.
+  #
+  # Returns a {Result} containing:
+  # - +symbol_index+  — map of exported symbol name → shared require path
+  # - +controller_usages+ — map of controller name → sorted array of referenced shared files
+  # - +warnings+ — non-fatal issues found during scanning
   #
   # Phase 1 — builds a symbol index from shared dirs:
   #   "PrimaryButton" => "ux/components/buttons/primary_button"
@@ -13,23 +16,34 @@ module ReactManifest
   #
   # Phase 3 — emits non-fatal warnings.
   class Scanner
-    # Patterns to detect symbol definitions (no import/export in this codebase)
+    # Patterns to detect symbol definitions (CommonJS and ES module style)
     DEFINITION_PATTERNS = [
-      /(?:const|let|var)\s+([A-Z][A-Za-z0-9_]*)\s*=/,        # const FooBar =
-      /function\s+([A-Z][A-Za-z0-9_]*)\s*\(/,                 # function FooBar(
-      /class\s+([A-Z][A-Za-z0-9_]*)\s*(?:extends|\{)/,        # class FooBar
-      /(?:const|let|var)\s+(use[A-Z][A-Za-z0-9_]*)\s*=/,     # const useFoo = (hooks)
-      /function\s+(use[A-Z][A-Za-z0-9_]*)\s*\(/,              # function useFoo(
-      /(?:const|let|var)\s+([a-z][A-Za-z0-9_]{2,})\s*=\s*(?:function|\()/,  # const formatDate = function/arrow
-      /^function\s+([a-z][A-Za-z0-9_]{2,})\s*\(/,            # function formatDate( at line start
+      # CommonJS / variable-assignment style
+      /(?:const|let|var)\s+([A-Z][A-Za-z0-9_]*)\s*=/, # const FooBar =
+      /function\s+([A-Z][A-Za-z0-9_]*)\s*\(/,                                       # function FooBar(
+      /class\s+([A-Z][A-Za-z0-9_]*)\s*(?:extends|\{)/,                              # class FooBar
+      /(?:const|let|var)\s+(use[A-Z][A-Za-z0-9_]*)\s*=/, # const useFoo = (hooks)
+      /function\s+(use[A-Z][A-Za-z0-9_]*)\s*\(/, # function useFoo(
+      /(?:const|let|var)\s+([a-z][A-Za-z0-9_]{2,})\s*=\s*(?:function|\()/, # const formatDate = function/arrow
+      /^function\s+([a-z][A-Za-z0-9_]{2,})\s*\(/, # function formatDate( at line start
+
+      # ES module style (export default / named exports)
+      /^export\s+default\s+(?:function|class)\s+([A-Z][A-Za-z0-9_]*)/,             # export default function Foo
+      /^export\s+default\s+(?:function|class)\s+(use[A-Z][A-Za-z0-9_]*)/,          # export default function useFoo
+      /^export\s+(?:const|let|var)\s+([A-Z][A-Za-z0-9_]*)\s*=/,                    # export const Foo =
+      /^export\s+(?:const|let|var)\s+(use[A-Z][A-Za-z0-9_]*)\s*=/,                 # export const useFoo =
+      /^export\s+(?:const|let|var)\s+([a-z][A-Za-z0-9_]{2,})\s*=\s*(?:function|\()/, # export const formatDate =
+      /^export\s+function\s+([A-Z][A-Za-z0-9_]*)\s*\(/,                             # export function Foo(
+      /^export\s+function\s+(use[A-Z][A-Za-z0-9_]*)\s*\(/,                          # export function useFoo(
+      /^export\s+class\s+([A-Z][A-Za-z0-9_]*)\s*(?:extends|\{)/ # export class Foo
     ].freeze
 
     # Patterns to detect usage in controller files
-    JSX_ELEMENT_PATTERN      = /<([A-Z][A-Za-z0-9_]*)[\s\/>]/.freeze
-    REACT_CREATE_PATTERN     = /React\.createElement\(\s*([A-Z][A-Za-z0-9_]*)[\s,)]/.freeze
-    HOOK_CALL_PATTERN        = /\b(use[A-Z][A-Za-z0-9_]*)\s*\(/.freeze
+    JSX_ELEMENT_PATTERN      = %r{<([A-Z][A-Za-z0-9_]*)[\s/>]}
+    REACT_CREATE_PATTERN     = /React\.createElement\(\s*([A-Z][A-Za-z0-9_]*)[\s,)]/
+    HOOK_CALL_PATTERN        = /\b(use[A-Z][A-Za-z0-9_]*)\s*\(/
     # Lib calls matched against known lib symbols to reduce false positives
-    LIB_CALL_PATTERN         = /\b([a-z][A-Za-z0-9_]{2,})\s*\(/.freeze
+    LIB_CALL_PATTERN         = /\b([a-z][A-Za-z0-9_]{2,})\s*\(/
 
     # Common JS built-ins to exclude from lib-call matching
     JS_BUILTINS = %w[
@@ -66,9 +80,7 @@ module ReactManifest
         end
       end
 
-      if @config.verbose?
-        $stdout.puts "[ReactManifest] Shared symbol index: #{symbol_index.size} symbols indexed"
-      end
+      $stdout.puts "[ReactManifest] Shared symbol index: #{symbol_index.size} symbols indexed" if @config.verbose?
 
       # Phase 2: scan controller dirs for usage
       controller_usages = {}
@@ -77,45 +89,44 @@ module ReactManifest
         files   = js_files_in(ctrl[:path])
         used    = Set.new
 
-        if files.empty? && @config.verbose?
-          warnings << "Controller dir '#{ctrl[:name]}' has no JS/JSX files"
-        end
+        warnings << "Controller dir '#{ctrl[:name]}' has no JS/JSX files" if files.empty? && @config.verbose?
 
         files.each do |file_path|
           validate_naming(file_path, ctrl[:name], warnings)
-          content = File.read(file_path, encoding: "utf-8")
+          begin
+            content = File.read(file_path, encoding: "utf-8")
+          rescue Errno::ENOENT, Errno::EACCES => e
+            warnings << "Skipping #{file_path}: #{e.message}"
+            next
+          rescue Encoding::InvalidByteSequenceError
+            warnings << "Skipping #{file_path}: not valid UTF-8"
+            next
+          end
 
           # JSX element usage: <PrimaryButton (JSX tag syntax)
           content.scan(JSX_ELEMENT_PATTERN) do |match|
             sym = match[0]
-            if symbol_index.key?(sym)
-              used << symbol_index[sym]
-            end
+            used << symbol_index[sym] if symbol_index.key?(sym)
           end
 
           # React.createElement(PrimaryButton, ...) (non-JSX style)
           content.scan(REACT_CREATE_PATTERN) do |match|
             sym = match[0]
-            if symbol_index.key?(sym)
-              used << symbol_index[sym]
-            end
+            used << symbol_index[sym] if symbol_index.key?(sym)
           end
 
           # Hook calls: useFetch(
           content.scan(HOOK_CALL_PATTERN) do |match|
             sym = match[0]
-            if symbol_index.key?(sym)
-              used << symbol_index[sym]
-            end
+            used << symbol_index[sym] if symbol_index.key?(sym)
           end
 
           # Lib function calls: formatDate( — filtered against lib symbol index
           content.scan(LIB_CALL_PATTERN) do |match|
             sym = match[0]
             next if JS_BUILTINS.include?(sym)
-            if symbol_index.key?(sym)
-              used << symbol_index[sym]
-            end
+
+            used << symbol_index[sym] if symbol_index.key?(sym)
           end
         end
 
@@ -126,9 +137,9 @@ module ReactManifest
       emit_fanout_warnings(controller_usages, warnings)
 
       Result.new(
-        symbol_index:       symbol_index,
-        controller_usages:  controller_usages,
-        warnings:           warnings
+        symbol_index: symbol_index,
+        controller_usages: controller_usages,
+        warnings: warnings
       )
     end
 
@@ -136,10 +147,11 @@ module ReactManifest
 
     def js_files_in(dir)
       return [] unless Dir.exist?(dir)
-      Dir.glob(File.join(dir, "**", "*.{js,js.jsx}"))
-        .reject { |f| File.directory?(f) }
-        .reject { |f| excluded_path?(f) }
-        .sort
+
+      Dir.glob(File.join(dir, "**", @config.extensions_glob))
+         .reject { |f| File.directory?(f) }
+         .reject { |f| excluded_path?(f) }
+         .sort
     end
 
     # Returns true if the file path contains a segment matching any exclude_path.
@@ -149,7 +161,11 @@ module ReactManifest
     end
 
     def extract_definitions(file_path)
-      content = File.read(file_path, encoding: "utf-8")
+      begin
+        content = File.read(file_path, encoding: "utf-8")
+      rescue Errno::ENOENT, Errno::EACCES, Encoding::InvalidByteSequenceError
+        return []
+      end
       symbols = []
       DEFINITION_PATTERNS.each do |pattern|
         content.scan(pattern) { |m| symbols << m[0] }
@@ -168,10 +184,10 @@ module ReactManifest
     def validate_naming(file_path, ctrl_name, warnings)
       basename = File.basename(file_path, ".*").sub(/\.js$/, "")
       # Expected: <controller>_index, <controller>_show, <controller>_form, etc.
-      unless basename.start_with?("#{ctrl_name}_") || basename == ctrl_name
-        warnings << "File '#{File.basename(file_path)}' in '#{ctrl_name}' does not follow " \
-                    "'#{ctrl_name}_<action>.js.jsx' naming convention"
-      end
+      return if basename.start_with?("#{ctrl_name}_") || basename == ctrl_name
+
+      warnings << "File '#{File.basename(file_path)}' in '#{ctrl_name}' does not follow " \
+                  "'#{ctrl_name}_<action>.js.jsx' naming convention"
     end
 
     def emit_fanout_warnings(controller_usages, warnings)

data/lib/react_manifest/tree_classifier.rb

@@ -24,18 +24,18 @@ module ReactManifest
       begin
         Dir.children(@config.abs_ux_root).sort.each do |entry|
           full_path = File.join(@config.abs_ux_root, entry)
-          next unless File.directory?(full_path)
+          next unless real_directory?(full_path)
 
           if entry == @config.app_dir
             begin
               Dir.children(full_path).sort.each do |ctrl_entry|
                 ctrl_path = File.join(full_path, ctrl_entry)
-                next unless File.directory?(ctrl_path)
+                next unless real_directory?(ctrl_path)
                 next if @config.ignore.include?(ctrl_entry)
 
                 controller_dirs << {
-                  name:        ctrl_entry,
-                  path:        ctrl_path,
+                  name: ctrl_entry,
+                  path: ctrl_path,
                   bundle_name: "ux_#{ctrl_entry}"
                 }
               end
@@ -57,10 +57,23 @@ module ReactManifest
       Result.new(controller_dirs: controller_dirs, shared_dirs: shared_dirs)
     end
 
+    private
+
+    # Returns true for both plain directories and symlinks that point to directories.
+    # File.directory? returns false for symlinks on some systems.
+    def real_directory?(path)
+      File.directory?(File.realpath(path))
+    rescue Errno::ENOENT, Errno::ELOOP
+      false
+    end
+
+    public
+
     # Watch ux_root recursively so newly added controller directories
     # are automatically detected without restarting the development server.
     def watched_dirs
       return [] unless Dir.exist?(@config.abs_ux_root)
+
       dirs = [@config.abs_ux_root]
       dirs << @config.abs_app_dir if Dir.exist?(@config.abs_app_dir)
       dirs

data/lib/react_manifest/version.rb

@@ -1,3 +1,3 @@
 module ReactManifest
-  VERSION = "0.1.0"
+  VERSION = "0.2.2".freeze
 end

data/lib/react_manifest/watcher.rb

@@ -27,11 +27,11 @@ module ReactManifest
           return
         end
 
-        log "Watching #{root.sub(Rails.root.to_s + '/', '')} for changes..."
+        log "Watching #{root.sub("#{Rails.root}/", '')} for changes..."
 
         @listener = Listen.to(
           root,
-          only:    /\.(js|jsx)$/,
+          only: config.extensions_pattern,
           latency: DEBOUNCE_SECONDS
         ) do |modified, added, removed|
           changed = (modified + added + removed).map { |f| File.basename(f) }
@@ -56,7 +56,7 @@ module ReactManifest
       def regenerate!(config)
         Generator.new(config).run!
         log "Manifests regenerated"
-      rescue => e
+      rescue StandardError => e
         log "Error during regeneration: #{e.message}"
         log e.backtrace.first(5).join("\n") if config.verbose?
       end

data/lib/react_manifest.rb

@@ -1,4 +1,3 @@
-require "set"
 require "fileutils"
 
 require "react_manifest/version"
@@ -35,9 +34,7 @@ module ReactManifest
       bundles = []
 
       # 1. Shared bundle always first
-      if bundle_exists?(output, config.shared_bundle)
-        bundles << config.shared_bundle
-      end
+      bundles << config.shared_bundle if bundle_exists?(output, config.shared_bundle)
 
       # 2. always_include bundles (e.g. ux_main)
       config.always_include.each do |b|

data/tasks/react_manifest.rake

@@ -15,7 +15,7 @@ namespace :react_manifest do
     end
 
     # Print any scanner warnings
-    results  # warnings are printed inline by scanner via $stdout in verbose mode
+    results # warnings are printed inline by scanner via $stdout in verbose mode
   end
 
   desc "Print the JSX dependency map and warnings without writing any files"
@@ -65,10 +65,10 @@ namespace :react_manifest do
       first_line = File.foreach(file).first.to_s
       if first_line.include?("AUTO-GENERATED")
         File.delete(file)
-        puts "[ReactManifest] Removed: #{file.sub(Rails.root.to_s + '/', '')}"
+        puts "[ReactManifest] Removed: #{file.sub("#{Rails.root}/", '')}"
         removed += 1
       else
-        puts "[ReactManifest] Skipped (not auto-generated): #{file.sub(Rails.root.to_s + '/', '')}"
+        puts "[ReactManifest] Skipped (not auto-generated): #{file.sub("#{Rails.root}/", '')}"
         skipped += 1
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react-manifest-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Oliver Noonan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-13 00:00:00.000000000 Z
+date: 2026-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,70 +16,82 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +107,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: |
   react-manifest-rails automatically generates per-controller Sprockets manifest
   files for Rails applications using react-rails + Sprockets. It eliminates the
@@ -144,6 +156,8 @@ metadata:
   homepage_uri: https://github.com/olivernoonan/react-manifest-rails
   source_code_uri: https://github.com/olivernoonan/react-manifest-rails
   changelog_uri: https://github.com/olivernoonan/react-manifest-rails/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/olivernoonan/react-manifest-rails/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -152,14 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Zero-touch Sprockets manifest generation for react-rails apps