cleanup config

Author: zeroby0

README.md

@@ -1,9 +1,82 @@
-Netlify Build plugin 11ty - A build plugin to integrate Eleventy seamlessly with Netlify.
+Netlify Build plugin 11ty - A build plugin to integrate Eleventy seamlessly with
+Netlify.
 
 # Install
 
-Please install this plugin from the Netlify app.
+Install plugin via npm as dependency
 
-# Configuration
+**Note**: Till https://github.com/11ty/eleventy-img/pull/116 is merged,
+[this fork](https://github.com/zeroby0/eleventy-img/tree/cache) has to be used instead of `@11ty/eleventy-img`
 
-The following `inputs` options are available.
+```
+npm install zeroby0/netlify-plugin-11ty
+npm uninstall @11ty/eleventy-img
+npm install zeroby0/eleventy-img#cache
+```
+
+And add to your `netlify.toml` file
+
+```toml
+[[plugins]]
+    package = "netlify-plugin-11ty"
+```
+
+# configuration
+
+Optionally, you can configure the plugin to match you project's needs.
+
+**Example**:
+
+```toml
+[[plugins]]
+    package = "netlify-plugin-11ty"
+    [plugins.inputs]
+        cache_img = './img'
+        cache_img_httpHeader = true
+
+        cache_assets = '../.cache'
+        cache_other = []
+```
+
+The following `inputs` options are available:
+
+#### cache_img
+
+Type: `string` or `Array of strings` Default: `'./img'` (relative to the publish
+directory)
+
+The folder(s) in which files generated by `@11ty/eleventy-img` are stored,
+relative to publish directory. Can be a string or an array of strings.
+
+If set to `false`, files generated by `@11ty/eleventy-img` are not saved in
+Netlify cache.
+
+#### cache_img_httpHeader
+
+Type: boolean Default: `true`
+
+If set to `true`, a files generated by `@11ty/eleventy-img` will be served with
+http header `cache-control: public, max-age=31536000, immutable`.
+
+This should be safe to do as the file names have a hash calculated using file
+content and Sharp Options.
+
+#### cache_assets
+
+Type: `string` or `Array of strings` Default: `'../.cache'` (relative to the
+publish directory)
+
+The folder(s) in which remote assets fetched by `@11ty/eleventy-cache-assets`
+are cached, relative to publish directory. Can be a string or an array of
+strings.
+
+If set to `false`, assets fetched by `@11ty/eleventy-cache-assets` are not saved
+in Netlify cache.
+
+#### cache_other
+
+Type: `string` or `Array of strings` Default: `[]` (relative to the publish
+directory)
+
+Any other folder(s) you'd like to cache across Netlify builds. If these folders
+exist before restoring Nelify cache, they will be replaced with cached folders.

manifest.yml

@@ -1,21 +1,17 @@
 name: 'netlify-plugin-11ty'
 inputs:
-  - name: img_cache_local
-    description: 'Cache images generated by 11ty Image plugin'
-    default: true
-
-  - name: img_cache_local_dir
-    description: '11ty image plugin output directory'
-    default: '/img'
-
-  - name: img_cache_remote
-    default: '../cache'
+  - name: cache_img
+    description: '11ty Image plugin output directory'
+    default: './img'
 
-  - name: img_cache_remote_dir
-    default: '../cache'
-
-  - name: img_cache_httpHeader
+  - name: cache_img_httpHeader
+    description: 'Add immutable cache http headers'
     default: true
 
-  - name: other_cache_dir
+  - name: cache_assets
+    description: '11ty Assets plugin cache directory'
+    default: '../.cache'
+
+  - name: cache_other
+    description: 'Any other directories you want to cache'
     default: []

netlify.toml

@@ -6,15 +6,11 @@
 [[plugins]]
 package = "."
   [plugins.inputs]
-    img_cache_local = true
-    img_cache_local_dir = '/img'
+  cache_img = false
+  cache_img_httpHeader = true
 
-    img_cache_remote = true
-    img_cache_remote_dir = '../.cache'
-
-    img_cache_httpHeader = true
-
-    other_cache_dir = []
+  cache_assets = '../.cache'
+  cache_other = []
 
 [build]
     base = "./"

package.json

@@ -2,6 +2,9 @@
   "name": "netlify-plugin-11ty",
   "version": "0.0.1",
   "description": "Netlify Build plugin - A build plugin to integrate Eleventy seamlessly with Netlify",
+  "publishConfig": {
+    "access": "public"
+  },
   "main": "src/index.js",
   "files": [
     "src/**/*.js",
@@ -15,9 +18,17 @@
     "netlify-plugin",
     "netlify"
   ],
-  "author": "Aravind Reddy Voggu <aravind.reddy@iiitb.org>",
+  "author": {
+    "name": "Aravind Reddy Voggu",
+    "email": "aravind.reddy@iiitb.org",
+    "url": "https://www.avoggu.com"
+  },
   "license": "MIT",
-  "repository": "//github.com/zeroby0/netlify-plugin-11ty",
+  "repository": "https://github.com/zeroby0/netlify-plugin-11ty",
+  "bugs": {
+    "url": "https://github.com/zeroby0/netlify-plugin-11ty/issues"
+  },
+  "homepage": "https://github.com/zeroby0/netlify-plugin-11ty#readme",
   "directories": {
     "lib": "src",
     "test": "test"

src/index.js

@@ -4,6 +4,8 @@ const fs = require('fs')
 const getCacheDirs__ = (base, input) => {
   let cacheDirs = []
 
+  if (!input) return []
+
   if (typeof input === 'string') {
     cacheDirs.push(path.normalize(base + '/' + input))
   } else if (Array.isArray(input)) {
@@ -19,21 +21,21 @@ const getCacheDirs__ = (base, input) => {
 
 const getCacheDirs = (base, inputs) => {
   return [
-    ...getCacheDirs__(base, inputs.img_cache_local_dir),
-    ...getCacheDirs__(base, inputs.img_cache_remote_dir),
-    ...getCacheDirs__(base, inputs.other_cache_dir),
+    ...getCacheDirs__(base, inputs.cache_img),
+    ...getCacheDirs__(base, inputs.cache_assets),
+    ...getCacheDirs__(base, inputs.cache_other),
   ]
 }
 
 const getHttpHeaders = (inputs) => {
   let httpHeader = ''
 
-  getCacheDirs__('.', inputs.img_cache_local_dir).map((x) => {
+  getCacheDirs__('.', inputs.cache_img).map((x) => {
     httpHeader += `
 ${x}/*
-cache-control: public
-cache-control: max-age=31536000
-cache-control: immutable
+  cache-control: public
+  cache-control: max-age=31536000
+  cache-control: immutable
 
 `
   })
@@ -56,6 +58,12 @@ module.exports = {
           `Warning: directory ${x} already exists before restoring caches. It will be replaced if it exists in the cache.`,
         )
       }
+
+      if (path.normalize(x) === path.normalize(constants.PUBLISH_DIR)) {
+        console.log(
+          `11ty sites must publish the dist directory, but your site’s publish directory is set to : “${constants.PUBLISH_DIR}”.`,
+        )
+      }
     })
 
     if (await utils.cache.restore(cacheDirs)) {
@@ -77,7 +85,7 @@ module.exports = {
         console.log('- ' + x)
       })
 
-      if (inputs.img_cache_httpHeader) {
+      if (inputs.cache_img_httpHeader) {
         fs.appendFile(
           `${constants.PUBLISH_DIR}/_headers`,
           getHttpHeaders(inputs),
@@ -88,9 +96,7 @@ module.exports = {
         )
       }
     } else {
-      console.log(
-        `Warning: Unable to save 11ty cache. Build not found or is empty. Is you publish directory set correctly? “${constants.PUBLISH_DIR}”`,
-      )
+      console.log('Did not save any folders to cache.')
     }
   },
 }