jekyll-webpack 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607c1063222b8746e6e1a90de9a5272e41895beba7672c72e8b9742823593412
-  data.tar.gz: e141cb8fcb480ef152b731554ba4fef8cee98bf8b4263f4f7d0a4ccc06630cfc
+  metadata.gz: 9e283de4d72f04e0ac364a5f0c5756a45aedfcbbbdec766629cd2bc329acbd03
+  data.tar.gz: 6e729e813d0b960a4b3f29187c891d28e3f5add025f9385364c57a33241dd39e
 SHA512:
-  metadata.gz: cf664c9e5c38e781ab700c92aa725ed93b74dd62d7fa5fcf94cfb2211e9b8595bfe19d4dd1ff4252d13bd1310dd0dd8711db9cf006c5ba6939944aae89c12fd9
-  data.tar.gz: 04fc1d4d20fa4ed5290a596658e56a70e2873cbd6f8f0abf2740ff964960b547c2803aeea277139cbfd945843b312442e20fa47f20df8460293b055255802fd7
+  metadata.gz: 7221b24f125a01643575a8911ce2d126b314482a97a71c82db69f9faad9f842ff6d52df6645f872ef812afebff570ad6cf84a0307114f35dbba972fc7d573c4f
+  data.tar.gz: 9625df1e171146aabde6a70972c2947a9fbf84cc67dc6b24a7fba9ffa0966f9bea08704e51d27f8749af5c60b10fae4e60ec54c738e72a631de0017d875dafb7

data/.gitignore

@@ -15,3 +15,4 @@
 # rspec failure tracking
 .rspec_status
 tags
+.ruby-version

data/Gemfile.lock

@@ -1,26 +1,28 @@
 PATH
   remote: .
   specs:
-    jekyll-webpack (0.2.3)
+    jekyll-webpack (0.2.7)
       jekyll
+      listen
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
     coderay (1.1.3)
     colorator (1.1.0)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    em-websocket (0.5.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
+      http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.15.3)
-    formatador (0.3.0)
+    ffi (1.16.3)
+    formatador (1.1.0)
     forwardable-extended (2.6.0)
-    guard (2.18.0)
+    google-protobuf (3.25.1-arm64-darwin)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -34,37 +36,38 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    http_parser.rb (0.6.0)
-    i18n (1.8.10)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jekyll (4.2.0)
+    jekyll (4.3.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
       i18n (~> 1.0)
-      jekyll-sass-converter (~> 2.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 2.3)
+      kramdown (~> 2.3, >= 2.3.1)
       kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.4.0)
+      mercenary (>= 0.3.6, < 0.5)
       pathutil (~> 0.9)
-      rouge (~> 3.0)
+      rouge (>= 3.0, < 5.0)
       safe_yaml (~> 1.0)
