eleventyConfig.augmentFunctionContext to add this.eleventy and this.page to the context of any function (but mostly for filters/shortcodes)

[zachleat]

Sample usage here creating a Nunjucks shortcode from scratch:

eleventy/test/EleventyTest.js

Lines 1435 to 1445 in 26d26b7

	let fn = eleventyConfig.augmentFunctionContext(
	eleventyConfig.getShortcode("customized"),
	{
	source: context.ctx,
	// lazy: false,
	// getter: (key, context) => context?.[key];
	// overwrite: true,
	}
	);
	return fn(argString);

Related to #3310 and noelforte/eleventy-plugin-vento#9

[zachleat]

Fixed by 26d26b7

[pauleveritt]

This might be a really useful thing for my TSX stuff.

[zachleat]

@pauleveritt Yeah absolutely!

[zachleat]

Shipped with 3.0.0-alpha.15 https://github.com/11ty/eleventy/releases/tag/v3.0.0-alpha.15

[noelforte]

Revisiting this, with the addition of an exports field in eleventy's package.json, it's no longer possible to access any utilites by their direct filepath. For instance, this throws an error:

import { augmentKeys } from '@11ty/eleventy/src/Engines/Util/ContextAugmenter.js';

Does it make sense to mark ContextAugmenter.js's exports as public so they can be consumed elsewhere outside of eleventyConfig?

---

As an aside, I just came across #3422 which makes the suggestion to do away with usage of this in JavaScript templates. It got me curious if there's a future for Eleventy to maintain some sort of global object containing useful data (like page and eleventy) that could be imported project-wide, which would alleviate my struggles with this and my template syntax plugin for Vento.

Removal of dependence on this is a big breaking change, so definitely a topic for larger discussion. Interesting to consider, though!

[mayank99]

I think this might solve some of the problems I was facing which led me to open #3422, but I don't see any docs for augmentFunctionContext. Maybe this issue needs the needs-documentation Documentation for this issue/feature is pending! label?

[zachleat]

Temporary docs preview deploying here https://11ty-website-git-v3-11ty.vercel.app/docs/languages/custom/#compile

[noelforte]

Thanks for this @zachleat! After getting more educated on the implementation for my use case in eleventy-plugin-vento. I realized it would be simpler to precompile templates with a direct call to the shortcode instead of an indirect call.

I did stumble upon one thing though, I see augmentObject and augmentKeys are exported from src/Engines/Util/ContextAugmenter.js, but trying to import them throws an error. Filed in #3460, which might also help clean up things.