jekyll-webpack 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607c1063222b8746e6e1a90de9a5272e41895beba7672c72e8b9742823593412
-  data.tar.gz: e141cb8fcb480ef152b731554ba4fef8cee98bf8b4263f4f7d0a4ccc06630cfc
+  metadata.gz: 523320aff087db3fb6bb6ef7961dec12a000f28f626515077778b12481a3258e
+  data.tar.gz: 03f8df4951e4b92f3077025355768197cbb25b07358310da8a62af229410c696
 SHA512:
-  metadata.gz: cf664c9e5c38e781ab700c92aa725ed93b74dd62d7fa5fcf94cfb2211e9b8595bfe19d4dd1ff4252d13bd1310dd0dd8711db9cf006c5ba6939944aae89c12fd9
-  data.tar.gz: 04fc1d4d20fa4ed5290a596658e56a70e2873cbd6f8f0abf2740ff964960b547c2803aeea277139cbfd945843b312442e20fa47f20df8460293b055255802fd7
+  metadata.gz: 46ec0bef97d2f23abec854b252de1c8912762769dba87ecc8cdfe3612c5f7d3676a3a301cfe7b755d5137bec9911a4e2d9f269ead92c5651b8969e9ac4789f8c
+  data.tar.gz: 89943a448286163b31ca3846ace76eb7dd85b97b2e768e4818ec17952f4aeb337b8fc4261c411d36633dde7b13d4f0a10930b0ad5c610a661d0d0aa244b7549d

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    jekyll-webpack (0.2.3)
+    jekyll-webpack (0.2.5)
       jekyll
+      listen
 
 GEM
   remote: https://rubygems.org/

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.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)
@@ -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

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.6"
   end
 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.6
 platform: ruby
 authors:
 - Steve Martin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-07-30 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: