jekyll-minify-js 0.1.1 → 0.2.11

data/lib/jekyll-minify-js.rb

@@ -1,109 +1,134 @@
 # frozen_string_literal: true
 
-require 'jekyll'
-require 'fileutils'
-require 'shellwords'
-begin
-  require 'terser'
-rescue LoadError
-  # terser gem not available; plugin will fallback to external CLI or copy
-end
-require 'pathname'
+require "jekyll"
+require "json"
+require "open3"
+require "pathname"
+
+require_relative "version"
 
-# module Jekyll
 module Jekyll
-  # MinifyJs is a Jekyll `Generator` that minifies JavaScript files found under
-  # common asset directories. It prefers the `terser` Ruby gem when available
-  # and falls back to an external `terser` CLI when necessary.
-  class MinifyJs < Generator
-    safe true
-    priority :low
+  # Minifies JavaScript assets after Jekyll finishes writing the site.
+  #
+  # The plugin reads files from a configured entry directory, invokes the
+  # bundled Node-based terser wrapper, and writes the compiled assets into the
+  # destination site output.
+  module MinifyJs
+    # Runs JavaScript minification from Jekyll's post-write lifecycle.
+    #
+    # The generator itself does not perform work during the normal generation
+    # phase. Instead, {run} is invoked from a `:post_write` hook so Jekyll does
+    # not overwrite the generated minified files.
+    class TerserGenerator < Jekyll::Generator
+      safe true
+      priority :low
 
-    def generate(_site)
-      # Work is done in the :post_write hook to avoid Jekyll overwriting outputs.
-    end
+      # Declares the generator without doing work during the normal build phase.
+      #
+      # @param _site [Jekyll::Site] the site being generated
+      # @return [void]
+      def generate(_site)
+        # Work is done in the :post_write hook to avoid Jekyll overwriting outputs.
+      end
 
-    def self.run(site) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      # Support both repository-root layout and app/ layout.
-      candidates = [
-        File.join(site.source, 'assets', 'js'),
-        File.join(site.source, 'app', 'assets', 'js')
-      ]
-      src_dir = candidates.find { |p| Dir.exist?(p) }
-      return unless src_dir
+      # Merges the plugin configuration with defaults.
+      #
+      # @param site [Jekyll::Site] the current site instance
+      # @return [Hash] the merged `minify_js` configuration
+      def self.minify_js_config(site)
+        default_config = {
+          "enabled" => true,
+          "entry_dir" => "js",
+          "output_dir" => "js",
+          "terser_opts" => {
+            "source_map" => true,
+            "compress" => true
+          }
+        }
+        site.config["minify_js"] = default_config.merge(site.config["minify_js"] || {})
+      end
 
-      # Read configuration from _config.yml under `minify_js:` key
-      cfg = site.config.fetch('minify_js', {})
-      return if cfg.key?('enabled') && cfg['enabled'] == false
+      # Runs the Node-based terser wrapper for one JavaScript source string.
+      #
+      # @param code [String] the JavaScript source to minify
+      # @param ts_opts [Hash, nil] terser options passed to the wrapper
+      # @return [Hash] the parsed JSON response from the wrapper
+      # @raise [RuntimeError] if the wrapper process exits unsuccessfully
+      def self.run_terser(code, ts_opts)
+        script_path = File.expand_path("../assets/index.js", __dir__)
+        input = JSON.generate({
+          code: code,
+          opts: ts_opts
+        }.compact)
+        stdout, stderr, status = Open3.capture3("node", script_path, stdin_data: input)
+        raise "Minify JS failed: #{stderr}" unless status.success?
 
-      dest_dir = File.join(site.dest, cfg.fetch('output_dir', 'assets/js'))
-      FileUtils.mkdir_p(dest_dir)
+        JSON.parse(stdout)
+      end
 
-      terser_available = defined?(Terser)
+      # Finds JavaScript files in the configured entry directory.
+      #
+      # @param site [Jekyll::Site] the current site instance
+      # @param entry [String, nil] the source directory relative to `site.source`
+      # @return [Array<String>, nil] matching absolute file paths, or `nil` when
+      #   no entry directory is configured or no files are found
+      def self.entry_js_files(site, entry)
+        entry_full = File.join(site.source, entry)
+        js_files = Dir.glob(File.join(entry_full, "**", "*.js"))
+        if Dir.exist?(entry_full) && js_files.empty?
+          Jekyll.logger.warn "MinifyJs:",
+                             "No JavaScript files found in #{entry_full}."
+        end
+        return if entry.nil? || js_files.empty?
 
-      # Build options from config
-      compress_opt = cfg.fetch('compress', true)
-      mangle_opt = cfg.fetch('mangle', true)
-      source_map_enabled = cfg.fetch('source_map', true)
-      exclude_patterns = cfg.fetch('exclude', ['**/*.min.js'])
+        js_files
+      end
 
-      Dir.glob(File.join(src_dir, '**', '*.js')).each do |src| # rubocop:disable Metrics/BlockLength
-        rel = Pathname.new(src).relative_path_from(Pathname.new(src_dir)).to_s
-        out = File.join(dest_dir, rel)
-        out_dir = File.dirname(out)
-        FileUtils.mkdir_p(out_dir)
-        map_name = "#{File.basename(out)}.map"
+      # Resolves the output directory for minified assets.
+      #
+      # @param site [Jekyll::Site] the current site instance
+      # @param out [String, nil] the configured output directory
+      # @param entry [String] the configured entry directory
+      # @return [String] the absolute destination directory inside `site.dest`
+      def self.output_dir(site, out, entry)
+        out ? File.join(site.dest, out) : File.join(site.dest, entry)
+      end
 
