jekyll-simple-assets 0.3.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 066a9158d842b14dd87beb951baa1012dc97eb74e68009b97ebce1fc75d114dd
-  data.tar.gz: a78b84504fdff45054e89b9b3f017692460d9c74c3ed0017df0c45d4605f6950
+  metadata.gz: de767c626fd0732f43f0922b71ff3b0ef130be4ca6f28f0debd0f33f75df2cd5
+  data.tar.gz: 49430a9031fd6cfb541c76f80c346fc8782287cb31fc5446eb31da030dc7ae55
 SHA512:
-  metadata.gz: 556175bc3e9f81311e942242ac3b00574fdb6ac1fd979fe37cb74bd392b170ac14e49c893e917a870ed9714951e65a53e560bb1a76855bb647c2c945a8513528
-  data.tar.gz: 2e081620199cdf8ec5330678311d260da6b9405c25b7121324955be887018180c643a5e87cb80d2c1abb8b23fe3d28ae39233d20b00e07e0a9fc78d6549e213a
+  metadata.gz: a3477b5d323c0a8c0ca927a953e8420981c17711799be68ead1d59d2f0ca047406b2b05ebcd6c480cfb519f39025e7f1991e0e1b7d6ded306875191cba865d71
+  data.tar.gz: 6d3d2a4a85fb4f8f55a01cea832dc58e23e49d4f522e8b765f5558c7e2f755b1be29f12246152e835c8f7e03a41118c1fd717d1d460a57a2d51809c7b6223c18

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    jekyll-simple-assets (0.2.0)
+    jekyll-simple-assets (0.6.0)
       css_parser
       jekyll
+      terser
 
 GEM
   remote: https://rubygems.org/
@@ -11,59 +12,62 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.6)
-    css_parser (1.7.1)
+    concurrent-ruby (1.1.8)
+    css_parser (1.9.0)
       addressable
-    em-websocket (0.5.1)
+    em-websocket (0.5.2)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
-    ffi (1.13.1)
+    execjs (2.7.0)
+    ffi (1.15.0)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
-    i18n (1.8.3)
+    i18n (1.8.9)
       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.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.4)
