importmap-rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cffa11ad049d46f3ef56fab7da90f3af2327a939798919d99a5947c686182c62
-  data.tar.gz: c5e5e51d1b31390d829eb3597d0edb6baa1b2f47a6927819be7010f5051902bf
+  metadata.gz: e9569cf8ada42f3b40596da6bbb24565237a45f3f49108b91470d18715d6fe55
+  data.tar.gz: 682592d777e3fffa178e4b0f74fc97c83564f4222a881532376a26890faa12da
 SHA512:
-  metadata.gz: 616fde8d62bf12df6a978db064d6a0dfa6df81738952fab605edf5642d860b555e9f2e533fc0a3856dffd4342cc76e6223b1c66174fbdcb3f56c045e041a3478
-  data.tar.gz: 44080fa546f79169abbc7fde3717df239e5cc0c7765d238762710cb1c62eb9ddb6f8cf33d63cc4abd69c750297714ae42e04ddb29ac44637fe2f27b83cc227e0
+  metadata.gz: 6ff7b0f6d2f5510281a6f540096b03dd7dc760927edf229425c1b5032b93e88ae17276fc9b348c7777cff0eacf39b58e944db26169d11db44c35c75185b89384
+  data.tar.gz: 9456a86bc8264595860b0e0e03690c82f9fb739f1a5a4ea7850f59f7570daec22c42ba18d6fde9fd5bc5cc76d4b310c6d4e172c4a5dfe8b18ef98d0a7e597dae

data/README.md

@@ -15,6 +15,8 @@ There's [native support for import maps in Chrome/Edge 89+](https://caniuse.com/
 
 By default, all the files in `app/assets/javascripts` and the three major Rails JavaScript libraries are already mapped. You can add more mappings in `config/initializers/assets.rb`.
 
+Note: In order to use JavaScript from Rails frameworks like Action Cable, Action Text, and Active Storage, you must be running Rails 7.0+. This was the first version that shipped with ESM compatible builds of these libraries.
+
 
 ## Usage
 
@@ -37,6 +39,26 @@ import "@hotwired/stimulus-autoloader"
 ```
 
 
+## Use with Skypack (and other CDNs)
+
+Instead of mapping JavaScript modules to files in your application's path, you can also reference them directly from JavaScript CDNs like Skypack. Simply add them to the `config/initializers/assets.rb` with the URL instead of the local path:
+
+```ruby
+Rails.application.config.importmap.paths.tap do |paths|
+  paths.asset "trix", path: "https://cdn.skypack.dev/trix"
+  paths.asset "md5", path: "https://cdn.skypack.dev/md5"
+end
+```
+
+Now you can use these in your application.js entrypoint like you would any other module:
+
+```js
+import "trix"
+import md5 from "md5"
+console.log(md5("Hash it out"))
+``` 
+
+
 ## Expected errors from using the es-module-shim
 
 While import maps are native in Chrome and Edge, they need a shim in other browsers that'll produce a JavaScript console error like `TypeError: Module specifier, 'application' does not start with "/", "./", or "../".`. This error is normal and does not have any user-facing consequences.

data/lib/importmap/paths.rb

@@ -20,7 +20,14 @@ class Importmap::Paths
 
   private
     def map_to_asset_paths(resolver)
-      expanded_files_and_directories.transform_values { |path| resolver.asset_path(path) }
+      expanded_files_and_directories.transform_values do |path|
+        begin
+          resolver.asset_path(path)
+        rescue Sprockets::Rails::Helper::AssetNotFound
+          Rails.logger.warn "Importmap skipped missing asset: #{path}"
+          nil
+        end
+      end.compact
     end
 
     def expanded_files_and_directories

data/lib/importmap/version.rb

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/install/install.rb

@@ -10,28 +10,35 @@ end
 
 say "Create application.js module as entrypoint"
 create_file Rails.root.join("app/assets/javascripts/application.js") do <<-JS
+// Configure your import map in config/initializers/assets.rb
+
 // import "@rails/actioncable"
-// import "@rails/actiontext"
 // import "@rails/activestorage"
 JS
 end
 
 say "Ensure JavaScript files are in the asset pipeline manifest"
-append_to_file Rails.root.join("app/assets/config/manifest.js"), %(//= link_tree ../javascripts)
+append_to_file Rails.root.join("app/assets/config/manifest.js"), %(//= link_tree ../javascripts .js\n)
 
 say "Configure importmap paths in config/initializers/assets.rb"
 append_to_file Rails.root.join("config/initializers/assets.rb") do <<-RUBY
 
-# Configure importmap paths in addition to having all files in app/assets/javascripts mapped.
+# Configure import map beyond the default of having all files in app/assets/javascripts mapped.
 Rails.application.config.importmap.paths.tap do |paths|
-  # Match libraries with their NPM package names for possibility of easy later porting.
+  # Match libraries with their NPM package names for possibility of later porting.
   # Ensure that libraries listed in the path have been linked in the asset pipeline manifest or precompiled.
   paths.asset "@rails/actioncable", path: "actioncable.esm.js"
-  paths.asset "@rails/actiontext", path: "actiontext.js"
   paths.asset "@rails/activestorage", path: "activestorage.esm.js"
+  paths.asset "@rails/actiontext", path: "actiontext.js"
+  paths.asset "trix"
+
+  # Use libraries directly from JavaScript CDNs
+  # paths.asset "vue", path: "https://cdn.jsdelivr.net/npm/vue@2.6.14/dist/vue.esm.browser.js"
+  # paths.asset "d3", path: "https://cdn.skypack.dev/pin/d3@v7.0.0-03vFl9bie0TSesDkWTJV/mode=imports/optimized/d3.js"
 
-  # Make all files in directory available as my_channel => channels/my_channel-$digest.js
-  # paths.assets_in "lib/assets/javascripts/channels", append_base_path: true
+  # Map vendored modules by first adding the following to app/assets/config/manifest.js:
+  # //= link_tree ../../../vendor/assets/javascripts .js
+  # paths.assets_in "vendor/assets/javascripts"
 end
 RUBY
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails