jekyll-webpack 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c5233173b8791e6f83c7100e4b380dfaf8259fdae3eaf66f3f831171134366
-  data.tar.gz: 7bdb9622f488ed193845a69b890b370d227c7fba80809c98457ee8bad1be439f
+  metadata.gz: 607c1063222b8746e6e1a90de9a5272e41895beba7672c72e8b9742823593412
+  data.tar.gz: e141cb8fcb480ef152b731554ba4fef8cee98bf8b4263f4f7d0a4ccc06630cfc
 SHA512:
-  metadata.gz: aaa0d5e50719f8f6a02bae898b387c523c03cadfa0ecc8a65427e7126d6fe63489adc80db671594fad9e399f6948470a75c00a3d882294aef1a8c85a04064165
-  data.tar.gz: 3008679b55ce6a5fb8283e51b2077f4117e508c87688d01506484c43f992cf8df062a45e9bf8f52eb523bc285d8eebf244fa75309e1aabeb77d45e5465d2765a
+  metadata.gz: cf664c9e5c38e781ab700c92aa725ed93b74dd62d7fa5fcf94cfb2211e9b8595bfe19d4dd1ff4252d13bd1310dd0dd8711db9cf006c5ba6939944aae89c12fd9
+  data.tar.gz: 04fc1d4d20fa4ed5290a596658e56a70e2873cbd6f8f0abf2740ff964960b547c2803aeea277139cbfd945843b312442e20fa47f20df8460293b055255802fd7

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 /spec/fixtures/.jekyll-cache/
 /spec/fixtures/_site/
+/spec/fixtures/dist/
 /spec/fixtures/node_modules/
 /*.gem
 

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    jekyll-webpack (0.2.1)
+    jekyll-webpack (0.2.3)
       jekyll
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
     colorator (1.1.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    em-websocket (0.5.1)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    em-websocket (0.5.2)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
-    ffi (1.13.0)
-    formatador (0.2.5)
+    ffi (1.15.3)
+    formatador (0.3.0)
     forwardable-extended (2.6.0)
-    guard (2.16.2)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -35,36 +35,36 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     http_parser.rb (0.6.0)
-    i18n (1.8.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jekyll (4.1.0)
+    jekyll (4.2.0)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
       i18n (~> 1.0)
       jekyll-sass-converter (~> 2.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 2.1)
+      kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
       mercenary (~> 0.4.0)
       pathutil (~> 0.9)
       rouge (~> 3.0)
       safe_yaml (~> 1.0)
-      terminal-table (~> 1.8)
+      terminal-table (~> 2.0)
     jekyll-sass-converter (2.1.0)
       sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.2.1)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.3)
-    listen (3.2.1)
+    listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.5)
+    lumberjack (1.2.8)
     mercenary (0.4.0)
     method_source (1.0.0)
     nenv (0.3.0)
@@ -73,36 +73,36 @@ GEM
       shellany (~> 0.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.4)
-    rouge (3.19.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     safe_yaml (1.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
     shellany (0.0.1)
-    terminal-table (1.8.0)
+    terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (1.0.1)
+    thor (1.1.0)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -118,4 +118,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.3
+   2.2.3

data/README.md

@@ -6,8 +6,6 @@ This plugin will allow you to build your assets with Webpack _after_ Jekyll has
 
 This adds Webpack at a sane point in the build pipeline and will also allow you to parameterize your webpack and other JS config files by prepending them with front matter, before the compilation occurs. You can see a functioning example in the `spec/fixtures` folder:-
 
-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.
-
 
 ## Installation
 
@@ -32,13 +30,16 @@ plugins:
   - jekyll/webpack
 ```
 
-Now install webpack, I use `yarn`
-
-`yarn add webpack webpack-cli --dev`
+NOTE the `/` - the `-` variant is not available yet.
 
-And the basic JS entrypoint `mkdir src && touch src/index.js`
+ALSO NOTE - it's probably advisable to place this plugin as the very last one in the build pipe. EG:-
 
-And you're away!
+```yml
+plugins:
+  - jekyll-otherplug
+  ...
+  - jekyll/webpack
+```
 
 ## Usage
 
@@ -46,6 +47,53 @@ In your root Jekyll project folder you need to have Webpack installed, so:-
 
 `yarn add webpack webpack-cli --dev`
 
+And the basic JS entrypoint `mkdir src && touch src/index.js`
+
+And you're away! Just run the `jekyll serve` or `jekyll build` commands with whatever env you need.
+
+## Config
+
+### Configuring JS config files
+
+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.
+
+### 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:
+
+``` yml
+// _config.yml
+
+webpack:
+  cleanup_files: src
+
+// or an array
+
+webpack:
+  cleanup_files:
+    - src
+    - node_modules
+```
+
+### Dest inclusion (excluding
+If want to ensure that webpack only runs in a specific site dest (eg `_site` only, and no subdirectories) you can pass a single path value or an inclusion list of paths you want webpack to run in, at config time, by modifiying the `_config.yml` like so:
+
+``` yml
+// _config.yml
+
+webpack:
+  only_in: _site
+
+// or as a list
+webpack:
+  only_in:
+    - _site
+    - _build
+```
+
+### 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.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then `cd spec/fixtures && yarn` to install required JS dependencies for specs. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/jekyll/webpack.rb

@@ -11,6 +11,13 @@ module Jekyll
     def self.build(site)
       site_dest = 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
+
       stdout, stderr, status = Open3.capture3(
         "../node_modules/.bin/webpack",
         chdir: File.expand_path(site_dest)
@@ -20,6 +27,34 @@ module Jekyll
 
       raise Error, stderr if stderr.size > 0
       raise Error, stdout if !runtime_error.nil?
+
+      cleanup(site)
+    end
+
+    def self.cleanup(site)
+      cleanup_files = site.config.dig('webpack', 'cleanup_files')
+
+      if cleanup_files
+        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)
+            FileUtils.rm_rf(path)
+          end
+        end
+      end
+    end
+
+    private
+
+    def self.array_or_scalar(value)
+      if Array === value
+        value.each do |entry|
+          yield entry
+        end
+      else
+        yield value
+      end
     end
   end
 end

data/lib/jekyll/webpack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webpack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Steve Martin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -137,7 +137,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tevio/jekyll-webpack
   source_code_uri: https://github.com/mml/jekyll-webpack
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Compile assets with webpack
 test_files: []