netlify-plugin-cache/index.js

// Netlify Plugin: netlify-plugin-cache
// https://github.com/jakejarvis/netlify-plugin-cache
//
// This plugin is essentially a wrapper around Netlify's native `cache-utils`:
// https://github.com/netlify/build/blob/master/packages/cache-utils/README.md

module.exports = {
  // Try to restore cache before build begins, if it exists
  onPreBuild: async ({ utils: { cache }, inputs }) => {
    if (await cache.restore(inputs.paths)) {
      const files = await cache.list(inputs.paths)
      console.log(`Successfully restored: ${inputs.paths.join(', ')} ... ${files.length} files in total.`)
    } else {
      console.log(`A cache of '${inputs.paths.join(', ')}' doesn't exist (yet).`)
    }
  },

  // Only save/update cache if build was successful
  onSuccess: async ({ utils: { cache, status }, inputs }) => {
    if (await cache.save(inputs.paths)) {
      const files = await cache.list(inputs.paths)
      console.log(`Successfully cached: ${inputs.paths.join(', ')} ... ${files.length} files in total.`)

      // Show success & more detail in deploy summary
      status.show({
        title: `${files.length} files cached`,
        summary: 'These will be restored on the next build! ⚡',
        text: `${inputs.paths.join(', ')}`
      })
    } else {
      // This probably happened because the default `paths` is set, so provide instructions to fix
      console.log(`Attempted to cache: ${inputs.paths.join(', ')} ... but failed. :(`)
      console.log('Try setting the \'paths\' input appropriately in your netlify.toml configuration.')
      console.log('More details: https://jrvs.io/netlify-cache-usage')
    }
  }
}