markdowndocs 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a3fffbcd50ae1f278895fe3bd5a1834916cc0f538218bf4b39c6901d4314ae
-  data.tar.gz: 120d2bb20c1b1ea471cdd68af794d2887c6817be63433d162ce93a06b652f880
+  metadata.gz: cebbfbc9bd8562902775c6661f2241c7c5556b1ccecdc4cc6b993804d4c58e02
+  data.tar.gz: af7ab61db222e6dbd9dbecb557cc713068809fdd26604ed629c7b6a49c122e42
 SHA512:
-  metadata.gz: 526153fb60c2781e578c417000d3fec8048d9c955b9c652e67f2c39e9e3b1d6ba36efcd412bed60d714fe0f714e101fca6861c8932226fcc8589033baca1c519
-  data.tar.gz: c3ce1ff0c86b6bcd12763268069fe6f766ac64793e327000228316cc50c9a59ea42310f15599846a47533866ff35082ae573fac927425c05f997abd3000b3807
+  metadata.gz: 5389780ce9d8ad500df799b93bc5790cbca71651f2d320249be1d77cccb85124a484fc519c889e3fd2d8a8d1ec4458d9b65ba0925e706af2835261468e65bbdf
+  data.tar.gz: 9ccbdda3525cc1bd2268214dd684643d5c200da356495cdeeb8f99fa364bee4615910ad20334ee943dd95b75502bc20afb8a5888ab95ed7f45cb0baa0b92804e

data/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.1] - 2026-02-21
+
+### Fixed
+
+- Stimulus controllers and vendored minisearch now auto-register with the host app's importmap. Previously, host apps had to manually add pins to `config/importmap.rb`.
+- Engine now registers `app/assets/javascripts` in the asset pipeline paths so Propshaft/Sprockets can serve the JS files.
+- Install generator now injects importmap pins into the host app's `config/importmap.rb` during installation.
+- Both asset and importmap initializers gracefully skip when the host app doesn't use the relevant gems.
+
 ## [0.2.0] - 2026-02-21
 
 ### Added
@@ -67,6 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - i18n support for all UI strings
 - Install generator (`rails generate markdowndocs:install`)
 
+[0.2.1]: https://github.com/dschmura/markdowndocs/releases/tag/v0.2.1
 [0.2.0]: https://github.com/dschmura/markdowndocs/releases/tag/v0.2.0
 [0.1.5]: https://github.com/dschmura/markdowndocs/releases/tag/v0.1.5
 [0.1.4]: https://github.com/dschmura/markdowndocs/releases/tag/v0.1.4

data/config/importmap.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Importmap pins for Markdowndocs engine.
+# These are automatically registered with the host app when importmap-rails is present.
+
+pin "markdowndocs/controllers/docs_search_controller", to: "markdowndocs/controllers/docs_search_controller.js"
+pin "markdowndocs/controllers/docs_mode_controller", to: "markdowndocs/controllers/docs_mode_controller.js"
+pin "minisearch", to: "markdowndocs/vendor/minisearch.min.js"

data/lib/generators/markdowndocs/install/install_generator.rb

@@ -20,6 +20,28 @@ module Markdowndocs
         route 'mount Markdowndocs::Engine, at: "/docs"'
       end
 
+      def pin_importmap_assets
+        importmap_file = Rails.root.join("config/importmap.rb").to_s
+        return unless File.exist?(importmap_file)
+
+        importmap_content = File.read(importmap_file)
+
+        pins = {
+          'pin "markdowndocs/controllers/docs_search_controller", to: "markdowndocs/controllers/docs_search_controller.js"' => "docs_search_controller",
+          'pin "markdowndocs/controllers/docs_mode_controller", to: "markdowndocs/controllers/docs_mode_controller.js"' => "docs_mode_controller",
+          'pin "minisearch", to: "markdowndocs/vendor/minisearch.min.js"' => "minisearch"
+        }
+
+        pins.each do |pin_line, name|
+          if importmap_content.include?(pin_line)
+            say_status :skip, "importmap pin for #{name} already present", :yellow
+          else
+            append_to_file importmap_file, "\n#{pin_line}\n"
+            say_status :pin, name, :green
+          end
+        end
+      end
+
       def inject_tailwind_source
         css_file = find_tailwind_css_file
         return unless css_file
@@ -54,6 +76,11 @@ module Markdowndocs
           say "    @source \"#{Markdowndocs::Engine.root.join("app", "views")}/**/*.erb\";"
           say ""
         end
+        say "  Stimulus controllers are auto-registered via importmap.", :green
+        say "  If you use a custom Stimulus setup, register these controllers:"
+        say "    - markdowndocs/controllers/docs_mode_controller"
+        say "    - markdowndocs/controllers/docs_search_controller (when search is enabled)"
+        say ""
       end
 
       private

data/lib/markdowndocs/engine.rb

@@ -7,5 +7,17 @@ module Markdowndocs
     initializer "markdowndocs.i18n" do
       config.i18n.load_path += Dir[root.join("config/locales/**/*.yml")]
     end
+
+    initializer "markdowndocs.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join("app/assets/javascripts")
+      end
+    end
+
+    initializer "markdowndocs.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join("config/importmap.rb")
+      end
+    end
   end
 end

data/lib/markdowndocs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Markdowndocs
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdowndocs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dave Chmura
@@ -93,6 +93,7 @@ files:
 - app/views/markdowndocs/docs/_navigation.html.erb
 - app/views/markdowndocs/docs/index.html.erb
 - app/views/markdowndocs/docs/show.html.erb
+- config/importmap.rb
 - config/locales/en.yml
 - config/routes.rb
 - lib/generators/markdowndocs/install/install_generator.rb