jekyll-compress-flow 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c00c4a18a5ad58211bbaee01455e9973f9e238ce9795e426435405e9caf0ad
-  data.tar.gz: de0178bae5907891dff7f0eb65337df6333b958a5108f1e4f138f229c3776300
+  metadata.gz: 7698a216c6b11cc78eb4dbf1fc8642b3b76e41dcb93a3f0f6e72ed939207a9ab
+  data.tar.gz: 50876d915cc373992f28fff651357c468bd9306e9651e7a280ec7e81a531825d
 SHA512:
-  metadata.gz: 98e314c5f525eea612d4c04301c1bbe81fea6e9355820d4c348b60bde68d9d3deb6eee7e1ebdc344da1b316ecccd3cbaab725f9a720505abb3856d764c4ecfc5
-  data.tar.gz: 1dbad2fcdde09b6b07c49b4d6652ea10fa49e7cbdd368ff6bb20c75cd3b0e62dd9869e5d5cd13086cefe1af6eb5de543af0bb3bc69f5a280b8c2315134703685
+  metadata.gz: 7f862ea2ee85d52f9b58e8abb5b79808cca7ec951c69fb1ab80fd3a81085292e3084e9ac7ddef365ebad1fdc75971905600adeab6f2a341d2425c3d5aacd9e1d
+  data.tar.gz: 7a750ebe879c078a28224ae84d3ec738f273b567c562f3a78face1625ce5b005b78d23b37119731a85c13f34a1f36536472d28f884b4af2a52ba13cfa89ad5a1

data/CHANGELOG.md

@@ -4,6 +4,46 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## 0.2.2 — 2026-11-10
+
+### Added
+
+- `rake docs:demo` — captures the checked-in illustrative overview as
+  animated AVIF + WebP + static PNG (headless Chrome + ffmpeg + img2webp;
+  build-host tools), embedded in README via `<picture>`. Examples are
+  schematic, not generated from a live Jekyll build.
+
+### Changed
+
+- CI: Semgrep moved from an inline `pip3 install` pin to the pinned
+  `semgrep/semgrep` container image (tag + sha256 digest). Image bumped
+  to 1.182.1 (certificate trust fix for the eMudhra CA compromise).
+  CI Node bumped from 24 to 26 (Active LTS "Lithium" since 2026-10-28).
+- CI: `sonarqube-scan-action` bumped to v8.4.0; `markdownlint-cli2`
+  bumped to 0.24.0; `ruby/setup-ruby` v1.335.0 → v1.338.0; in-range
+  gem updates (rubocop 1.92.2, parser 3.3.13.0, addressable 2.9.2,
+  csv 3.3.7, sass-embedded 1.108.1, rspec-* 3.13.x patches);
+  `BUNDLED WITH` 4.0.23 → 4.0.24.
+- CI: Ruby 4.0 added to the test matrix (latest stable major;
+  `required_ruby_version >= 3.3.0` already permits it).
+- Gemspec `description` rewritten as an RDoc `==`-headed blurb so
+  rubygems.org renders it as markup instead of a single plain paragraph.
+
+## 0.2.1 — 2026-10-06
+
+### Added
+
+- `Jekyll::CompressFlow::Interface.to_h` — the config surface
+  (`compress_flow` keys plus `formats:`/`priority:` enums) derived from
+  `DEFAULTS`, serialized to a committed `interface.yml` by
+  `rake interface`; `interface_spec.rb` pins manifest freshness.
+
+### Changed
+
+- Register the compression dispatcher at low priority (10) by default, after
+  normal-priority processing and Fingerprint Flow (default 12); allow per-site
+  `compress_flow.priority` values from 0 through 10.
+
 ## 0.2.0 — 2026-10-03
 
 ### Added

data/README.md

@@ -25,6 +25,19 @@ simply happens at build time instead of request time.
 
 [Compare different formats](https://speedvitals.com/blog/zstd-vs-brotli-vs-gzip/)
 
+<!-- markdownlint-disable MD033 -->
+<picture>
+  <source
+    srcset="docs/assets/jekyll-compress-flow-demo.avif"
+    type="image/avif">
+  <source
+    srcset="docs/assets/jekyll-compress-flow-demo.webp"
+    type="image/webp">
+  <img src="docs/assets/jekyll-compress-flow-demo.png"
+       alt="jekyll-compress-flow demo">
+</picture>
+<!-- markdownlint-enable MD033 -->
+
 ## Prerequisites
 
 The plugin shells out to the platform compressor CLIs — install them on
@@ -32,7 +45,7 @@ the **build host** (not the web server; visitors need nothing):
 
 | Tool | Generates | Minimum | Tested baseline |
 | ---- | --------- | ------- | --------------- |
-| `brotli` | `.br` | 1.1.0 | 1.2.0 (macOS) |
+| `brotli` | `.br` | 1.1.0 | 1.2.1 (macOS) |
 | `zstd` | `.zst` | 1.5.5 | 1.5.7 (macOS) |
 | `gzip` | `.gz` | any | preinstalled on macOS/Linux; ships with Git for Windows |
 
@@ -124,16 +137,22 @@ configured to negotiate them via `Accept-Encoding`:
 ```yaml
 compress_flow:
   enabled: true            # default: Jekyll.env == "production"
+  priority: 10             # integer 0..10; default 10, after fingerprinting
   formats: [br, zst, gz]   # subset of the three; unknown names abort
   extensions: [html, css, js, json, xml, svg, txt, map]
   min_size: 0              # bytes — skip tiny files
   fail_on_error: true      # false: warn + skip instead of failing build
 ```
 
+The post-write dispatcher accepts integer priorities from 0 through 10 so
+site-specific compression remains after the default Fingerprint Flow range
+(11–19).
+
 ## Behavior
 
-- Runs on `:site, :post_write`, after every file is written — works
-  with any generator (pages, posts, feeds, sitemap, search JSON).
+- Runs on `:site, :post_write` at low priority (10), after normal-priority
+  post-processors and the priority-12 Fingerprint Flow pass — works with any
+  generator (pages, posts, feeds, sitemap, search JSON).
 - Compressed siblings are never re-compressed (extensions not in the
   list); images/fonts/PDFs are skipped (already compressed formats).
 - A missing CLI tool aborts the build once per format

data/interface.yml

@@ -0,0 +1,20 @@
+# Generated by `rake interface` — do not edit.
+# Public tag/config surface for tooling (editor extensions, doc linters).
+---
+gem: jekyll-compress-flow
+version: 0.2.2
+tags: {}
+filters: []
+config:
+  compress_flow:
+  - enabled
+  - extensions
+  - fail_on_error
+  - formats
+  - min_size
+  - priority
+enums:
+  formats:
+  - br
+  - gz
+  - zst

data/lib/jekyll/compress_flow/interface.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module CompressFlow
+    # Machine-readable description of the plugin's public interface:
+    # config keys and enum values (this plugin registers no Liquid tags).
+    # `rake interface` writes this as interface.yml (shipped in the gem) so
+    # tooling like editor extensions can consume it without parsing Ruby.
+    module Interface
+      def self.to_h
+        {
+          "gem" => "jekyll-compress-flow",
+          "version" => VERSION,
+          "tags" => {},
+          "filters" => [],
+          "config" => { "compress_flow" => DEFAULTS.keys.sort },
+          "enums" => { "formats" => FORMATS.keys.sort }
+        }
+      end
+    end
+  end
+end

data/lib/jekyll/compress_flow/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module CompressFlow
-    VERSION = "0.2.0"
+    VERSION = "0.2.2"
   end
 end

data/lib/jekyll/compress_flow.rb

@@ -4,6 +4,7 @@ require "jekyll"
 require "open3"
 
 require_relative "compress_flow/version"
+require_relative "compress_flow/interface"
 
 module Jekyll
   # Generates .br/.zst/.gz siblings for text assets in the build output so a
@@ -23,8 +24,11 @@ module Jekyll
       "gz" => { "tool" => "gzip", "args" => %w[-f -9 -k] }
     }.freeze
 