-    rouge (3.20.0)
+    rouge (3.26.0)
     safe_yaml (1.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
-    terminal-table (1.8.0)
+    terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
+    terser (1.1.3)
+      execjs (>= 0.3.0, < 3)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/README.md

@@ -23,6 +23,7 @@ Returns a base64 encoded md5 hash based on the contents of the path given.
 
 Returns a relative url to the path given, with a hash based on the content of
 the file as a query string.
+Will link to a minified version of the file if possible.
 
 ```liquid
 {% asset assets/js/app.js %}
@@ -58,6 +59,15 @@ Returns an md5 hash of the input string.
 {{ 'some text' | md5 }}
 ```
 
+#### uglify
+
+Minifies javascript given as an input string (uses terser, and terser settings
+even though the filter is called `uglify`
+
+```liquid
+{{ 'const foo = "bar"' | uglify }}
+```
+
 ## Content hashes
 
 How the content hashes work is by generating a placeholder string that is
@@ -77,6 +87,48 @@ This plugin can also be used to generate critical css stylesheets. See
 configuration for more information on doing this. To generate critical css,
 [critical](https://github.com/addyosmani/critical) must be installed.
 
+## Javascript/Typescript bundling
+
+This plugin can also be used to bundle javascript and typescript files and
+modules using esbuild. Node modules can be included just by requiring them.
+Local modules can be required under the `@simple-assets` namespace, which
+will look for js files in the `_js` and `_ts` directories.
+
+For example:
+```javascript
+// assets/js/main.js
+
+// require node_module
+var leftpad = require('left-pad');
+
+// will look for left-pad.js or left-pad.ts at _js/ or _ts/ in the
+// project root
+var rightpad = require('@simple-assets/right-pad');
+```
+
+You can also put variables in the liquid frontmatter of a js/ts file (that is
+not under `_js` or `_ts`) to configure esbuild.
+
+```liquid
+---
+bundle: false # don't bundle or run esbuild on this file
+esbuild_flags: --target=es5 # pass any flags to esbuild for this file
+---
+```
+
+To bundle javascript [esbuild](https://github.com/evanw/esbuild) must be
+installed.
+
+## Javascript minification
+
+The terser package is also included and will minify files if `terser_enabled`
+is set to true in config.yml, or if JEKYLL_ENV is set to production. Any
+options can be passed to terser under the `terser` key in config.yml
+(see configuration for example, or
+[here](https://github.com/ahorek/terser-ruby) for detailed options).
+Additionally you can set terser settings in the liquid frontmatter of a js file
+in the same manner as in config.yml, also under the `terser` key.
+
 ## Configuration
 
 ```
@@ -86,6 +138,10 @@ simple_assets:
   # default: false
   hashing_enabled: true
 
+  # If set to true, source maps will be generated for javascript
+  # default: false
+  source_maps_enabled: true
+
   # The length of the content hashes generated.
   # default: 16
   hash_length: 8
@@ -109,4 +165,14 @@ simple_assets:
         layout: post
         # If the rules should be removed from the original source css files
         extract: true
+
+  # Options for bundling javascript/typescript with the `esbuild` npm module
+  # Set to true to enable
+  bundle: true
+
+  # Options for javascript minification with terser
+  terser:
+    # any options for terser can be put here and will be passed to it
+    output:
+      ascii_only: true
 ```

data/jekyll-simple-assets.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 	
 	spec.add_runtime_dependency "jekyll"
 	spec.add_runtime_dependency "css_parser"
+	spec.add_runtime_dependency "terser"
 	
 	spec.add_development_dependency "bundler"
 end

data/lib/jekyll-simple-assets/content-hash.rb

@@ -155,7 +155,10 @@ def self.replace_placeholders_for_path (page_path, input)
 				replacement = SimpleAssets::asset_contenthash_map[asset_path]
 
 				if type == 'path'
-					replacement = "#{ asset_path }?v=#{ replacement }"
+					min_path = asset_path.sub(/\.([^\.]*?)$/, '.min.\1')
+					url = (File.file? File.join(SimpleAssets::site.config['destination'], min_path)) ? min_path : asset_path
+
+					replacement = "#{ url }?v=#{ replacement }"
 
 					replacement = SimpleAssets::relative_url(replacement)
 				end
@@ -170,14 +173,6 @@ def self.replace_placeholders_for_path (page_path, input)
 	output
 end
 
-def self.replace_placeholders_for_asset (doc, site)
-	page_path = doc.path.sub("#{ site.config['source'] }/", '')
-
-	return unless SimpleAssets::page_assets_map[page_path]
-
-	doc.output = SimpleAssets::replace_placeholders_for_path(page_path, doc.output)
-end
-
 
 end
 end

data/lib/jekyll-simple-assets/critical.rb

@@ -7,19 +7,22 @@ module Jekyll
 module SimpleAssets
 
 
-def self.critical_css_source_files
-	@@critical_css_source_files ||= []
+def self.critical_css_source_files ()
+	@@critical_css_source_files ||= {}
 end
 
 def self.make_temp_css_files_for_critical (asset)
 	SimpleAssets::config['critical_css']['css_files'].each do |path|
 		next unless asset.path == path || asset.path == path.sub(/\.css$/, '.scss')
 
-		f = Tempfile.new('css-source')
+		f = Tempfile.new([ 'css-source', '.css' ])
 		f.write asset.output
 		f.close
+		File.chmod(0755, f.path)
 
-		SimpleAssets::critical_css_source_files << { 'file' => f, 'page' => asset }
+		Jekyll.logger.debug("SimpleAssets:", "Created new temp file for css: #{ asset.path } at: #{ f.path }")
+
+		SimpleAssets::critical_css_source_files[path] = { 'file' => f, 'page' => asset }
 	end
 end
 
@@ -40,7 +43,7 @@ end
 def self.generate_critical_css (site)
 	css_files_str = ''
 
-	SimpleAssets::critical_css_source_files.each do |f|
+	SimpleAssets::critical_css_source_files.each do |_, f|
 		css_files_str += "--css #{ f['file'].path } "
 
 		f['css'] = CssParser::Parser.new
@@ -60,13 +63,16 @@ def self.generate_critical_css (site)
 			stdin.write(html)
 			stdin.close
 
-			err = stderr.read
-			unless wait_thr.value.success?
-				Jekyll.logger.error("SimpleAssets:", 'Critical:' + err || stdout.read)
-
-				next
-			else
-				Jekyll.logger.warn("SimpleAssets:", 'Critical:' + err) if err
+			if !wait_thr.value.success? || stderr.read != ''
+				Jekyll.logger.error("SimpleAssets:", 'Critical (css) error:')
+				stderr.each do |line|
+					Jekyll.logger.error("", line)
+				end
+			elsif stderr.read != ''
+				Jekyll.logger.error("SimpleAssets:", 'Critical (css) error:')
+				stderr.each do |line|
+					Jekyll.logger.error("", line)
+				end
 			end
 
 			critical_css_str = stdout.read
@@ -88,7 +94,7 @@ def self.generate_critical_css (site)
 
 				critical_css.load_string! critical_css_str
 
-				SimpleAssets::critical_css_source_files.each do |f|
+				SimpleAssets::critical_css_source_files.each do |_, f|
 					f['css'].each_rule_set do |source_rule_set, source_media_type|
 						critical_css.each_rule_set do |critical_rule_set, critical_media_type|
 							if critical_rule_set.selectors.join(',') == source_rule_set.selectors.join(',')
@@ -104,13 +110,19 @@ def self.generate_critical_css (site)
 		end
 	end
 
-	SimpleAssets::critical_css_source_files.each do |f|
-		f['page'].output = f['css'].to_s if f['extract']
+	SimpleAssets::critical_css_source_files.each do |_, f|
+		leftover_css = f['css'].to_s if f['extract']
+
+		# css_parser leaves blank keyframes so fix them
+		keyframes = f['page'].output.scan(/@keyframes\s+(?:.*?)\s*{(?:\s*\S*?\s*{.*?}\s*)+}/m)
+		keyframes.each { |keyframe| leftover_css += keyframe }
+
+		f['page'].output
 	end
 end
 
 def self.resolve_critical_css_content_hashes (site)
-	SimpleAssets::critical_css_source_files.each do |source_file|
+	SimpleAssets::critical_css_source_files.each do |_, source_file|
 		page = source_file['page']
 		page_path = page.path.sub("#{ site.config['source'] }/", '')
 

data/lib/jekyll-simple-assets/esbuild.rb

@@ -0,0 +1,93 @@
+module Jekyll
+module SimpleAssets
+
+def self.generate_esbuild_config_file ()
+	source_path = Jekyll::SimpleAssets::site.config['source']
+
+	tsconfig_path = File.join(source_path, 'jsconfig.json')
+	jsconfig_path = File.join(source_path, 'tsconfig.json')
+
+	config = {}
+
+	if File.file?(tsconfig_path)
+		config = JSON.parse(File.read(tsconfig_path))
+	elsif File.file?(jsconfig_path)
+		config = JSON.parse(File.read(jsconfig_path))
+	end
+
+	f = Tempfile.new([ 'jsconfig.esbuild.', '.json' ])
+
+	config['compilerOptions'] = {} unless config['compilerOptions']
+
+	base_url = source_path
+	if config['compilerOptions']['baseUrl']
+		base_url = File.join(source_path, config['compilerOptions']['baseUrl'])
+	end
+	config['compilerOptions']['baseUrl'] = Pathname.new(base_url).relative_path_from(Pathname.new(f.path))
+
+	config['compilerOptions']['paths'] = {} unless config['compilerOptions']['paths']
+
+	relative_path = Pathname.new(source_path).relative_path_from(Pathname.new(base_url))
+
+	config['compilerOptions']['paths']['@simple-assets/*'] = [
+		File.join(relative_path, '_js/*'),
+		File.join(relative_path, '_ts/*'),
+	]
+
+	f.write config.to_json
+	f.close
+	File.chmod(0755, f.path)
+
+	Jekyll::SimpleAssets::esbuild_config_file(f)
+
+	Jekyll.logger.debug("SimpleAssets:", "esbuild: using tsconfig #{ f.path }")
+end
+
+def self.esbuild_bundle_file (page, payload, config_path)
+	if page.data['bundle'] == false
+		return
+	end
+
+	bundle_cmd = "npx esbuild --bundle --tsconfig=#{ config_path }"
+
+	if page.data['esbuild_flags']
+		bundle_cmd += ' ' + page.data['esbuild_flags']
+	end
+
+	node_env = '--define:process.env.NODE_ENV="' + (ENV['JEKYLL_ENV'] != 'production' ? "'development'" : "'production'") + '"'
+
+	bundle_cmd += ' ' + node_env + " --sourcefile=#{ page.path[/[^\/]*$/] }"
+
+	if SimpleAssets::source_maps_enabled?
+		bundle_cmd += ' ' + '--sourcemap=inline'
+	end
+
+	dir = File.dirname(page.path)
+
+	Jekyll.logger.info("SimpleAssets:", 'bundling: ' + page.path)
+	Jekyll.logger.debug("SimpleAssets:", 'running command: ' + bundle_cmd)
+
+	Open3.popen3(bundle_cmd, :chdir => dir) do |stdin, stdout, stderr, wait_thr|
+		stdin.write(page.output)
+		stdin.close
+
+		bundled = stdout.read
+
+		if !wait_thr.value.success? || stderr.read != ''
+			Jekyll.logger.error("SimpleAssets:", 'esbuild error:')
+			stderr.each do |line|
+				Jekyll.logger.error("", line)
+			end
+		elsif stderr.read != ''
+			Jekyll.logger.error("SimpleAssets:", 'esbuild error:')
+			stderr.each do |line|
+				Jekyll.logger.error("", line)
+			end
+		end
+
+		page.output = bundled
+	end
+end
+
+end
+end

data/lib/jekyll-simple-assets/terser.rb

@@ -0,0 +1,100 @@
+require 'fileutils'
+require 'terser'
+
+module Jekyll
+
+module SimpleAssets
+	def self.symbolize_keys (hash)
+		return {} if hash.nil?
+
+		hash.inject({}) do |result, (key, value)|
+
+			new_key = case key
+				when String then key.to_sym
+				else key
+			end
+			new_value = case value
+				when Hash then symbolize_keys(value)
+				else value
+			end
+
+			if new_value.is_a?(String) and new_value.match(/^\/.*\/$/)
+				new_value = /#{ Regexp.quote(new_value[1..-2]) }/
+			end
+
+			result[new_key] = new_value
+
+			result
+		end
+	end
+
+	def self.merge_recursively(a, b)
+		a.merge(b) {|key, a_item, b_item| SimpleAssets::merge_recursively(a_item, b_item) }
+	end
+
+	def self.should_minify_file? (page)
+		return false unless page.respond_to? :output
+		return false unless SimpleAssets::terser_enabled?
+		return false if page.data['do_not_compress'] == true
+		return true
+	end
+
+	def self.minify_file (page)
+		return unless SimpleAssets::should_minify_file?(page)
+
+		site_config = symbolize_keys(SimpleAssets::site.config['simple_assets']['terser'])
+		page_config = symbolize_keys(page.data['terser'])
+
+		config = SimpleAssets::merge_recursively(site_config || {}, page_config || {})
+
+		map_path = page.path + '.map'
+		if SimpleAssets::source_maps_enabled?
+			config = SimpleAssets::merge_recursively(config, {
+				:source_map => { :filename => page.path[/[^\/]*$/], :url => true },
+			})
+
+			minified, source_map = Terser.new(config).compile_with_map(page.output)
+		else
+			minified = Terser.new(config).compile(page.output)
+		end
+
+		min_path = page.path.sub(/\.(j|t)s$/i, '.min.js')
+		Jekyll.logger.info("SimpleAssets:", 'minified: ' + min_path)
+
+		if source_map
+			File.write(File.join(SimpleAssets::site.config['destination'], map_path), source_map)
+			minified = minified.gsub(/^\/\/#\s*?source(Mapping)?URL=.*$/, '')
+			minified += "\n//# sourceMappingURL=#{ SimpleAssets::relative_url(map_path) }"
+
+			Jekyll.logger.debug("SimpleAssets:", 'created source map: ' + map_path)
+
+			SimpleAssets::site.config['keep_files'] << map_path
+		end
+
+		if SimpleAssets::page_assets_map[page.path]
+			SimpleAssets::page_assets_map[min_path] = SimpleAssets::page_assets_map[page.path]
+		end
+
+		SimpleAssets::site.config['keep_files'] << min_path
+
+		return min_path, minified
+	end
+
+	module UglifyFilter
+		def uglify (input)
+			return if input.nil?
+
+			return input.split('\n').join('\\\n') unless SimpleAssets::terser_enabled?
+
+			config = @context.registers[:site].config['simple_assets']
+
+			terser_config = SimpleAssets::symbolize_keys(config['terser'])
+
+			Terser.new(terser_config).compile(input)
+		end
+	end
+end
+
+end
+
+Liquid::Template.register_filter(Jekyll::SimpleAssets::UglifyFilter)

data/lib/jekyll-simple-assets/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
 	module SimpleAssets
-		VERSION = "0.3.1"
+		VERSION = "0.6.1"
 	end
 end

data/lib/jekyll-simple-assets.rb

@@ -7,11 +7,15 @@ require 'shellwords'
 
 require 'jekyll-simple-assets/content-hash'
 require 'jekyll-simple-assets/critical'
+require 'jekyll-simple-assets/esbuild'
+require 'jekyll-simple-assets/terser'
 
 module Jekyll
 	module SimpleAssets
-		def self.site (site)
-			@@site ||= site
+		def self.site (site = nil)
+			@@site = site if site
+
+			@@site
 		end
 
 		def self.config
@@ -26,6 +30,22 @@ module Jekyll
 			config.key?('critical_css')
 		end
 
+		def self.esbuild_enabled?
+			config.key?('bundle') && config['bundle'] != false
+		end
+
+		def self.esbuild_config_file (file = nil)
+			@@esbuild_config_file ||= file
+		end
+
+		def self.terser_enabled?
+			config['terser_enabled'] || ENV['JEKYLL_ENV'] == 'production'
+		end
+
+		def self.source_maps_enabled?
+			config['source_maps_enabled']
+		end
+
 		module SimpleAssetsFilters
 			def md5 (input)
 				Digest::MD5.hexdigest(input)
@@ -105,7 +125,38 @@ Jekyll::Hooks.register :site, :post_render, priority: :low do |site, payload|
 		end
 
 		potential_pages.each do |doc|
-			Jekyll::SimpleAssets::replace_placeholders_for_asset(doc, site)
+			page_path = doc.path.sub("#{ site.config['source'] }/", '')
+
+			if Jekyll::SimpleAssets::page_assets_map[page_path]
+				doc.output = Jekyll::SimpleAssets::replace_placeholders_for_path(page_path, doc.output)
+			end
+
+			if doc.extname =~ /^\.(j|t)s$/i and Jekyll::SimpleAssets::should_minify_file?(doc)
+				min_path, minified = Jekyll::SimpleAssets::minify_file(doc)
+
+				if min_path and Jekyll::SimpleAssets::page_assets_map[page_path]
+					minified = Jekyll::SimpleAssets::replace_placeholders_for_path(page_path, minified)
+				end
+
+				File.write(File.join(Jekyll::SimpleAssets::site.config['destination'], min_path), minified)
+			end
+		end
+	end
+end
+
+Jekyll::Hooks.register :pages, :post_render do |page, payload|
+	unless Jekyll::SimpleAssets::esbuild_config_file
+		Jekyll::SimpleAssets::generate_esbuild_config_file()
+	end
+
+	if page.extname =~ /^\.(j|t)s$/i
+		if Jekyll::SimpleAssets::esbuild_enabled?
+			Jekyll::SimpleAssets::esbuild_bundle_file(page, payload, Jekyll::SimpleAssets::esbuild_config_file.path)
+		end
+
+		if Jekyll::SimpleAssets::should_minify_file?(page)
+			min_path = page.path.sub(/\.(j|t)s$/i, '.min.js')
+			File.write(File.join(Jekyll::SimpleAssets::site.config['destination'], min_path), '')
 		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-simple-assets
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Sophie Askew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terser
+  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
@@ -68,6 +82,8 @@ files:
 - lib/jekyll-simple-assets.rb
 - lib/jekyll-simple-assets/content-hash.rb
 - lib/jekyll-simple-assets/critical.rb
+- lib/jekyll-simple-assets/esbuild.rb
+- lib/jekyll-simple-assets/terser.rb
 - lib/jekyll-simple-assets/version.rb
 homepage: https://github.com/syldexiahime/jekyll-simple-assets
 licenses: