initial setup

Author: zeroby0

manifest.yml

@@ -1,7 +1,21 @@
-name: 'netlify-plugin-{{name}}'
-inputs: []
-# Example inputs:
-#  - name: example
-#    description: Example description
-#    default: 5
-#    required: false
+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: img_cache_remote_dir
+    default: '../cache'
+
+  - name: img_cache_httpHeader
+    default: true
+
+  - name: other_cache_dir
+    default: []

netlify.toml

@@ -4,16 +4,22 @@
 
 # List of Build plugins
 [[plugins]]
-# Use the current plugin in builds for testing and debugging.
-# Local path to the plugin.
 package = "."
-  # Plugin configuration
-  #  [plugins.inputs]
-  #  foo = "bar"
+  [plugins.inputs]
+    img_cache_local = true
+    img_cache_local_dir = ['/img']
+
+    img_cache_remote = true
+    img_cache_remote_dir = '../.cache'
+
+    img_cache_httpHeader = true
+
+    other_cache_dir = []
 
 [build]
-# Dummy build command
-command = "echo onBuild"
+    base = "./"
+    command = "echo \"haha building!\""
+    publish = "_site"
 
 [build.environment]
 NODE_VERSION = "12.18.0"

package.json

@@ -48,4 +48,4 @@
     "prettier": "^2.1.2",
     "release-it": "^14.0.3"
   }
-}
+}

src/index.js

@@ -1,105 +1,96 @@
-// This is the main file for the Netlify Build plugin 11ty.
-// Please read the comments to learn more about the Netlify Build plugin syntax.
-// Find more information in the Netlify documentation.
+const path = require('path')
+const fs = require('fs')
 
