/eleventy-upgrade-help

Helper plugin when upgrading your Eleventy project to a new major version.

Primary LanguageJavaScript

eleventy-upgrade-help v2.0

A plugin to help you upgrade your Eleventy project from Eleventy v1.0 to v2.0.

Previous versions:

The major version of this plugin will always match the major version of Eleventy that you’re upgrading to.

Usage

Install from npm:

npm install @11ty/eleventy-upgrade-help@2

Add to your configuration file (probably .eleventy.js):

const UpgradeHelper = require("@11ty/eleventy-upgrade-help");

module.exports = function(eleventyConfig) {
  // If you have other `addPlugin` calls, it’s important that UpgradeHelper is added last.
  eleventyConfig.addPlugin(UpgradeHelper);
};

After your upgrade is complete and you’ve removed all of the violations/warnings from your output, delete the plugin from your package.json and .eleventy.js configuration file.

Example demo

You can review a sample project using this upgrade plugin.