| 9 | | {{ post.title }} | 10 |
gem install jekyll-minifierplugins:
20 | - jekyll-minifier
21 | jekyll-minifier:
26 | exclude: 'atom.xml' # Exclude files from processing - file name, glob pattern or array of file names and glob patterns
27 | jekyll-minifier:
32 | preserve_php: true # Default: false
33 | remove_spaces_inside_tags: true # Default: true
34 | remove_multi_spaces: true # Default: true
35 | remove_comments: true # Default: true
36 | remove_intertag_spaces: true # Default: false
37 | remove_quotes: false # Default: false
38 | compress_css: true # Default: true
39 | compress_javascript: true # Default: true
40 | compress_json: true # Default: true
41 | simple_doctype: false # Default: false
42 | remove_script_attributes: false # Default: false
43 | remove_style_attributes: false # Default: false
44 | remove_link_attributes: false # Default: false
45 | remove_form_attributes: false # Default: false
46 | remove_input_attributes: false # Default: false
47 | remove_javascript_protocol: false # Default: false
48 | remove_http_protocol: false # Default: false
49 | remove_https_protocol: false # Default: false
50 | preserve_line_breaks: false # Default: false
51 | simple_boolean_attributes: false # Default: false
52 | compress_js_templates: false # Default: false
53 | preserve_patterns: # Default: (empty)
54 | uglifier_args: # Default: (empty)
55 |
65 | jekyll-minifier:
66 | uglifier_args:
67 | harmony: true
68 |
69 | 
78 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env rake
2 | require "bundler/gem_tasks"
3 |
--------------------------------------------------------------------------------
/jekyll-minifier.gemspec:
--------------------------------------------------------------------------------
1 | # -*- encoding: utf-8 -*-
2 | require File.expand_path('../lib/jekyll-minifier/version', __FILE__)
3 |
4 | Gem::Specification.new do |gem|
5 | gem.specification_version = 2 if gem.respond_to? :specification_version=
6 | gem.required_rubygems_version = Gem::Requirement.new('>= 0') if gem.respond_to? :required_rubygems_version=
7 | gem.rubygems_version = '2.3.1'
8 | gem.required_ruby_version = '>= 2.3.0'
9 |
10 | gem.authors = ["DigitalSparky"]
11 | gem.email = ["matthew@spurrier.com.au"]
12 | gem.description = %q{Jekyll Minifier using htmlcompressor for html, uglifier for js and css}
13 | gem.summary = %q{Jekyll Minifier for html, css, and javascript}
14 | gem.homepage = "http://github.com/digitalsparky/jekyll-minifier"
15 | gem.license = "GPL-3.0"
16 |
17 | gem.files = `git ls-files`.split($\)
18 | gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
19 | gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
20 | gem.name = "jekyll-minifier"
21 | gem.require_paths = ["lib"]
22 |
23 | if ENV['TRAVIS_TAG']
24 | gem.version = "#{ENV['TRAVIS_TAG']}"
25 | else
26 | gem.version = Jekyll::Minifier::VERSION
27 | end
28 |
29 | gem.add_dependency "jekyll", ">= 3.5"
30 | gem.add_dependency "uglifier", "~> 4.1"
31 | gem.add_dependency "htmlcompressor", "~> 0.4"
32 | gem.add_dependency "cssminify2", "~> 2.0"
33 | gem.add_dependency "json-minify", "~> 0.0.3"
34 |
35 | gem.add_development_dependency "rake", "~> 12.3"
36 | gem.add_development_dependency "rspec", "~> 3.8"
37 | gem.add_development_dependency "jekyll-paginate", "~> 1.1"
38 | gem.add_development_dependency "redcarpet", "~> 3.4"
39 | end
40 |
--------------------------------------------------------------------------------
/lib/jekyll-minifier.rb:
--------------------------------------------------------------------------------
1 | require 'uglifier'
2 | require 'htmlcompressor'
3 | require 'cssminify2'
4 | require 'json/minify'
5 |
6 | module Jekyll
7 | module Compressor
8 | def output_file(dest, content)
9 | FileUtils.mkdir_p(File.dirname(dest))
10 | File.open(dest, 'w') do |f|
11 | f.write(content)
12 | end
13 | end
14 |
15 | def output_compressed(path, context)
16 | case File.extname(path)
17 | when '.js'
18 | if path.end_with?('.min.js')
19 | output_file(path, context)
20 | else
21 | output_js(path, context)
22 | end
23 | when '.json'
24 | output_json(path, context)
25 | when '.css'
26 | if path.end_with?('.min.css')
27 | output_file(path, context)
28 | else
29 | output_css(path, context)
30 | end
31 | else
32 | output_html(path, context)
33 | end
34 | end
35 |
36 | def output_html(path, content)
37 | if ( ENV['JEKYLL_ENV'] == "production" )
38 | html_args = { remove_comments: true, compress_css: true, compress_javascript: true, preserve_patterns: [] }
39 | js_args = {}
40 |
41 | opts = @site.config['jekyll-minifier']
42 | if ( !opts.nil? )
43 | # Javascript Arguments
44 | js_args[:uglifier_args] = Hash[opts['uglifier_args'].map{|(k,v)| [k.to_sym,v]}] if opts.has_key?('uglifier_args')
45 |
46 | # HTML Arguments
47 | html_args[:remove_spaces_inside_tags] = opts['remove_spaces_inside_tags'] if opts.has_key?('remove_spaces_inside_tags')
48 | html_args[:remove_multi_spaces] = opts['remove_multi_spaces'] if opts.has_key?('remove_multi_spaces')
49 | html_args[:remove_comments] = opts['remove_comments'] if opts.has_key?('remove_comments')
50 | html_args[:remove_intertag_spaces] = opts['remove_intertag_spaces'] if opts.has_key?('remove_intertag_spaces')
51 | html_args[:remove_quotes] = opts['remove_quotes'] if opts.has_key?('remove_quotes')
52 | html_args[:compress_css] = opts['compress_css'] if opts.has_key?('compress_css')
53 | html_args[:compress_javascript] = opts['compress_javascript'] if opts.has_key?('compress_javascript')
54 | html_args[:simple_doctype] = opts['simple_doctype'] if opts.has_key?('simple_doctype')
55 | html_args[:remove_script_attributes] = opts['remove_script_attributes'] if opts.has_key?('remove_script_attributes')
56 | html_args[:remove_style_attributes] = opts['remove_style_attributes'] if opts.has_key?('remove_style_attributes')
57 | html_args[:remove_link_attributes] = opts['remove_link_attributes'] if opts.has_key?('remove_link_attributes')
58 | html_args[:remove_form_attributes] = opts['remove_form_attributes'] if opts.has_key?('remove_form_attributes')
59 | html_args[:remove_input_attributes] = opts['remove_input_attributes'] if opts.has_key?('remove_input_attributes')
60 | html_args[:remove_javascript_protocol] = opts['remove_javascript_protocol'] if opts.has_key?('remove_javascript_protocol')
61 | html_args[:remove_http_protocol] = opts['remove_http_protocol'] if opts.has_key?('remove_http_protocol')
62 | html_args[:remove_https_protocol] = opts['remove_https_protocol'] if opts.has_key?('remove_https_protocol')
63 | html_args[:preserve_line_breaks] = opts['preserve_line_breaks'] if opts.has_key?('preserve_line_breaks')
64 | html_args[:simple_boolean_attributes] = opts['simple_boolean_attributes'] if opts.has_key?('simple_boolean_attributes')
65 | html_args[:compress_js_templates] = opts['compress_js_templates'] if opts.has_key?('compress_js_templates')
66 | html_args[:preserve_patterns] += [/<\?php.*?\?>/im] if opts['preserve_php'] == true
67 | html_args[:preserve_patterns] += opts['preserve_patterns'].map { |pattern| Regexp.new(pattern)} if opts.has_key?('preserve_patterns')
68 | end
69 |
70 | html_args[:css_compressor] = CSSminify2.new()
71 |
72 | if ( !js_args[:uglifier_args].nil? )
73 | html_args[:javascript_compressor] = Uglifier.new(js_args[:uglifier_args])
74 | else
75 | html_args[:javascript_compressor] = Uglifier.new()
76 | end
77 |
78 | compressor = HtmlCompressor::Compressor.new(html_args)
79 | output_file(path, compressor.compress(content))
80 | else
81 | output_file(path, content)
82 | end
83 | end
84 |
85 | def output_js(path, content)
86 | if ( ENV['JEKYLL_ENV'] == "production" )
87 | js_args = {}
88 | opts = @site.config['jekyll-minifier']
89 | compress = true
90 | if ( !opts.nil? )
91 | compress = opts['compress_javascript'] if opts.has_key?('compress_javascript')
92 | js_args[:uglifier_args] = Hash[opts['uglifier_args'].map{|(k,v)| [k.to_sym,v]}] if opts.has_key?('uglifier_args')
93 | end
94 |
95 | if ( compress )
96 | if ( !js_args[:uglifier_args].nil? )
97 | compressor = Uglifier.new(js_args[:uglifier_args])
98 | else
99 | compressor = Uglifier.new()
100 | end
101 |
102 | output_file(path, compressor.compile(content))
103 | else
104 | output_file(path, content)
105 | end
106 | else
107 | output_file(path, content)
108 | end
109 | end
110 |
111 | def output_json(path, content)
112 | if ( ENV['JEKYLL_ENV'] == "production" )
113 | opts = @site.config['jekyll-minifier']
114 | compress = true
115 | if ( !opts.nil? )
116 | compress = opts['compress_json'] if opts.has_key?('compress_json')
117 | end
118 |
119 | if ( compress )
120 | output_file(path, JSON.minify(content))
121 | else
122 | output_file(path, content)
123 | end
124 | else
125 | output_file(path, content)
126 | end
127 | end
128 |
129 | def output_css(path, content)
130 | if ( ENV['JEKYLL_ENV'] == "production" )
131 | opts = @site.config['jekyll-minifier']
132 | compress = true
133 | if ( !opts.nil? )
134 | compress = opts['compress_css'] if opts.has_key?('compress_css')
135 | end
136 | if ( compress )
137 | compressor = CSSminify2.new()
138 | output_file(path, compressor.compress(content))
139 | else
140 | output_file(path, content)
141 | end
142 | else
143 | output_file(path, content)
144 | end
145 |
146 | end
147 |
148 | private
149 |
150 | def exclude?(dest, dest_path)
151 | file_name = dest_path.slice(dest.length+1..dest_path.length)
152 | exclude.any? { |e| e == file_name || File.fnmatch(e, file_name) }
153 | end
154 |
155 | def exclude
156 | @exclude ||= Array(@site.config.dig('jekyll-minifier', 'exclude'))
157 | end
158 | end
159 |
160 | class Document
161 | include Compressor
162 |
163 | def write(dest)
164 | dest_path = destination(dest)
165 | if exclude?(dest, dest_path)
166 | output_file(dest_path, output)
167 | else
168 | output_compressed(dest_path, output)
169 | end
170 | trigger_hooks(:post_write)
171 | end
172 | end
173 |
174 | class Page
175 | include Compressor
176 |
177 | def write(dest)
178 | dest_path = destination(dest)
179 | if exclude?(dest, dest_path)
180 | output_file(dest_path, output)
181 | else
182 | output_compressed(dest_path, output)
183 | end
184 | Jekyll::Hooks.trigger hook_owner, :post_write, self
185 | end
186 | end
187 |
188 | class StaticFile
189 | include Compressor
190 |
191 | def copy_file(path, dest_path)
192 | FileUtils.mkdir_p(File.dirname(dest_path))
193 | FileUtils.cp(path, dest_path)
194 | end
195 |
196 | def write(dest)
197 | dest_path = destination(dest)
198 |
199 | return false if File.exist?(dest_path) and !modified?
200 | self.class.mtimes[path] = mtime
201 |
202 | if exclude?(dest, dest_path)
203 | copy_file(path, dest_path)
204 | else
205 | case File.extname(dest_path)
206 | when '.js'
207 | if dest_path.end_with?('.min.js')
208 | copy_file(path, dest_path)
209 | else
210 | output_js(dest_path, File.read(path))
211 | end
212 | when '.json'
213 | output_json(dest_path, File.read(path))
214 | when '.css'
215 | if dest_path.end_with?('.min.css')
216 | copy_file(path, dest_path)
217 | else
218 | output_css(dest_path, File.read(path))
219 | end
220 | when '.xml'
221 | output_html(dest_path, File.read(path))
222 | else
223 | copy_file(path, dest_path)
224 | end
225 | end
226 | true
227 | end
228 | end
229 | end
230 |
--------------------------------------------------------------------------------
/lib/jekyll-minifier/version.rb:
--------------------------------------------------------------------------------
1 | module Jekyll
2 | module Minifier
3 | VERSION = "0.1.8"
4 | end
5 | end
6 |
--------------------------------------------------------------------------------
/spec/fixtures/404.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "404: Page not found"
4 | permalink: 404.html
5 | ---
6 |
7 |
8 |
11 |
--------------------------------------------------------------------------------
/spec/fixtures/_config.yml:
--------------------------------------------------------------------------------
1 | markdown: redcarpet
2 | highlighter: pygments
3 | title: Example.com
4 | tagline: "Example!"
5 | description: ""
6 | url: https://example.com
7 | paginate: 10
8 | category_dir: /
9 | category_title_prefix: ""
10 | permalink: :categories/:title.html
11 | timezone: Australia/Perth
12 | author:
13 | name: "Example"
14 | email: "example@example.com"
15 | menu:
16 | - {
17 | url: "https://www.github.com/example/",
18 | name: "GitHub",
19 | nofollow: true,
20 | newwindow: true,
21 | }
22 | plugins:
23 | - jekyll-minifier
24 | - jekyll-paginate
25 |
--------------------------------------------------------------------------------
/spec/fixtures/_includes/sidebar.html:
--------------------------------------------------------------------------------
1 |
2 |
25 |
--------------------------------------------------------------------------------
/spec/fixtures/_layouts/category_index.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | ---
4 | 404: Page not found
9 |Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. Head back home to try finding it again.
10 |
5 |
6 | {% for post in site.categories[page.category] %}
7 |
13 |
--------------------------------------------------------------------------------
/spec/fixtures/_layouts/default.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: null
3 | ---
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
27 |
39 |
40 |
45 |
46 |
63 |
64 |
65 |
--------------------------------------------------------------------------------
/spec/fixtures/_layouts/page.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | ---
4 |
5 |
28 |
35 |
29 |
34 | 30 | Example.com 31 | Example! 32 |
33 |
36 | {{ content }}
37 |
38 |
6 |
9 |
--------------------------------------------------------------------------------
/spec/fixtures/_layouts/post.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | ---
4 |
5 | {{ page.title | capitalize }}
7 | {{ content }} 8 |
6 |
10 |
11 |
26 |
--------------------------------------------------------------------------------
/spec/fixtures/_plugins/generate_categories.rb:
--------------------------------------------------------------------------------
1 | # encoding: utf-8
2 | #
3 | # Jekyll category page generator.
4 | # http://recursive-design.com/projects/jekyll-plugins/
5 | #
6 | # Version: 0.2.4 (201210160037)
7 | #
8 | # Copyright (c) 2010 Dave Perrett, http://recursive-design.com/
9 | # Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
10 | #
11 | # A generator that creates category pages for jekyll sites.
12 | #
13 | # To use it, simply drop this script into the _plugins directory of your Jekyll site. You should
14 | # also create a file called 'category_index.html' in the _layouts directory of your jekyll site
15 | # with the following contents (note: you should remove the leading '# ' characters):
16 | #
17 | # ================================== COPY BELOW THIS LINE ==================================
18 | # ---
19 | # layout: default
20 | # ---
21 | #
22 | # {{ page.title }}
7 | {{ page.date | date_to_string }} 8 | {{ content }} 9 |{{ page.title }}
23 | #-
24 | # {% for post in site.categories[page.category] %}
25 | #
{{ post.date | date_to_html_string }}
26 | # {{ post.title }}
27 | #Filed under {{ post.categories | category_links }}
28 | # {% endfor %}
29 | #
7 | {% for post in paginator.posts %}
8 |
28 |
29 |
45 |
46 |
--------------------------------------------------------------------------------
/spec/jekyll-minifier_spec.rb:
--------------------------------------------------------------------------------
1 | require 'spec_helper'
2 |
3 | describe "JekyllMinifier" do
4 | let(:overrides) { Hash.new }
5 | let(:config) do
6 | Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
7 | "full_rebuild" => true,
8 | "source" => source_dir,
9 | "destination" => dest_dir,
10 | "show_drafts" => true,
11 | "url" => "http://example.org",
12 | "name" => "My awesome site",
13 | "author" => {
14 | "name" => "Dr. Jekyll"
15 | },
16 | "collections" => {
17 | "my_collection" => { "output" => true },
18 | "other_things" => { "output" => false }
19 | }
20 | }, overrides))
21 | end
22 | let(:site) { Jekyll::Site.new(config) }
23 | let(:context) { make_context(site: site) }
24 | before(:each) do
25 | allow(ENV).to receive(:[]).and_call_original
26 | allow(ENV).to receive(:[]).with('JEKYLL_ENV').and_return('production')
27 | site.process
28 | end
29 |
30 | context "test_atom" do
31 | it "creates a atom.xml file" do
32 | expect(Pathname.new(dest_dir("atom.xml"))).to exist
33 | end
34 |
35 | let(:atom) { File.read(dest_dir("atom.xml")) }
36 |
37 | it "puts all the posts in the atom.xml file" do
38 | expect(atom).to match "http://example.org/random/random.html"
39 | expect(atom).to match "http://example.org/reviews/test-review-1.html"
40 | expect(atom).to match "http://example.org/reviews/test-review-2.html"
41 | end
42 |
43 | let(:feed) { RSS::Parser.parse(atom) }
44 |
45 | it "outputs an RSS feed" do
46 | expect(feed.feed_type).to eql("atom")
47 | expect(feed.feed_version).to eql("1.0")
48 | expect(feed.encoding).to eql("UTF-8")
49 | end
50 |
51 | it "outputs the link" do
52 | expect(feed.link.href).to eql("http://example.org/atom.xml")
53 | end
54 | end
55 |
56 | context "test_css" do
57 | it "creates a assets/css/style.css file" do
58 | expect(Pathname.new(dest_dir("assets/css/style.css"))).to exist
59 | end
60 |
61 | let(:file) { File.read(dest_dir("assets/css/style.css")) }
62 |
63 | it "ensures assets/css/style.css file has length" do
64 | expect(file.length).to be > 0
65 | end
66 | end
67 |
68 | context "test_404" do
69 | it "creates a 404.html file" do
70 | expect(Pathname.new(dest_dir("404.html"))).to exist
71 | end
72 |
73 | let(:file) { File.read(dest_dir("404.html")) }
74 |
75 | it "ensures 404.html file has length" do
76 | expect(file.length).to be > 0
77 | end
78 | end
79 |
80 | context "test_index" do
81 | it "creates a index.html file" do
82 | expect(Pathname.new(dest_dir("index.html"))).to exist
83 | end
84 |
85 | let(:file) { File.read(dest_dir("index.html")) }
86 |
87 | it "ensures index.html file has length" do
88 | expect(file.length).to be > 0
89 | end
90 | end
91 |
92 | context "test_random_index" do
93 | it "creates a random/index.html file" do
94 | expect(Pathname.new(dest_dir("random/index.html"))).to exist
95 | end
96 |
97 | let(:file) { File.read(dest_dir("random/index.html")) }
98 |
99 | it "ensures random/index.html file has length" do
100 | expect(file.length).to be > 0
101 | end
102 | end
103 |
104 | context "test_random_random" do
105 | it "creates a random/random.html file" do
106 | expect(Pathname.new(dest_dir("random/random.html"))).to exist
107 | end
108 |
109 | let(:file) { File.read(dest_dir("random/random.html")) }
110 |
111 | it "ensures random/random.html file has length" do
112 | expect(file.length).to be > 0
113 | end
114 | end
115 |
116 | context "test_reviews_index" do
117 | it "creates a reviews/index.html file" do
118 | expect(Pathname.new(dest_dir("reviews/index.html"))).to exist
119 | end
120 |
121 | let(:file) { File.read(dest_dir("reviews/index.html")) }
122 |
123 | it "ensures reviews/index.html file has length" do
124 | expect(file.length).to be > 0
125 | end
126 | end
127 |
128 | context "test_reviews_test-review-1" do
129 | it "creates a reviews/test-review-1.html file" do
130 | expect(Pathname.new(dest_dir("reviews/test-review-1.html"))).to exist
131 | end
132 |
133 | let(:file) { File.read(dest_dir("reviews/test-review-1.html")) }
134 |
135 | it "ensures reviews/test-review-1.html file has length" do
136 | expect(file.length).to be > 0
137 | end
138 | end
139 |
140 | context "test_reviews_test-review-2" do
141 | it "creates a reviews/test-review-2.html file" do
142 | expect(Pathname.new(dest_dir("reviews/test-review-2.html"))).to exist
143 | end
144 |
145 | let(:file) { File.read(dest_dir("reviews/test-review-2.html")) }
146 |
147 | it "ensures reviews/test-review-2.html file has length" do
148 | expect(file.length).to be > 0
149 | end
150 | end
151 |
152 | end
153 |
--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | require 'jekyll'
2 | require 'rss'
3 | require 'rspec'
4 | require File.expand_path('../lib/jekyll-minifier', File.dirname(__FILE__))
5 |
6 | Jekyll.logger.log_level = :error
7 |
8 | RSpec.configure do |config|
9 |
10 | SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
11 | DEST_DIR = File.expand_path("../dest", __FILE__)
12 |
13 | def source_dir(*files)
14 | File.join(SOURCE_DIR, *files)
15 | end
16 |
17 | def dest_dir(*files)
18 | File.join(DEST_DIR, *files)
19 | end
20 |
21 | def make_context(registers = {})
22 | Liquid::Context.new({}, {}, { site: site }.merge(registers))
23 | end
24 | end
25 |
--------------------------------------------------------------------------------
9 |
26 | {% endfor %}
27 | 10 | 11 | {{ post.title }} 12 | 13 |
14 | 15 | {{ post.date | date_to_string }} 16 | 17 |18 | {{ post.excerpt }} 19 |
20 |21 | 22 | Read More 23 | 24 |
25 |