-/* eslint-disable no-unused-vars */
-module.exports = {
-  // The plugin main logic uses `on...` event handlers that are triggered on
-  // each new Netlify Build.
-  // Anything can be done inside those event handlers.
-  // Information about the current build are passed as arguments. The build
-  // configuration file and some core utilities are also available.
-  async onPreBuild({
-    // Whole configuration file. For example, content of `netlify.toml`
-    netlifyConfig,
-    // Users can pass configuration inputs to any plugin in their Netlify
-    // configuration file.
-    // For example:
-    //
-    //   [[plugins]]
-    //   package = "netlify-plugin-11ty"
-    //     [plugins.inputs]
-    //     foo = "bar"
-    inputs,
-    // `onError` event handlers receive the error instance as argument
-    error,
+const getCacheDirs = (constants, inputs) => {
+  const getCacheDirs__ = (constants, input) => {
+    let cacheDirs = []
+
+    if (typeof input === 'string') {
+      cacheDirs.push(path.normalize(constants.PUBLISH_DIR + '/' + input))
+    } else if (Array.isArray(input)) {
+      input.map((x) => {
+        cacheDirs.push(path.normalize(constants.PUBLISH_DIR + '/' + x))
+      })
+    } else {
+      console.log(`Warning: Unsupported value in inputs. Ignoring ${input}`)
+    }
 
-    // Build constants
-    constants: {
-      // Path to the Netlify configuration file. `undefined` if none was used
-      CONFIG_PATH,
-      // Directory that contains the deploy-ready HTML files and assets
-      // generated by the build. Its value is always defined, but the target
-      // might not have been created yet.
-      PUBLISH_DIR,
-      // The directory where function source code lives.
-      // `undefined` if not specified by the user.
-      FUNCTIONS_SRC,
-      // The directory where built serverless functions are placed before
-      // deployment. Its value is always defined, but the target might not have
-      // been created yet.
-      FUNCTIONS_DIST,
-      // Boolean indicating whether the build was run locally (Netlify CLI) or
-      // in the production CI
-      IS_LOCAL,
-      // Version of Netlify Build as a `major.minor.patch` string
-      NETLIFY_BUILD_VERSION,
-      // The Netlify Site ID
-      SITE_ID,
-    },
+    return cacheDirs
+  }
+
+  return [
+    ...getCacheDirs__(constants, inputs.img_cache_local_dir),
+    ...getCacheDirs__(constants, inputs.img_cache_remote_dir),
+    ...getCacheDirs__(constants, inputs.other_cache_dir),
+  ]
+}
 
-    // Core utilities
-    utils: {
-      // Utility to report errors.
-      // See https://github.com/netlify/build#error-reporting
-      build,
-      // Utility to display information in the deploy summary.
-      // See https://github.com/netlify/build#logging
-      status,
-      // Utility for caching files.
-      // See https://github.com/netlify/build/blob/master/packages/cache-utils#readme
-      cache,
-      // Utility for running commands.
-      // See https://github.com/netlify/build/blob/master/packages/run-utils#readme
-      run,
-      // Utility for dealing with modified, created, deleted files since a git commit.
-      // See https://github.com/netlify/build/blob/master/packages/git-utils#readme
-      git,
-       // Utility for handling Netlify Functions.
-      // See https://github.com/netlify/build/tree/master/packages/functions-utils#readme
-      functions,
-    },
-  }) {
-    try {
-      // Commands are printed in Netlify logs
-      await run('echo', ['Hello world!\n'])
-    } catch (error) {
-      // Report a user error
-      build.failBuild('Error message', { error })
+const getHttpHeaders = (inputs) => {
+  let httpHeader = ''
+
+  inputs.img_cache_local_dir.map((x) => {
+    httpHeader += `
+${x}/*
+cache-control: public
+cache-control: max-age=31536000
+cache-control: immutable
+
+`
+  })
+
+  return httpHeader
+}
+
+module.exports = {
+  async onPreBuild({ constants, inputs, utils }) {
+    if (!constants.PUBLISH_DIR || process.cwd() === constants.PUBLISH_DIR) {
+      utils.build.failBuild(
+        `11ty sites must publish the dist directory, but your site’s publish directory is set to : “${constants.PUBLISH_DIR}”. Please set your publish directory to your 11ty site’s dist directory.`,
+      )
     }
 
-    // Console logs are shown in Netlify logs
-    console.log('Netlify configuration', netlifyConfig)
-    console.log('Plugin configuration', inputs)
-    console.log('Build directory', PUBLISH_DIR)
+    const cacheDirs = getCacheDirs(constants, inputs)
+    cacheDirs.map((x) => {
+      if (fs.existsSync(x)) {
+        console.log(
+          `Warning: directory ${x} already exists before restoring caches. It will be replaced.`,
+        )
+      }
+    })
 
-    // Display success information
-    status.show({ summary: 'Success!' })
+    if (await utils.cache.restore(cacheDirs)) {
+      console.log('Restoring 11ty directories from cache:')
+      cacheDirs.map((x) => {
+        console.log('- ' + x)
+      })
+    } else {
+      console.log('No 11ty caches found. Building fresh.')
+    }
   },
 
-  // Other available event handlers
-  /*
-  // Before build commands are executed
-  onPreBuild() {},
-  // Build commands are executed
-  onBuild() {},
-  // After Build commands are executed
-  onPostBuild() {},
-  // Runs on build success
-  onSuccess() {},
-  // Runs on build error
-  onError() {},
-  // Runs on build error or success
-  onEnd() {},
-  */
+  async onPostBuild({ constants, inputs, utils }) {
+    if (inputs.img_cache_httpHeader) {
+      fs.appendFile(
+        `${constants.PUBLISH_DIR}/_headers`,
+        getHttpHeaders(inputs),
+        (err) => {
+          if (err) throw err
+          console.log('Saved http header')
+        },
+      )
+    }
+
+    const cacheDirs = getCacheDirs(constants, inputs)
+
+    if (await utils.cache.save(cacheDirs)) {
+      console.log('Saving 11ty directories to cache:')
+      cacheDirs.map((x) => {
+        console.log('- ' + x)
+      })
+    } else {
+      console.log(
+        `Warning: 11ty build not found. Is you publish directory set correctly? “${constants.PUBLISH_DIR}”`,
+      )
+    }
+  },
 }