markdowndocs 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a3fffbcd50ae1f278895fe3bd5a1834916cc0f538218bf4b39c6901d4314ae
-  data.tar.gz: 120d2bb20c1b1ea471cdd68af794d2887c6817be63433d162ce93a06b652f880
+  metadata.gz: a6f2f9ae54ee9769434428aec5808626c4bcc08a55137c339c9310df30fe5973
+  data.tar.gz: c8e029017e1b6739c2b3f2740a016bdf42ff02e87d5935330601ea5f6bd2fb0e
 SHA512:
-  metadata.gz: 526153fb60c2781e578c417000d3fec8048d9c955b9c652e67f2c39e9e3b1d6ba36efcd412bed60d714fe0f714e101fca6861c8932226fcc8589033baca1c519
-  data.tar.gz: c3ce1ff0c86b6bcd12763268069fe6f766ac64793e327000228316cc50c9a59ea42310f15599846a47533866ff35082ae573fac927425c05f997abd3000b3807
+  metadata.gz: 751e5771036b40187003bbbdeaa0fc9ed27142b9d3e542a1e712d74b9f02ac174e82ae8f9ebb1a32b29b42fe3083c2990c746a92aac04fb50a31914a638bb66d
+  data.tar.gz: 22e8544a817e4402d071163c5fc809f316d90a13f7239f50d37e6d3756fd182535f869af85f34d594b94a566445ca799092fc2f0e6558b088b7749384a50fcf7

data/CHANGELOG.md

@@ -5,6 +5,23 @@ 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-03-18
+
+### Changed
+
+- Stimulus controllers now auto-register via a single JS entry point (`import "markdowndocs"`), following the ActionText/Trix pattern. Host apps no longer need to pin individual controllers in their importmap.
+- Install generator adds `import "markdowndocs"` to the host app's `application.js` instead of injecting importmap pins.
+- Added engine and generator specs for the new JS registration flow.
+
+## [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 +84,8 @@ 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.2]: https://github.com/dschmura/markdowndocs/releases/tag/v0.2.2
+[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/app/assets/javascripts/markdowndocs/application.js

@@ -0,0 +1,11 @@
+import DocsSearchController from "markdowndocs/controllers/docs_search_controller"
+import DocsModeController from "markdowndocs/controllers/docs_mode_controller"
+
+// Auto-register if Stimulus application exists on window, otherwise
+// the host app can import and register these controllers manually.
+if (window.Stimulus) {
+  window.Stimulus.register("docs-search", DocsSearchController)
+  window.Stimulus.register("docs-mode", DocsModeController)
+}
+
+export { DocsSearchController, DocsModeController }

data/config/importmap.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Importmap pins for Markdowndocs engine.
+# These are automatically registered with the host app when importmap-rails is present.
+
+pin "markdowndocs", to: "markdowndocs/application.js"
+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,21 @@ module Markdowndocs
         route 'mount Markdowndocs::Engine, at: "/docs"'
       end
 
+      def add_markdowndocs_import
+        js_file = Rails.root.join("app/javascript/application.js").to_s
+        return unless File.exist?(js_file)
+
+        js_content = File.read(js_file)
+        import_line = 'import "markdowndocs"'
+
+        if js_content.include?(import_line)
+          say_status :skip, "markdowndocs import already present in application.js", :yellow
+        else
+          append_to_file js_file, "\n#{import_line}\n"
+          say_status :import, "markdowndocs in application.js", :green
+        end
+      end
+
       def inject_tailwind_source
         css_file = find_tailwind_css_file
         return unless css_file
@@ -54,6 +69,9 @@ module Markdowndocs
           say "    @source \"#{Markdowndocs::Engine.root.join("app", "views")}/**/*.erb\";"
           say ""
         end
+        say "  Stimulus controllers are auto-registered via: import \"markdowndocs\"", :green
+        say "  If this was not added automatically, add it to app/javascript/application.js"
+        say ""
       end
 
       private

data/lib/markdowndocs/engine.rb

@@ -7,5 +7,26 @@ 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
+
+    initializer "markdowndocs.stimulus" do
+      Rails.application.config.after_initialize do
+        if defined?(Importmap)
+          # The pin is already added via importmap.rb
+          # Host app just needs: import "markdowndocs" in their application.js
+        end
+      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.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdowndocs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Dave Chmura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-21 00:00:00.000000000 Z
+date: 2026-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -78,6 +78,7 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
+- app/assets/javascripts/markdowndocs/application.js
 - app/assets/javascripts/markdowndocs/controllers/docs_mode_controller.js
 - app/assets/javascripts/markdowndocs/controllers/docs_search_controller.js
 - app/assets/javascripts/markdowndocs/vendor/minisearch.min.js
@@ -93,6 +94,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