linter

Author: zeroby0

README.md

@@ -3,8 +3,11 @@
 A plugin to make building with Eleventy and Netlify a joy!
 
 ### Speed up your builds ⚡
-- Caches images generated by [@11ty/eleventy-img](https://github.com/11ty/eleventy-img) across builds
-- Caches assets fetched by [@11ty/eleventy-fetch](https://github.com/11ty/eleventy-fetch) across builds
+
+- Caches images generated by
+  [@11ty/eleventy-img](https://github.com/11ty/eleventy-img) across builds
+- Caches assets fetched by
+  [@11ty/eleventy-fetch](https://github.com/11ty/eleventy-fetch) across builds
 - Caches any other folders of your choice (optional)
 
 ## Install
@@ -30,79 +33,86 @@ And add the plugin to your `netlify.toml` file:
         cache_other = []
 ```
 
-Make sure the path for [`cache_img`](#1-cache_img) is correct. Aand you're done! 🥳
+Make sure the path for [`cache_img`](#1-cache_img) is correct. Aand you're done!
+🥳
 
-You can read Netlify's documentation about Plugins here: https://docs.netlify.com/configure-builds/build-plugins/
+You can read Netlify's documentation about Plugins here:
+https://docs.netlify.com/configure-builds/build-plugins/
 
-**Note**: If your builds are failing, the version of Node
-you're using is probably not supported by Netlify.
-Try Node v16.x.x.
-See the [FAQs section](#my-builds-are-failing) for more info.
+**Note**: If your builds are failing, the version of Node you're using is
+probably not supported by Netlify. Try Node v16.x.x. See the
+[FAQs section](#my-builds-are-failing) for more info.
 
 ## Documentation
 
-### 1. `cache_img`   
+### 1. `cache_img`
 
-Type:    `String` or `Array of Strings`  
-Default: `'img'` (relative to the publish directory)  
+Type: `String` or `Array of Strings`  
+Default: `'img'` (relative to the publish directory)
 
-Path to the folder(s) in which files generated by `@11ty/eleventy-img` are stored,
-relative to the publish directory. Can be a String or an array of Strings.
+Path to the folder(s) in which files generated by `@11ty/eleventy-img` are
+stored, relative to the 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.
 
 ### 2. `cache_img_httpHeader`
 
-Type:    `Boolean`  
-Default: `false`  
+Type: `Boolean`  
+Default: `false`
 
 If set to `true`, files generated by `@11ty/eleventy-img` will be served with
 http header `cache-control: public, max-age=31536000, immutable`.
 
 Files generated by `eleventy_img` have a hash calculated using file content and
 [Sharp plugin options](https://www.11ty.dev/docs/plugins/image/#advanced-control-of-sharp-image-processor)
-in their name by default ([starting from #116](https://github.com/11ty/eleventy-img/pull/116)),
-so you can cache them indefinitely. Don't use this if you're using remote images.
+in their name by default
+([starting from #116](https://github.com/11ty/eleventy-img/pull/116)), so you
+can cache them indefinitely. Don't use this if you're using remote images.
 
 :warning: **Caution**:
+
 - If you are using remote images, this option should be `false` (default).
-- If you are using [custom filenames](https://www.11ty.dev/docs/plugins/image/#custom-filenames-new-in-image-0.4.0)
-that don't include a hash, this option should be `false` (default).
+- If you are using
+  [custom filenames](https://www.11ty.dev/docs/plugins/image/#custom-filenames-new-in-image-0.4.0)
+  that don't include a hash, this option should be `false` (default).
 
 ### 3. `cache_assets`
 
 Type: `String` or `Array of Strings`  
-Default: `'../.cache'` (relative to the publish directory)  
+Default: `'../.cache'` (relative to the publish directory)
 
-Path to the folder(s) in which remote assets fetched by [@11ty/eleventy-fetch](https://github.com/11ty/eleventy-fetch)
-are cached, relative to publish directory. Can be a String or an array of
-Strings.
+Path to the folder(s) in which remote assets fetched by
+[@11ty/eleventy-fetch](https://github.com/11ty/eleventy-fetch) are cached,
+relative to publish directory. Can be a String or an array of Strings.
 
-If set to `false`, assets fetched by `@11ty/eleventy-fetch` are not saved
-in Netlify cache.
+If set to `false`, assets fetched by `@11ty/eleventy-fetch` are not saved in
+Netlify cache.
 
 ### 4. `cache_other`
 
 Type: `String` or `Array of Strings`  
-Default: `[]` (relative to the publish directory)  
+Default: `[]` (relative to the publish directory)
 
-Paths to any other folder(s) you'd like to cache across Netlify builds. If these folders
-exist before restoring Nelify cache, their content will be merged and overwritten
-with content from the cached folders.
+Paths to any other folder(s) you'd like to cache across Netlify builds. If these
+folders exist before restoring Nelify cache, their content will be merged and
+overwritten with content from the cached folders.
 
 ## FAQs
+
 ### I `rimraf` my `_site` on every build
 
-If your images are written to `_site/img` (default),
-use `rimraf '_site/!(img)'`.
+If your images are written to `_site/img` (default), use
+`rimraf '_site/!(img)'`.
 
-If they are in a subdirectory, say `_site/assets/images`,
-use `rimraf '_site/!(assets)' '_site/assets/!(images)'`.
+If they are in a subdirectory, say `_site/assets/images`, use
+`rimraf '_site/!(assets)' '_site/assets/!(images)'`.
 
 ### My builds are failing
 
 If your build fails with
+
 ```bash
 11:37:10 AM: Uncaught exception, the process will now terminate…
 11:37:10 AM: Error: Unable to deserialize cloned data due to invalid or unsupported version.
@@ -120,34 +130,40 @@ echo "16" > .nvmrc
 ```
 
 More info about this error:
+
 - https://answers.netlify.com/t/netlify-build-cache-error/78115/4
 - https://answers.netlify.com/t/build-failing-after-upgrade-to-node-18/75774
 
 See this guide for more ways to set Node versions:
 https://docs.netlify.com/configure-builds/manage-dependencies/
 
 ### Are there any Benchmarks?
+
 Yes!
 
-The speed-up, ofcourse, depends on how many images your website has,
-but here is a benchmark I used when developing this plugin:
+The speed-up, ofcourse, depends on how many images your website has, but here is
+a benchmark I used when developing this plugin:
 
-| Run                   | No cache persistence |  With cache persistence  |
-|-----------------------|----------------------|--------------------------|
-| 1st run (empty cache) | 11.74 seconds        | 11.52 seconds            |
-| 2nd run (filled cache)| 11.32 seconds        | 131.82 **milliseconds**  |
+| Run                    | No cache persistence | With cache persistence  |
+| ---------------------- | -------------------- | ----------------------- |
+| 1st run (empty cache)  | 11.74 seconds        | 11.52 seconds           |
+| 2nd run (filled cache) | 11.32 seconds        | 131.82 **milliseconds** |
 
 [Read more](https://github.com/11ty/eleventy-img/pull/116#issuecomment-882870369)
 
 ## Recommended Netlify plugins
+
 - [Subfont](https://github.com/munter/netlify-plugin-subfont)
 - [Inline Critical CSS](https://github.com/Tom-Bonnike/netlify-plugin-inline-critical-css#readme)
 
 ## Bug Reports, Feature Requests, and Ideas
-Please [create an issue](https://github.com/zeroby0/netlify-plugin-11ty/issues/new/) :)
+
+Please
+[create an issue](https://github.com/zeroby0/netlify-plugin-11ty/issues/new/) :)
 
 ## License
+
 **MIT**
 
-If you need this repository with a different License,
-please [create an issue](https://github.com/zeroby0/netlify-plugin-11ty/issues/new/).
+If you need this repository with a different License, please
+[create an issue](https://github.com/zeroby0/netlify-plugin-11ty/issues/new/).