-      terminal-table (~> 2.0)
-    jekyll-sass-converter (2.1.0)
-      sassc (> 2.0.1, < 3.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    liquid (4.0.3)
-    listen (3.5.1)
+    liquid (4.0.4)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
+    lumberjack (1.2.10)
     mercenary (0.4.0)
     method_source (1.0.0)
     nenv (0.3.0)
@@ -73,40 +76,41 @@ GEM
       shellany (~> 0.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
+    public_suffix (5.0.4)
     rake (12.3.3)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.5)
-    rouge (3.26.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rexml (3.2.6)
+    rouge (4.2.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
     safe_yaml (1.0.5)
-    sassc (2.4.0)
-      ffi (~> 1.9)
+    sass-embedded (1.69.5-arm64-darwin)
+      google-protobuf (~> 3.23)
     shellany (0.0.1)
-    terminal-table (2.0.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (1.1.0)
-    unicode-display_width (1.7.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
   bundler
@@ -118,4 +122,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.2.3
+   2.3.26

data/README.md

@@ -57,6 +57,35 @@ And you're away! Just run the `jekyll serve` or `jekyll build` commands with wha
 
 There is a `_data/tailwind.yml` file in the fixure site that's picked up by adding a frontmatter declaration in `tailwind.config.js`. This Tailwind config is in turn picked up by the outputted webpack config and parsed when webpack runs.
 
+### Debouncing Webpack runs
+Sometimes the webpack build can take a long time. You can configure jekyll-webpack to debounce the build in a number of ways. The options are:-
+
+  - run once (when you first run `serve`)
+  - run every n iterations (specify a number of iterations to skip webpack compilation)
+  - run on watch folder changes (specific a folder to watch and only run webpack when a file in the folder has changed)
+
+Add the following entries into `_config.yml`
+
+``` yml
+// _config.yml
+
+webpack:
+  debounce:
+    run_once: true
+
+// or ...
+webpack:
+  debounce:
+    every: 10
+
+// or ...
+webpack:
+  debounce:
+    watch: src
+```
+
+This is very useful if you plan to use `jekyll serve` with the `--livereload` option as it can speed up your development time significantly.
+
 ### Cleanup
 If you wish to clean out unused source files after webpack has run that got included in the compiled site, you need to add an entry into your `_config.yml` like:
 

data/jekyll-webpack.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "jekyll"
+  spec.add_dependency "listen"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "pry"

data/lib/jekyll/webpack/debouncer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'listen'
+
+module Jekyll
+  module Webpack
+    class Debouncer
+      attr_reader :site, :dist_path, :config, :run_once, :has_run, :run_every_n, :watch_nodes, :listener
+
+      def initialize(site, debounce_config)
+        @config = debounce_config
+        @run_once = debounce_config.dig('run_once')
+        @run_every_n = debounce_config.dig('every')
+        @watch_nodes = debounce_config.dig('watch')
+
+        if @watch_nodes
+          if Array === @watch_nodes
+            watch_paths = @watch_nodes.map { |file| File.join(site.source, file) }
+          else
+            watch_paths = [@watch_nodes]
+          end
+
+          @listener = Listen.to(*watch_paths) do |modified, added, removed|
+            @has_run = false
+          end
+          @listener.start
+        end
+
+        @run_counter = 0
+        @has_run = false
+        @site = site
+        @dist_tmpdir = Dir.mktmpdir("jekyll_webpack_dist_#{File.split(site.dest).last}")
+        @dist_path = File.expand_path('dist', site.dest)
+      end
+
+      def build
+        if run_once || watch_nodes
+          if has_run
+            restore_dist
+          else
+            yield
+            extract_dist
+          end
+        elsif run_every_n
+          if !has_run
+            yield
+            @run_counter += 1
+            extract_dist
+          elsif run_every_n == @run_counter
+            yield
+            @run_counter = 0
+            extract_dist
+          else
+            restore_dist
+            @run_counter += 1
+          end
+        end
+
+        @has_run = true
+      end
+
+      def extract_dist
+        FileUtils.cp_r(dist_path, @dist_tmpdir)
+      end
+
+      def restore_dist
+        FileUtils.cp_r(File.join(@dist_tmpdir, 'dist'), File.join(site.dest, 'dist'))
+      end
+    end
+  end
+end

data/lib/jekyll/webpack/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Webpack
-    VERSION = "0.2.5"
+    VERSION = "0.2.7"
   end
 end

data/lib/jekyll/webpack.rb

@@ -3,21 +3,40 @@
 require "jekyll/webpack/version"
 require "jekyll"
 require "open3"
+require 'tmpdir'
+require 'jekyll/webpack/debouncer'
 
 module Jekyll
   module Webpack
+
+    @@webpack_debouncers = {}
+
     class Error < StandardError; end
 
     def self.build(site)
+      only_in = site.config.dig('webpack', 'only_in')
+      debounce = site.config.dig('webpack', 'debounce')
+
       site_dest = site.dest
+      webpack_dist_path = File.expand_path('dist', site.dest)
 
-      only_in = site.config.dig('webpack', 'only_in')
       if only_in
         entries = []
         array_or_scalar(only_in) { |entry| entries << site_dest.end_with?(entry) }
         return unless entries.any? true
       end
 
+      if debounce
+        @@webpack_debouncers[site.dest] = Debouncer.new(site, debounce) unless @@webpack_debouncers[site.dest]
+        @@webpack_debouncers[site.dest].build { webpack_exec(site_dest) }
+      else
+        webpack_exec(site_dest)
+      end
+
+      cleanup(site)
+    end
+
+    def self.webpack_exec(site_dest)
       stdout, stderr, status = Open3.capture3(
         "../node_modules/.bin/webpack",
         chdir: File.expand_path(site_dest)
@@ -27,8 +46,6 @@ module Jekyll
 
       raise Error, stderr if stderr.size > 0
       raise Error, stdout if !runtime_error.nil?
-
-      cleanup(site)
     end
 
     def self.cleanup(site)
@@ -38,7 +55,7 @@ module Jekyll
         array_or_scalar(cleanup_files) do |dest_for_clean|
           path = File.expand_path(dest_for_clean, site.dest)
 
-          if File.exists?(path) || Dir.exists?(path)
+          if File.exist?(path) || Dir.exist?(path)
             FileUtils.rm_rf(path)
           end
         end
@@ -59,6 +76,11 @@ module Jekyll
   end
 end
 
+
+# Jekyll::Hooks.register :site, :after_init do |site|
+#     Jekyll::Webpack.extract_dist(site)
+# end
+
 Jekyll::Hooks.register :site, :post_write do |site|
-  Jekyll::Webpack.build(site)
+    Jekyll::Webpack.build(site)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webpack
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Steve Martin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,7 @@ files:
 - bin/setup
 - jekyll-webpack.gemspec
 - lib/jekyll/webpack.rb
+- lib/jekyll/webpack/debouncer.rb
 - lib/jekyll/webpack/version.rb
 homepage: https://github.com/tevio/jekyll-webpack
 licenses:
@@ -152,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Compile assets with webpack