+    DEFAULT_POST_WRITE_PRIORITY = 10
+    POST_WRITE_PRIORITIES = (0..DEFAULT_POST_WRITE_PRIORITY)
     DEFAULTS = {
       "enabled" => nil, # nil => Jekyll.env == "production"
+      "priority" => DEFAULT_POST_WRITE_PRIORITY,
       "extensions" => %w[html css js json xml svg txt map],
       "formats" => %w[br zst gz],
       "min_size" => 0,
@@ -33,6 +37,14 @@ module Jekyll
 
     module_function
 
+    def post_write_priority(config)
+      priority = config.transform_keys(&:to_s).fetch("priority", DEFAULT_POST_WRITE_PRIORITY)
+      return priority if priority.is_a?(Integer) && POST_WRITE_PRIORITIES.cover?(priority)
+
+      raise Jekyll::Errors::FatalException,
+            "CompressFlow: compress_flow.priority must be an integer from 0 through 10"
+    end
+
     # Entry point — compress all matching files under +dest+.
     # +config+ is the site's `compress_flow:` mapping (string or symbol keys).
     def run(dest, config = {})
@@ -87,6 +99,9 @@ module Jekyll
     end
 
     def compress(file, format, cfg)
+      # Array-form system(): no shell — tool/args are literals from the frozen
+      # FORMATS table; file is a data argument globbed under the build dest.
+      # nosemgrep: ruby.lang.security.dangerous-exec.dangerous-exec
       ok = system(format["tool"], *format["args"], file, out: File::NULL, err: File::NULL)
       fail_or_warn(cfg, "#{format['tool']} failed on #{file}") unless ok
     end
@@ -95,6 +110,8 @@ module Jekyll
     # banner could not be parsed (or no pattern is defined — e.g. Apple gzip
     # vs GNU gzip use incomparable version strings), nil when not installed.
     def tool_version(tool, pattern)
+      # Array-form capture2e: no shell — tool is a literal from frozen FORMATS.
+      # nosemgrep: ruby.lang.security.dangerous-exec.dangerous-exec
       out, status = Open3.capture2e(tool, "--version")
       return nil unless status.success?
       return :unversioned unless pattern && (match = out.match(pattern))
@@ -114,6 +131,12 @@ module Jekyll
   end
 end
 
-Jekyll::Hooks.register :site, :post_write do |site|
-  Jekyll::CompressFlow.run(site.dest, site.config["compress_flow"] || {})
+Jekyll::CompressFlow::POST_WRITE_PRIORITIES.each do |hook_priority|
+  registered_priority = hook_priority
+  Jekyll::Hooks.register :site, :post_write, priority: registered_priority do |site|
+    config = site.config["compress_flow"] || {}
+    next unless Jekyll::CompressFlow.post_write_priority(config) == registered_priority
+
+    Jekyll::CompressFlow.run(site.dest, config)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-compress-flow
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Svend Gundestrup
@@ -29,10 +29,13 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: A Jekyll plugin that writes Brotli, Zstandard and gzip siblings next
-  to text assets at the end of a build, so a precompressed-capable static server (e.g.
-  Caddy's file_server precompressed) can serve them without per-request compression
-  CPU.
+description: |
+  == Precompressed siblings for Jekyll output
+
+  Writes .br, .zst and .gz siblings next to text assets at the end of a
+  build, so a precompressed-capable static server (for example Caddy's
+  file_server precompressed) can serve them without per-request
+  compression CPU.
 email:
 - svend@gundestrup.dk
 executables: []
@@ -42,8 +45,10 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- interface.yml
 - lib/jekyll-compress-flow.rb
 - lib/jekyll/compress_flow.rb
+- lib/jekyll/compress_flow/interface.rb
 - lib/jekyll/compress_flow/version.rb
 homepage: https://github.com/gundestrup/jekyll-compress-flow
 licenses: