Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Typos in Canary eleventy Post #1639

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Typos in Canary eleventy Post #1639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions src/blog/2023-12-17-canary-eleventy-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ eleventyNavigation:
parent: Blog
homePageHighlight: true
---
Are you feeling adventurous? A few short days ago we released the first alpha release of Eleventy v3.0 on the `canary` channel. If you’d like to try it out, use the following command to install it in your project:
Are you feeling adventurous? A few short days ago, we released the first alpha release of Eleventy v3.0 on the `canary` channel. If you’d like to try it out, use the following command to install it in your project:

```sh
npm install @11ty/eleventy@canary --save-exact
Expand All @@ -28,18 +28,18 @@ I’ve been working with the incredible folks at CloudCannon for a few months no

* _Eleventy v3.0 requires **Node 18** or newer._

The flagship feature for this release is our first-class bundler-free (read: it’s fast) [ESM support](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules). Practically speaking, this means you can add `"type": "module"` to your `package.json` and all of the Node `*.js` files in your project will now expect ESM syntax (e.g. `import` instead of `require`).
The flagship feature for this release is our first-class bundler-free (read: it’s fast) [ESM support](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules). Practically speaking, this means you can add `"type": "module"` to your `package.json` and all of the Node `*.js` files in your project will now expect ESM syntax (e.g., `import` instead of `require`).

**ESM is _not_ required**. Your existing CommonJS (CJS) projects (known for use of `module.exports` and `require`) will still work great with Eleventy 3.0 and we will continue to support CommonJS in Eleventy moving forward.
**ESM is _not_ required**. Your existing CommonJS (CJS) projects (known for the use of `module.exports` and `require`) will still work great with Eleventy 3.0, and we will continue to support CommonJS in Eleventy moving forward.

You have two upgrade path options (pick which one suits your project best):

1. Leave your existing Eleventy project as CommonJS. This is the easiest migration path. [Use of `require` for I18nPlugin, RenderPlugin, or HTMLBasePlugin will need to be updated](#how-to-require(@11ty/eleventy)-in-commonjs).
2. Make your project ESM-first. This is highly recommended for new projects and is the best way to write JavaScript moving forward. [`11ty-website` went all in on ESM](https://github.com/11ty/11ty-website/pull/1636) but (as a reminder) **ESM is _not_ required** and a project-wide upgrade to ESM isn’t necessary either. You can add `"type": "module"` to your `package.json` and rename your Node `.js` files to `.cjs` and be done with it. Later on, you can slowly upgrade to ESM syntax one JavaScript file at a time by renaming back from `.cjs` to `.js`.
2. Make your project ESM-first. This is highly recommended for new projects and is the best way to write JavaScript moving forward. [`11ty-website` went all in on ESM](https://github.com/11ty/11ty-website/pull/1636), but (as a reminder) **ESM is _not_ required** and a project-wide upgrade to ESM isn’t necessary either. You can add `"type": "module"` to your `package.json` and rename your Node `.js` files to `.cjs` and be done with it. Later, you can slowly upgrade to ESM syntax one JavaScript file at a time by renaming it back from `.cjs` to `.js`.

### Upgrade examples

You can check out these two pull requests showing how these large-ish web site codebases were converted to use Eleventy v3.0:
You can check out these two pull requests showing how these large-ish website codebases were converted to use Eleventy v3.0:

* `zachleat.com` kept using CommonJS (easy mode: 3 files changed ~6 lines of code): https://github.com/zachleat/zachleat.com/pull/50
* `11ty-website` CommonJS to ESM (a bit more work): https://github.com/11ty/11ty-website/pull/1636
Expand All @@ -59,7 +59,7 @@ module.exports = function(eleventyConfig) {
};
```

If _you’re contining to use CommonJS_, these will need to be updated to dynamic imports instead (you can’t `require` an ESM package but you can use `await import()` in CommonJS to work around it):
If _you’re continuing to use CommonJS_, these will need to be updated to dynamic imports instead (you can’t `require` an ESM package, but you can use `await import()` in CommonJS to work around it):

```js
// Eleventy 3.0 supports async configuration callbacks:
Expand All @@ -73,9 +73,9 @@ module.exports = async function(eleventyConfig) {

## ‼️ Warning ‼️ Project Slipstream Changes

Per feedback from our [community survey](https://www.11ty.dev/blog/community-survey-results/) we’re making a few big changes in Eleventy v3.0 we’re referring to as [Project Slipstream](https://github.com/11ty/eleventy/pull/3074).
Per feedback from our [community survey](https://www.11ty.dev/blog/community-survey-results/), we're making a few big changes in Eleventy v3.0 we’re referring to as [Project Slipstream](https://github.com/11ty/eleventy/pull/3074).

* Low interest in `pug`, `hbs`, `mustache`, `ejs`, or `haml` has prompted their removal (from core) as well. But if you use these, do not despair. We have a future plan to [move `pug` into plugin-land as an officially supported plugin for the v3.0 stable release](https://github.com/11ty/eleventy/issues/3081). I you are interested in the others, please [leave an upvote on the appropriate comment in Issue #3124](https://github.com/11ty/eleventy/issues/3124).
* Low interest in `pug`, `hbs`, `mustache`, `ejs`, or `haml` has prompted their removal (from core) as well. But if you use these, do not despair. We have a future plan to [move `pug` into plugin-land as an officially supported plugin for the v3.0 stable release](https://github.com/11ty/eleventy/issues/3081). If you are interested in the others, please [leave an upvote on the appropriate comment in Issue #3124](https://github.com/11ty/eleventy/issues/3124).
* Low-interest in our vendor-locked 😬 plugins (Netlify Serverless and Netlify Edge) prompted their removal as we rededicate to static site generation and the hosting portability of Jamstack. You will still be able to run Eleventy in serverless environments, but the Eleventy project will not manage this code directly.

_If you’re interested in the [unique benefits of the Jamstack](https://www.zachleat.com/web/jamstack-future/) and want to learn more, join us at [thefutureofjamstack.org](https://thefutureofjamstack.org/):_
Expand All @@ -85,11 +85,11 @@ _If you’re interested in the [unique benefits of the Jamstack](https://www.zac

## What’s next?

Our little project had a few [set-backs](https://www.zachleat.com/web/eleventy-side-project/) this year but now we’re running on all cylinders now and it’s full steam ahead.
Our little project had a few [set-backs](https://www.zachleat.com/web/eleventy-side-project/) this year, but now we're running on all cylinders now and it's full steam ahead.

We’ll likely spend a few months doing active development on v3.0: taking feedback, bug fixing, and iterating on a few new surprises too. You can follow along with this progress on the [GitHub milestone](https://github.com/11ty/eleventy/milestone/40?closed=1).
We'll likely spend a few months doing active development on v3.0: taking feedback, bug fixing, and iterating on a few new surprises too. You can follow along with this progress on the [GitHub milestone](https://github.com/11ty/eleventy/milestone/40?closed=1).

We’ll be talking about it all on Mastodon—make sure to follow along:
We'll be talking about it all on Mastodon—make sure to follow along:

* [`@[email protected]`](https://fosstodon.org/@eleventy)
* [`@[email protected]`](https://zachleat.com/@zachleat)