Allows generation of redirects.json to be disabled (#207)

Merge pull request 207

README.md

@@ -127,6 +127,19 @@ Your layout will get the following variables:
 * `page.redirect.from` - the relative path to the redirect page
 * `page.redirect.to` - the absolute URL (where available) to the target page
 
+## Configuration
+
+You can configure this plugin in `_config.yml` by adding to the `redirect_from` key.
+
+### Disabling `redirects.json`
+
+By default, a file called `redirects.json`, which can be used for automated testing or to implement server-side redirects, will be included in the output. To exclude it from the output, set the `json` key to `false`:
+
+```yml
+redirect_from:
+  json: false
+```
+
 ## Contributing
 
 1. Fork it

lib/jekyll-redirect-from/generator.rb

@@ -22,7 +22,7 @@ def generate(site)
         generate_redirect_to(doc)
       end
 
-      generate_redirects_json
+      generate_redirects_json if generate_redirects_json?
     end
 
     private
@@ -53,5 +53,9 @@ def generate_redirects_json
       page.data["layout"] = nil
       site.pages << page
     end
+
+    def generate_redirects_json?
+      site.config.dig("redirect_from", "json") != false
+    end
   end
 end

spec/jekyll_redirect_from/generator_spec.rb

@@ -94,7 +94,7 @@
     let(:redirects) { JSON.parse(contents) }
     let(:domain) { "http://jekyllrb.com" }
 
-    it "creates the redirets file" do
+    it "creates the redirects file" do
       expect(path).to exist
     end
 
@@ -140,10 +140,18 @@
         FileUtils.rm_f source_path
       end
 
-      it "doesn't overwrite redirets.json" do
+      it "doesn't overwrite redirects.json" do
         expect(path).to exist
         expect(redirects).to eql("foo" => "bar")
       end
     end
+
+    context "when explicitly disabled" do
+      let(:site) { Jekyll::Site.new(config.merge("redirect_from" => { "json" => false })) }
+
+      it "does not create the redirects file" do
+        expect(path).to_not exist
+      end
+    end
   end
 end