jekyll-esm 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a0c78f818f77fd849f9607aaafb450596ecf19cfc734a1e6c94a261ced383d3
-  data.tar.gz: 0312d0bc24f988fe6aca12f7a06f46cb66fb8b42e8a19d4e1b964a0b0749f8e3
+  metadata.gz: a2fc1ecabf3be2949cece5c1bb60e7285fd273da8b8bbce30f2bf2f28d2117ed
+  data.tar.gz: 03021cb0dcfe320ff0861f1d2ffdf44cc2f839827d1c9b7812fce47511f6f737
 SHA512:
-  metadata.gz: de5aa84406b28865a4187efdbe990a5064a435980fd28480048d0adda66e5ecad7c0d4d7fb94b4c585b81ad37379ee8357a10e20d785f1b3fd6dc67b1a7367e5
-  data.tar.gz: 9960ff7fb28d4af09c00bdacdb515002362beeec21c9c8381ceab90df4f69c786363b2afa464f0cab82e2c79a2d09aa7ed9abf5794bbb47f7087c02289932e30
+  metadata.gz: 91ea6cf5552e9d4e888229cd5b47c53e1317985f99fcfa4b14893eb2a08d3eeedff0665e35ff2cb0ad10e6479e4109183f17bce81bdc0de4640fd66e3d58de78
+  data.tar.gz: a755d7b58b87571896041a2f095014bb360077663c68c4f70038dbf76a54ed67858ebeac2214f54b48722a19a16560ffce7c45d5441e77f68fd8dade5a4e8768

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-esm (0.0.3)
+    jekyll-esm (0.2.2)
       jekyll
       listen
       nokogiri

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Steve Martin
+Copyright (c) 2021 Steve Martin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -41,9 +41,42 @@ plugins:
   - jekyll/esm
 ```
 
+# Ignore package.json!
+Currently You *MUST* exclude package.json in the `_config.yml` otherwise jekyll will go into a loop. Sucks a bit but will try and improve that.
+
+```yml
+exclude:
+  - package.json
+```
+
+## Optimizing
+### Strict mode
+You can run in strict mode to increase logging verbosity from the js package manager.
+
+``` yml
+# _config.yml
+
+esm:
+  strict: true
+```
+
+### data-esm-id attribute
+You can set this on a declaration to prevent Jekyll from processing it more than once (eg, if you have lots of compiled pages, with the same layout, you don't want to run it more than once per importmap declaration):-
+
+``` html
+    <script data-esm-id='1' type="importmap">
+      {
+        "imports": {
+          "/src/index.js": "/src/index.js"
+        }
+      }
+    </script>
+
+If you have multiple importmap declarations with different values, set a different id for each one, or no id at all, but no id is less speed efficient, as jekyll will process them each time for every page.
+
 ### Example `_config.yml`
-You can have a look at the possible configuration options in the fixtures config file at `spec/fixtures/_config.yml` in this repo.
 
+You can have a look at the possible configuration options in the fixtures config file at `spec/fixtures/_config.yml` in this repo.
 
 ## Development
 

data/lib/jekyll/esm.rb

@@ -11,6 +11,7 @@ module Jekyll
   module Esm
     @@existing_esm_packages = []
     @@new_esm_packages = []
+    @@esm_ids = []
 
     class Error < StandardError; end
 
@@ -20,13 +21,27 @@ module Jekyll
       import_maps = doc.search('script[type=importmap]')
 
       import_maps.each do |value|
+        esm_id = value.attributes["data-esm-id"]&.value
+        # declare a data-esm-id so that jekyll will only process an esm declaration once
+        next if @@esm_ids.include?(esm_id)
+        @@esm_ids << esm_id if esm_id
+
         importmap = JSON.parse(value.children[0].content)
         imports = importmap["imports"]
-        imports.keys.each do |import|
+        imports.keys.each do |import_key|
+          # ignore urls
+          next if import_key =~ /https?:\/\/[\S]+/
+          # ignore relative paths
+          next if import_key =~ /(^\.+\/)+/
+          # ignore absolute paths
+          next if import_key =~ /^\/[\S]+/
+
+          # ignore namespaces
+          import = import_key.split('/').first
           pkg_path = File.join(page.site.source, 'node_modules', import)
 
           # don't repeatedly attempt to install a package
-          return if Dir.exists?(pkg_path) && @@new_esm_packages.include?(import)
+          next if Dir.exists?(pkg_path) && @@new_esm_packages.include?(import)
 
           @@new_esm_packages << import
 
@@ -46,25 +61,28 @@ module Jekyll
     end
 
     def self.apply(site)
-      existing_packages = Dir.children(File.join(site.source, 'node_modules')).reject { |dir| dir =~ /^\..*$/ }
-      for_removal = existing_packages - @@new_esm_packages.uniq
+      if @@existing_esm_packages.any?
+        for_removal = @@existing_esm_packages - @@new_esm_packages.uniq
 
-      # Remove any packages that are no longer referenced in an esm declaration
-      if for_removal.any?
-        stdout, stderr, status = Open3.capture3(
-          "yarn remove #{for_removal.join(' ')}",
-          chdir: File.expand_path(site.source)
-        )
+        # Remove any packages that are no longer referenced in an esm declaration
+        if for_removal.any?
+          stdout, stderr, status = Open3.capture3(
+            "yarn remove #{for_removal.join(' ')}",
+            chdir: File.expand_path(site.source)
+          )
 
-        if site.config.dig('esm', 'strict')
-          runtime_error = stdout =~ /ERROR in|SyntaxError/
+          if site.config.dig('esm', 'strict')
+            runtime_error = stdout =~ /ERROR in|SyntaxError/
 
-          raise Error, stderr if stderr.size > 0
-          raise Error, stdout if !runtime_error.nil?
+            raise Error, stderr if stderr.size > 0
+            raise Error, stdout if !runtime_error.nil?
+          end
         end
       end
 
+      FileUtils.rm_rf(File.join(site.dest, 'node_modules'))
       FileUtils.cp_r(File.join(site.source, 'node_modules'), File.join(site.dest, 'node_modules'))
+      @@existing_esm_packages = @@new_esm_packages
       @@new_esm_packages = []
     end
   end

data/lib/jekyll/esm/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Esm
-    VERSION = "0.1.0"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-esm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Steve Martin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll