importmap-rails 0.6.2 → 0.7.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/app/helpers/importmap/importmap_tags_helper.rb +4 -4
- data/lib/importmap/commands.rb +1 -1
- data/lib/importmap/engine.rb +20 -1
- data/lib/importmap/map.rb +15 -1
- data/lib/importmap/reloader.rb +1 -1
- data/lib/importmap/version.rb +1 -1
- data/lib/install/install.rb +4 -2
- data/lib/tasks/importmap_tasks.rake +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e9e6300f655cdfdea924109ea99b791260794041dc3602d7b0a3b64d31be98ed
|
|
4
|
+
data.tar.gz: 764cb26507d540bd42c796a8c34f30c1bd632ff8e6d0edae1295c84c19db1c78
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 83d0560169e2dd9248197c90abe92734eeebeacd7e3f9db1fb530f228a0bfbfb7c02081a566911f219fddcc3732cf9e49dfcf7a18308035841291d9f703062b2
|
|
7
|
+
data.tar.gz: 1fbab54d8cb85d1e57d696d327b3ec4231a1d197840c7ecd7697bad15ca95168a9b5f2572c066d408773c1b7dddb16c0d062119567355d2d7ac8b07828f2ebdb
|
data/README.md
CHANGED
|
@@ -20,7 +20,7 @@ Note: In order to use JavaScript from Rails frameworks like Action Cable, Action
|
|
|
20
20
|
|
|
21
21
|
## Usage
|
|
22
22
|
|
|
23
|
-
The import map is setup through `Rails.application.
|
|
23
|
+
The import map is setup through `Rails.application.importmap` via the configuration in `config/importmap.rb`. This file is automatically reloaded in development upon changes, but note that you must restart the server if you remove pins and need them gone from the rendered importmap or list of preloads.
|
|
24
24
|
|
|
25
25
|
This import map is inlined in the `<head>` of your application layout using `<%= javascript_importmap_tags %>`, which will setup the JSON configuration inside a `<script type="importmap">` tag. After that, the [es-module-shim](https://github.com/guybedford/es-module-shims) is loaded, and then finally the application entrypoint is imported via `<script type="module">import "application"</script>`. That logical entrypoint, `application`, is mapped in the importmap script tag to the file `app/javascript/application.js`.
|
|
26
26
|
|
|
@@ -143,9 +143,9 @@ pin "md5", to: "https://cdn.jsdelivr.net/npm/md5@2.3.0/md5.js", preload: false
|
|
|
143
143
|
|
|
144
144
|
## Composing import maps
|
|
145
145
|
|
|
146
|
-
By default, Rails loads import map definition from the application's `config/importmap.rb` to the `Importmap::Map` object available at `Rails.application.
|
|
146
|
+
By default, Rails loads import map definition from the application's `config/importmap.rb` to the `Importmap::Map` object available at `Rails.application.importmap`.
|
|
147
147
|
|
|
148
|
-
You can combine multiple import maps by drawing their definitions onto the `Rails.application.
|
|
148
|
+
You can combine multiple import maps by drawing their definitions onto the `Rails.application.importmap`. For example, appending import maps defined in Rails engines:
|
|
149
149
|
|
|
150
150
|
```ruby
|
|
151
151
|
# my_engine/lib/my_engine/engine.rb
|
|
@@ -175,10 +175,16 @@ If you're using etags generated by Rails helpers like `stale?` or `fresh_when`,
|
|
|
175
175
|
|
|
176
176
|
```ruby
|
|
177
177
|
class ApplicationController < ActionController::Base
|
|
178
|
-
etag { Rails.application.
|
|
178
|
+
etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? }
|
|
179
179
|
end
|
|
180
180
|
```
|
|
181
181
|
|
|
182
|
+
|
|
183
|
+
## Sweeping the cache in development and test
|
|
184
|
+
|
|
185
|
+
Generating the import map json and modulepreloads may require resolving hundreds of assets. This can take a while, so these operations are cached, but in development and test, we watch for changes to both `config/importmap.rb` and files in `app/javascript` to clear this cache. This feature can be controlled in an environment configuration file via the boolean `config.importmap.sweep_cache`. If you're pinning local files from outside of `app/javascript`, you'll need to restart your development server upon changes.
|
|
186
|
+
|
|
187
|
+
|
|
182
188
|
## Expected errors from using the es-module-shim
|
|
183
189
|
|
|
184
190
|
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.
|
|
@@ -188,10 +194,12 @@ While import maps are native in Chrome and Edge, they need a shim in other brows
|
|
|
188
194
|
|
|
189
195
|
Under certain circumstances, like running system tests using chromedriver under CI (which may be resource constrained and trigger errors in certain cases), you may want to explicitly turn off including the shim. If can do this by calling the bulk tag helper with `javascript_importmap_tags("application", shim: false)`. Thus you can pass in something like `shim: !ENV["CI"]`. If you want, and are sure you're not doing any full-page caching, you can also connect this directive to a user agent check (using a gem like `useragent`) to check whether the browser is chrome/edge 89+. But you really shouldn't have to, as the shim is designed to gracefully work with natively compatible drivers.
|
|
190
196
|
|
|
197
|
+
|
|
191
198
|
## A note about browser extensions
|
|
192
199
|
|
|
193
200
|
Certain extensions that also load Javascript modules may block import maps from being loaded (for instance, the Apollo Client Devtools extension). If you see a console message like `An import map is added after module script load was triggered`, browser extensions are likely the culprit.
|
|
194
201
|
|
|
202
|
+
|
|
195
203
|
## License
|
|
196
204
|
|
|
197
205
|
Importmap for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).
|
|
@@ -11,8 +11,8 @@ module Importmap::ImportmapTagsHelper
|
|
|
11
11
|
end
|
|
12
12
|
|
|
13
13
|
# Generate an inline importmap tag using the passed `importmap_json` JSON string.
|
|
14
|
-
# By default, `Rails.application.
|
|
15
|
-
def javascript_inline_importmap_tag(importmap_json = Rails.application.
|
|
14
|
+
# By default, `Rails.application.importmap.to_json(resolver: self)` is used.
|
|
15
|
+
def javascript_inline_importmap_tag(importmap_json = Rails.application.importmap.to_json(resolver: self))
|
|
16
16
|
tag.script importmap_json.html_safe,
|
|
17
17
|
type: "importmap", "data-turbo-track": "reload", nonce: content_security_policy_nonce
|
|
18
18
|
end
|
|
@@ -39,9 +39,9 @@ module Importmap::ImportmapTagsHelper
|
|
|
39
39
|
end
|
|
40
40
|
|
|
41
41
|
# Link tags for preloading all modules marked as preload: true in the `importmap`
|
|
42
|
-
# (defaults to Rails.application.
|
|
42
|
+
# (defaults to Rails.application.importmap), such that they'll be fetched
|
|
43
43
|
# in advance by browsers supporting this link type (https://caniuse.com/?search=modulepreload).
|
|
44
|
-
def javascript_importmap_module_preload_tags(importmap = Rails.application.
|
|
44
|
+
def javascript_importmap_module_preload_tags(importmap = Rails.application.importmap)
|
|
45
45
|
javascript_module_preload_tag(*importmap.preloaded_module_paths(resolver: self))
|
|
46
46
|
end
|
|
47
47
|
|
data/lib/importmap/commands.rb
CHANGED
|
@@ -43,7 +43,7 @@ class Importmap::Commands < Thor
|
|
|
43
43
|
|
|
44
44
|
desc "json", "Show the full importmap in json"
|
|
45
45
|
def json
|
|
46
|
-
puts Rails.application.
|
|
46
|
+
puts Rails.application.importmap.to_json(resolver: ActionController::Base.helpers)
|
|
47
47
|
end
|
|
48
48
|
|
|
49
49
|
private
|
data/lib/importmap/engine.rb
CHANGED
|
@@ -1,10 +1,19 @@
|
|
|
1
1
|
require "importmap/map"
|
|
2
2
|
|
|
3
|
+
# Use Rails.application.importmap to access the map
|
|
4
|
+
Rails::Application.send(:attr_accessor, :importmap)
|
|
5
|
+
|
|
3
6
|
module Importmap
|
|
4
7
|
class Engine < ::Rails::Engine
|
|
5
|
-
config.importmap =
|
|
8
|
+
config.importmap = ActiveSupport::OrderedOptions.new
|
|
9
|
+
config.importmap.sweep_cache = Rails.env.development? || Rails.env.test?
|
|
10
|
+
|
|
6
11
|
config.autoload_once_paths = %W( #{root}/app/helpers )
|
|
7
12
|
|
|
13
|
+
initializer "importmap" do |app|
|
|
14
|
+
app.importmap = Importmap::Map.new.draw("config/importmap.rb")
|
|
15
|
+
end
|
|
16
|
+
|
|
8
17
|
initializer "importmap.reloader" do |app|
|
|
9
18
|
app.config.paths.add "config/importmap.rb"
|
|
10
19
|
|
|
@@ -15,6 +24,16 @@ module Importmap
|
|
|
15
24
|
end
|
|
16
25
|
end
|
|
17
26
|
|
|
27
|
+
initializer "importmap.cache_sweeper" do |app|
|
|
28
|
+
if app.config.importmap.sweep_cache
|
|
29
|
+
app.importmap.cache_sweeper watches: app.root.join("app/javascript")
|
|
30
|
+
|
|
31
|
+
ActiveSupport.on_load(:action_controller_base) do
|
|
32
|
+
before_action { Rails.application.importmap.cache_sweeper.execute_if_updated }
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
|
|
18
37
|
initializer "importmap.assets" do
|
|
19
38
|
if Rails.application.config.respond_to?(:assets)
|
|
20
39
|
Rails.application.config.assets.precompile += %w( es-module-shims.js )
|
data/lib/importmap/map.rb
CHANGED
|
@@ -50,12 +50,26 @@ class Importmap::Map
|
|
|
50
50
|
# Example:
|
|
51
51
|
#
|
|
52
52
|
# class ApplicationController < ActionController::Base
|
|
53
|
-
# etag { Rails.application.
|
|
53
|
+
# etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? }
|
|
54
54
|
# end
|
|
55
55
|
def digest(resolver:)
|
|
56
56
|
Digest::SHA1.hexdigest(to_json(resolver: resolver).to_s)
|
|
57
57
|
end
|
|
58
58
|
|
|
59
|
+
# Returns an instance ActiveSupport::EventedFileUpdateChecker configured to clear the cache of the map
|
|
60
|
+
# when the directories passed on initialization via `watches:` have changes. This is used in development
|
|
61
|
+
# and test to ensure the map caches are reset when javascript files are changed.
|
|
62
|
+
def cache_sweeper(watches: nil)
|
|
63
|
+
if watches
|
|
64
|
+
@cache_sweeper =
|
|
65
|
+
Rails.application.config.file_watcher.new([], Array(watches).collect { |dir| [ dir.to_s, "js"] }.to_h) do
|
|
66
|
+
clear_cache
|
|
67
|
+
end
|
|
68
|
+
else
|
|
69
|
+
@cache_sweeper
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
|
|
59
73
|
private
|
|
60
74
|
MappedDir = Struct.new(:dir, :path, :under, :preload, keyword_init: true)
|
|
61
75
|
MappedFile = Struct.new(:name, :path, :preload, keyword_init: true)
|
data/lib/importmap/reloader.rb
CHANGED
data/lib/importmap/version.rb
CHANGED
data/lib/install/install.rb
CHANGED
|
@@ -14,8 +14,10 @@ create_file Rails.root.join("app/javascript/application.js") do <<-JS
|
|
|
14
14
|
JS
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
if (sprockets_manifest_path = Rails.root.join("app/assets/config/manifest.js")).exist?
|
|
18
|
+
say "Ensure JavaScript files are in the Sprocket manifest"
|
|
19
|
+
append_to_file sprockets_manifest_path, %(//= link_tree ../../javascript .js\n)
|
|
20
|
+
end
|
|
19
21
|
|
|
20
22
|
say "Configure importmap paths in config/importmap.rb"
|
|
21
23
|
copy_file "#{__dir__}/config/importmap.rb", "config/importmap.rb"
|
|
@@ -7,6 +7,6 @@ namespace :importmap do
|
|
|
7
7
|
desc "Show the importmap"
|
|
8
8
|
task :pins do
|
|
9
9
|
require Rails.root.join("config/environment")
|
|
10
|
-
puts Rails.application.
|
|
10
|
+
puts Rails.application.importmap.to_json(resolver: ActionController::Base.helpers)
|
|
11
11
|
end
|
|
12
12
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: importmap-rails
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.7.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- David Heinemeier Hansson
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-09-
|
|
11
|
+
date: 2021-09-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rails
|