jekyll-minify-js 0.2.1 → 0.2.12

data/lib/jekyll-minify-js.rb

@@ -1,96 +1,129 @@
 # frozen_string_literal: true
 
-require 'jekyll'
-require 'fileutils'
-require 'terser'
+require "jekyll"
+require "json"
+require "open3"
+require "pathname"
 
-require_relative 'version'
-require_relative 'color'
+require_relative "version"
 
-# module Jekyll
 module Jekyll
-  # module Jekyll::MinifyJs
+  # 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
-    # class Jekyll::MinifyJs:TerserGenerator
+    # 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
 
+      # 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/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-        config = site.config['minify_js'] || {}
-        # disable to skip minification
-        return if config['enable'] && config['enable'] == false
-
-        started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        # Build options from config
-        compress_opt = config['compress'] || true
-        mangle_opt = config['mangle'] || true
-        source_map_enabled = config['source_map'] || true
-
-        Jekyll.logger.info ''
-        Jekyll.logger.info set_color(96, "Running Jekyll MinifyJs v#{Jekyll::MinifyJs::VERSION}", 1)
-
-        entry_dir = config['entry_dir'] || 'js'
-        out_dir = config['output_dir'] || 'js'
+      # 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
 
-        if config['entry_dir']
-          Jekyll.logger.info "Entry  : #{File.join(site.source, config['entry_dir'])}"
-        else
-          Jekyll.logger.info "Entry  : No entry_dir found, look in #{File.join(site.source, 'js')}"
-        end
+      # 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?
+
+        JSON.parse(stdout)
+      end
 
-        if config['output_dir']
-          Jekyll.logger.info "Output : #{File.join(site.dest, config['output_dir'])}"
-        else
-          Jekyll.logger.info "Output : No output_dir found, write to #{File.join(site.dest, 'js')}"
+      # 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?
 
-        entry_dir_full = File.join(site.source, entry_dir)
-        out_dir_full = File.join(site.dest, out_dir)
-        js_files = Dir.glob(File.join(entry_dir_full, '**', '*.js'))
+        js_files
+      end
 
-        Jekyll.logger.warn 'MinifyJs:', "Entry directory not found: #{entry_dir_full}" unless Dir.exist?(entry_dir_full)
-        if Dir.exist?(entry_dir_full) && js_files.empty?
-          Jekyll.logger.info 'MinifyJs:',
-                             "No JavaScript files found in #{entry_dir_full}"
-        end
+      # 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
 
-        FileUtils.mkdir_p(out_dir_full)
+      # 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)
 
         js_files.each do |src|
-          rel = src.sub(/\A#{Regexp.escape(entry_dir_full + File::SEPARATOR)}/, '')
-          out = File.join(out_dir_full, rel)
-          map_name = "#{File.basename(out)}.map"
-
-          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
+          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
-
-        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at
-        Jekyll.logger.info set_color(92, format('Done in %.2fs', elapsed), 1)
       end
     end
   end

data/lib/version.rb

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

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-minify-js
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.12
 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,32 +24,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.4'
 - !ruby/object:Gem::Dependency
-  name: terser
+  name: open3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.2.1
   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
-- lib/color.rb
+- README.md
+- assets/index.js
+- assets/index.js.map
 - lib/jekyll-minify-js.rb
 - 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:
@@ -72,14 +63,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: []

data/lib/color.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-def set_color(index, content, weight = 0)
-  "\e[#{weight};#{index}m#{content}\e[0m "
-end