jekyll-esm 0.2.3.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22bef330cea6f3577397e75668c97c47c4e8ae2f1da943fea23043d7b2be4972
-  data.tar.gz: e0658de21883aaf0e8ea61b3f5c42c3643a83d83167144f3f8100ff7b8a19b4b
+  metadata.gz: b01d8615804fbdbfefba76e803b0822a3362c8a326bc168e3a4524d92b9d29c8
+  data.tar.gz: 245540e681ec36358cc7aa2f4d5486309fc6cd75306d0115708503bdaad403e2
 SHA512:
-  metadata.gz: d4f7cf93956ea11783b5aab896f188306e0687855f3e7e3bc136386f5870a2f0c16022a675dd6df07ffee0ef0def5de161e65e6650deb9f3e93dfc6a74b977b2
-  data.tar.gz: ec16d8d66a36e895b9d6e5ea1b5731000ab785dbd840297940ebac3f5536c4db0e8a7e5b041e37c22f144cd16e85bc4345bf3840d0a3cf98c537951ea98f24ad
+  metadata.gz: 002a1d5b99b0807c28ac704c2932f513461383464bfe13c602f2fcb0d8a920773fa48c22a000733c9df9a8ecb03c5af22bc15e131c010c518931801c5ea162aa
+  data.tar.gz: 718f012f937426ec3fa381577509df001bee47886570a1ff93601fe85bf9e6751ad2f69f113d2e52e4abc740ccada2676d5a1a26223970519a9ddeda4e7e4592

data/.gitignore

@@ -6,6 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/fixtures/package.json
+/spec/fixtures/yarn*
 /spec/fixtures/.jekyll-cache/
 /spec/fixtures/_site/
 /spec/fixtures/dist/

data/Gemfile.lock

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

data/README.md

@@ -4,7 +4,7 @@ This plugin will allow you to define esm module definitions directly in your mar
 
 ## Why?
 
-Looks like some of the major frameworks are moving away from asset bundlers as es6 is now able to do most of it internally, which is great. Now you can simply declare your esm definitions in the markup of your templates and with this plugin Jekyll will manage the installation behind the scenes with yarn (will make the package manager configurable in a later version).
+Looks like some of the major frameworks are moving away from asset bundlers as es6 is now able to do most of it internally, which is great. Now you can simply declare your esm definitions in the markup of your templates and with this plugin Jekyll will manage the installation behind the scenes with yarn by default, but you can additionally specify npm or bower as the package manager.
 
 
 ## Installation
@@ -27,20 +27,34 @@ And add the following to your site's `_config.yml`
 
 ```yml
 plugins:
-  - jekyll/esm
+  - jekyll-esm
 ```
 
-NOTE the `/` - the `-` variant is not available yet.
+## Select a package manager
+jekyll-esm uses yarn by default but if you prefer npm or bower, its:
 