-        # Skip excluded files
-        next if exclude_patterns.any? { |pat| File.fnmatch(pat, rel) }
+      # Minifies every JavaScript file configured for the site.
+      #
+      # Files are written into the resolved output directory. If minification of
+      # an individual file fails, the original file is copied instead.
+      #
+      # @param site [Jekyll::Site] the current site instance
+      # @return [void]
+      def self.run(site) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        Jekyll.logger.info "Running jekyll-minify-js v#{Jekyll::MinifyJs::VERSION}"
+        mini_js_config = minify_js_config(site)
+        entry_dir = mini_js_config["entry_dir"]
+        nil if (mini_js_config["enable"] && mini_js_config["enable"] == false) || entry_dir.nil?
+        out_dir = output_dir(site, mini_js_config["output_dir"], entry_dir)
+        ts_opts = mini_js_config["terser_opts"]
+        entry_dir_full = File.join(site.source, entry_dir)
+        js_files = entry_js_files(site, entry_dir)
 
-        if terser_available
-          Jekyll.logger.info 'Terser:', "minifying #{rel} via terser Ruby gem"
-          begin
-            src_content = File.open(src, 'r:BOM|UTF-8', &:read)
-            options = {}
-            options[:compress] = compress_opt
-            options[:mangle] = mangle_opt
-            if source_map_enabled
-              options[:source_map] =
-                { filename: File.basename(src), output_filename: File.basename(out), sources_content: true,
-                  url: map_name }
-              compiled, map = Terser.compile_with_map(src_content, options)
-            else
-              compiled = Terser.compile(src_content, options)
-              map = nil
-            end
-            compiled += "\n//# sourceMappingURL=#{map_name}\n" unless compiled.include?('sourceMappingURL')
-            File.write(out, compiled)
-            File.write("#{out}.map", map) if map
-          rescue StandardError => e
-            Jekyll.logger.warn 'Terser:', "ruby terser failed for #{rel}: #{e.message}; copying original"
-            FileUtils.cp(src, out)
-          end
-        else
-          terser_cmd = new.detect_terser_cmd
-          if terser_cmd
-            cmd = %(#{terser_cmd} #{Shellwords.escape(src)} --compress --mangle -o #{Shellwords.escape(out)} --source-map "url='#{map_name}',includeSources") # rubocop:disable Layout/LineLength
-            Jekyll.logger.info 'Terser:', "minifying #{rel} via external terser"
-            success = system(cmd)
-            unless success && File.exist?(out)
-              Jekyll.logger.warn 'Terser:', "minify failed for #{rel}; copying original"
-              FileUtils.cp(src, out)
-            end
-          else
-            Jekyll.logger.warn 'Terser:', 'no terser available — copying original JS'
-            FileUtils.cp(src, out)
-          end
+        js_files.each do |src|
+          rel = src.sub(/\A#{Regexp.escape(entry_dir_full + File::SEPARATOR)}/, "")
+          out = File.join(out_dir, rel)
+          src_content = File.read(src)
+          result = run_terser(src_content, ts_opts)
+          compiled = result["compiled"]
+          source_map = result["source_map"]
+          File.write(out, compiled)
+          File.write("#{out}.map", source_map) if source_map
+        rescue StandardError => e
+          Jekyll.logger.warn "jekyll-minify-js:", "failed to minify for #{rel}: #{e.message}; copying original"
+          FileUtils.cp(src, out)
         end
       end
     end
-
-    def detect_terser_cmd
-      # Prefer the bundler-installed terser (from the `terser` gem) via `bundle exec terser`.
-      return 'bundle exec terser' if system('bundle exec terser --version > /dev/null 2>&1')
-      return 'terser' if system('terser --version > /dev/null 2>&1')
-
-      nil
-    end
   end
 end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  Jekyll::MinifyJs::TerserGenerator.run(site)
+end

data/lib/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Jekyll
+  # Namespace for the jekyll-minify-js plugin.
+  module MinifyJs
+    # Current gem version.
+    #
+    # @return [String]
+    VERSION = "0.2.11"
+  end
+end

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-minify-js
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.11
 platform: ruby
 authors:
-- Pho Thin Maung
+- phothinmg
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: fileutils
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -38,58 +24,36 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.4'
 - !ruby/object:Gem::Dependency
-  name: pathname
+  name: open3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: shellwords
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.2
-- !ruby/object:Gem::Dependency
-  name: terser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
-email: phothinmg@disroot.org
+        version: 0.2.1
+email:
+- phothinmg@disroot.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- README.md
+- assets/index.js
 - lib/jekyll-minify-js.rb
-homepage: https://rubygems.org/gems/jekyll-minify-js
+- lib/version.rb
+homepage: https://github.com/phothinmg/jekyll-minify-js
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/phothinmg/jekyll-minify-js
+  changelog_uri: https://github.com/phothinmg/jekyll-minify-js/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -98,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.15
 specification_version: 4
-summary: Jekyll plugin for Minify Js.
+summary: Jekyll plugin for Minify Js
 test_files: []