-ALSO NOTE - it's probably advisable to place this plugin as the very last one in the build pipe. EG:-
+``` yml
+# _config.yml
 
-```yml
-plugins:
-  - jekyll-otherplug
-  ...
-  - jekyll/esm
+esm:
+  manager: npm|bower
 ```
 
+# Destination folder
+Additionally you can rename the destination folder for production, so where by default it would output to _\_site/node_packages_ or _\_site/bower_components_, if you set the `dist`:
+
+_A NOTE ON NPM_ if you don't have a _package.json_ file in your root, npm will actually search in the parent folder for a _package.json_.
+
+
+``` yml
+# _config.yml
+
+esm:
+  dist: dist
+```
+
+Then all your managed packages will be available at `_site/dist`.
+
 # 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.
 

data/jekyll-esm.gemspec

@@ -1,4 +1,4 @@
-require_relative 'lib/jekyll/esm/version'
+require_relative 'lib/jekyll-esm/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-esm"

data/lib/jekyll-esm.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "jekyll-esm/version"
+require "jekyll-esm/managers/yarn"
+require "jekyll-esm/managers/npm"
+require "jekyll-esm/managers/bower"
+require "jekyll"
+require "open3"
+require 'tmpdir'
+require 'nokogiri'
+require 'json'
+
+module Jekyll
+  module Esm
+    @@existing_esm_packages = []
+    @@new_esm_packages = []
+    @@esm_ids = []
+
+    class Error < StandardError; end
+
+    def self.process(page)
+      site = page.site
+      manager = select_manager(site.config.dig('esm', 'manager'))
+      location = manager.location(site.config)
+
+      doc = Nokogiri::HTML(page.output)
+
+      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_key|
+          # ignore urls
+          next if import_key =~ /https?:\/\/[\S]+/
+          next if imports[import_key] =~ /https?:\/\/[\S]+/
+          # ignore relative paths
+          next if import_key =~ /(^\.+\/)+/
+          # ignore absolute paths
+          next if import_key =~ /^\/[\S]+/
+
+          # ignore namespaces but only if it is not scoped
+          if import_key =~ /^@[\S]+/
+            import = import_key.split('/')[0..1].join('/')
+          else
+            import = import_key.split('/').first
+          end
+
+          pkg_path = File.join(site.source, location, import)
+
+          # don't repeatedly attempt to install a package
+          next if Dir.exists?(pkg_path) && @@new_esm_packages.include?(import)
+
+          @@new_esm_packages << import
+
+          manager.add(package: import, site: site)
+
+        end
+      end
+    end
+
+    def self.select_manager(name)
+      return Managers::Npm if name == 'npm'
+      return Managers::Bower if name == 'bower'
+      return Managers::Yarn
+    end
+
+    def self.apply(site)
+      manager = select_manager(site.config.dig('esm', 'manager'))
+      location = manager.location(site.config)
+      dist = manager.dist(site.config)
+
+      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?
+          packages = for_removal.join(' ')
+          manager.remove(packages: packages, site: site)
+        end
+      end
+
+      return unless Dir.exists?(File.join(site.source, location))
+
+      FileUtils.rm_rf(File.join(site.dest, dist))
+      FileUtils.cp_r(File.join(site.source, location), File.join(site.dest, dist))
+      @@existing_esm_packages = @@new_esm_packages
+      @@new_esm_packages = []
+      @@esm_ids = []
+    end
+  end
+end
+
+
+Jekyll::Hooks.register :pages, :post_render do |page|
+  Jekyll::Esm.process(page)
+end
+
+Jekyll::Hooks.register :documents, :post_render do |page|
+  Jekyll::Esm.process(page)
+end
+
+Jekyll::Hooks.register :posts, :post_render do |page|
+  Jekyll::Esm.process(page)
+end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  Jekyll::Esm.apply(site)
+end

data/lib/jekyll-esm/managers/bower.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+
+module Jekyll
+  module Esm
+    module Managers
+      module Bower
+        class Error < StandardError; end
+
+        def self.location(config)
+          config.dig('esm', 'bower', 'dir') || 'bower_components'
+        end
+
+        def self.dist(config)
+          config.dig('esm', 'dist') || location(config) || 'bower_components'
+        end
+
+        def self.add(package:, site:)
+          stdout, stderr, status = Open3.capture3(
+            "bower install #{package}",
+            chdir: File.expand_path(site.source)
+          )
+
+          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?
+          end
+        end
+
+        def self.remove(packages:, site:)
+          stdout, stderr, status = Open3.capture3(
+            "bower uninstall #{packages}",
+            chdir: File.expand_path(site.source)
+          )
+
+          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?
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/jekyll-esm/managers/npm.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+
+module Jekyll
+  module Esm
+    module Managers
+      module Npm
+        class Error < StandardError; end
+
+        def self.location(config)
+          config.dig('esm', 'npm', 'dir') || 'node_modules'
+        end
+
+        def self.dist(config)
+          config.dig('esm', 'dist') || location(config) || 'node_modules'
+        end
+
+        def self.add(package:, site:)
+          stdout, stderr, status = Open3.capture3(
+            "npm install #{package}",
+            chdir: File.expand_path(File.join(site.source, '/'))
+          )
+
+          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?
+          end
+        end
+
+        def self.remove(packages:, site:)
+          stdout, stderr, status = Open3.capture3(
+            "npm uninstall #{packages}",
+            chdir: File.expand_path(File.join(site.source, '/'))
+          )
+
+          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?
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/jekyll-esm/managers/yarn.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+
+module Jekyll
+  module Esm
+    module Managers
+      module Yarn
+
+        def self.location(config)
+          config.dig('esm', 'yarn', 'dir') || 'node_modules'
+        end
+
+        def self.dist(config)
+          config.dig('esm', 'dist') || location(config) || 'node_modules'
+        end
+
+        def self.add(package:, site:)
+          stdout, stderr, status = Open3.capture3(
+            "yarn add #{package}",
+            chdir: File.expand_path(site.source)
+          )
+
+          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?
+          end
+        end
+
+        def self.remove(packages:, site:)
+          stdout, stderr, status = Open3.capture3(
+            "yarn remove #{packages}",
+            chdir: File.expand_path(site.source)
+          )
+
+          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?
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/{jekyll/esm → jekyll-esm}/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Esm
-    VERSION = "0.2.3.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/jekyll/esm.rb

@@ -1,107 +1,2 @@
-# frozen_string_literal: true
-
-require "jekyll/esm/version"
-require "jekyll"
-require "open3"
-require 'tmpdir'
-require 'nokogiri'
-require 'json'
-
-module Jekyll
-  module Esm
-    @@existing_esm_packages = []
-    @@new_esm_packages = []
-    @@esm_ids = []
-
-    class Error < StandardError; end
-
-    def self.process(page)
-      doc = Nokogiri::HTML(page.output)
-
-      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_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
-          next if Dir.exists?(pkg_path) && @@new_esm_packages.include?(import)
-
-          @@new_esm_packages << import
-
-          stdout, stderr, status = Open3.capture3(
-            "yarn add #{import}",
-            chdir: File.expand_path(page.site.source)
-          )
-
-          if page.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?
-          end
-        end
-      end
-    end
-
-    def self.apply(site)
-      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)
-          )
-
-          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?
-          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 = []
-      @@esm_ids = []
-    end
-  end
-end
-
-
-Jekyll::Hooks.register :pages, :post_render do |page|
-  Jekyll::Esm.process(page)
-end
-
-Jekyll::Hooks.register :documents, :post_render do |page|
-  Jekyll::Esm.process(page)
-end
-
-Jekyll::Hooks.register :posts, :post_render do |page|
-  Jekyll::Esm.process(page)
-end
-
-Jekyll::Hooks.register :site, :post_write do |site|
-  Jekyll::Esm.apply(site)
-end
+# keep support for _config plugin syntax '- jekyll/esm'
+require_relative '../jekyll-esm.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-esm
 version: !ruby/object:Gem::Version
-  version: 0.2.3.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Martin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -157,8 +157,12 @@ files:
 - bin/console
 - bin/setup
 - jekyll-esm.gemspec
+- lib/jekyll-esm.rb
+- lib/jekyll-esm/managers/bower.rb
+- lib/jekyll-esm/managers/npm.rb
+- lib/jekyll-esm/managers/yarn.rb
+- lib/jekyll-esm/version.rb
 - lib/jekyll/esm.rb
-- lib/jekyll/esm/version.rb
 - package.json
 - yarn.lock
 homepage: https://github.com/tevio/jekyll-esm