@anyblades/buildawesome-kit 1.3.0-alpha → 1.3.0-alpha.2

package/README.md

@@ -39,15 +39,15 @@ Then `addPlugin` to your 11ty config:
 ```js
 import eleventyBladesPlugin from "@anyblades/eleventy-blades";
 
-export default function (eleventyConfig) {
-  eleventyConfig.addPlugin(eleventyBladesPlugin);
+export default function ($config) {
+  $config.addPlugin(eleventyBladesPlugin);
 }
 ```
 
 You can toggle features/filters like this:
 
 ```js
-eleventyConfig.addPlugin(eleventyBladesPlugin, {
+$config.addPlugin(eleventyBladesPlugin, {
   mdAutoRawTags: false,
   filters: { attr_set: false },
 });
@@ -93,7 +93,7 @@ cd _includes/
 ln -s ../node_modules/@anyblades/blades/_includes/blades
 
 # Run Eleventy:
-eleventy --config=node_modules/@anyblades/eleventy-blades-base/eleventy.config.js
+eleventy --config=node_modules/@anyblades/eleventy-blades-base/buildawesome.config.js
 ```
 
 Live examples:
@@ -106,7 +106,7 @@ Live examples:
 If you don't want to type `--config=...` every time, symlink it once:
 
 ```sh
-ln -s node_modules/@anyblades/eleventy-blades-base/eleventy.config.js
+ln -s node_modules/@anyblades/eleventy-blades-base/buildawesome.config.js
 eleventy
 ```
 
@@ -114,7 +114,7 @@ Or save it in your `package.json` scripts:
 
 ```json
   "scripts": {
-    "build": "eleventy --config=node_modules/@anyblades/eleventy-blades-base/eleventy.config.js"
+    "build": "eleventy --config=node_modules/@anyblades/eleventy-blades-base/buildawesome.config.js"
   }
 ```
 
@@ -125,15 +125,15 @@ Alternatively, import it as a base config in your 11ty config:
 ```js
 import baseConfig from "@anyblades/eleventy-blades-base";
 
-export default async function (eleventyConfig) {
-  await baseConfig(eleventyConfig);
+export default async function ($config) {
+  await baseConfig($config);
 }
 ```
 
 You can toggle features/filters like this:
 
 ```js
-await baseConfig(eleventyConfig, {
+await baseConfig($config, {
   plugins: {
     "@anyblades/eleventy-blades": {
       mdAutoRawTags: false,
@@ -145,8 +145,8 @@ await baseConfig(eleventyConfig, {
 
 Live examples:
 
-- https://github.com/johnheenan/minform/blob/main/eleventy.config.js
-- https://github.com/hostfurl/minformhf/blob/main/eleventy.config.js
+- https://github.com/johnheenan/minform/blob/main/buildawesome.config.js
+- https://github.com/hostfurl/minformhf/blob/main/buildawesome.config.js
 
 <!--section:gh-only-->
 

package/{eleventy.config.js → buildawesome.config.js}

@@ -19,44 +19,44 @@ import path from "node:path";
 
 /**
  * Eleventy Configuration
- * @param {Object} eleventyConfig - The Eleventy configuration object
+ * @param {Object} $config - The Eleventy configuration object
  * @returns {Object} The Eleventy configuration object
  */
-export default async function (eleventyConfig, pluginOptions = {}) {
+export default async function ($config, pluginOptions = {}) {
   /* Dirs */
-  const inputDir = eleventyConfig.directories.input;
-  const outputDir = eleventyConfig.directories.output;
+  const inputDir = $config.directories.input;
+  const outputDir = $config.directories.output;
   const cwdIsDotEleventy = path.basename(process.cwd()) === ".11ty";
   if (cwdIsDotEleventy) {
     // Per https://www.11ty.dev/docs/config/#directory-for-includes
     // Order matters, put this at the top of your configuration file.
     // This is relative to your input directory!
-    eleventyConfig.setIncludesDirectory("./.11ty/_includes/");
+    $config.setIncludesDirectory("./.11ty/_includes/");
   }
 
   /* Plugins */
-  eleventyConfig.addBundle("css", { bundleHtmlContentFromSelector: "style" }); // per https://www.11ty.dev/docs/plugins/bundle/#bundling-html-node-content
-  eleventyConfig.addTransform("inject-css-bundle", function (content) {
+  $config.addBundle("css", { bundleHtmlContentFromSelector: "style" }); // per https://www.11ty.dev/docs/plugins/bundle/#bundling-html-node-content
+  $config.addTransform("inject-css-bundle", function (content) {
     const isHtml = typeof this.page.outputPath === "string" && this.page.outputPath.endsWith(".html");
-    const css = isHtml && eleventyConfig.getFilter("getBundle").call(this, "css");
+    const css = isHtml && $config.getFilter("getBundle").call(this, "css");
     return css ? content.replace("</head>", `<style>${css}</style></head>`) : content;
   });
-  eleventyConfig.addPlugin(RenderPlugin);
-  eleventyConfig.addPlugin(eleventyNavigationPlugin);
-  eleventyConfig.addPlugin(
+  $config.addPlugin(RenderPlugin);
+  $config.addPlugin(eleventyNavigationPlugin);
+  $config.addPlugin(
     kitPlugin,
     pluginOptions.plugins?.["@anyblades/buildawesome-kit-plugin"] ?? { mdAutoRawTags: true },
   );
-  eleventyConfig.addPlugin(pluginTOC, {
+  $config.addPlugin(pluginTOC, {
     ignoredElements: [".header-anchor", "sub"],
     ul: true,
     wrapper: (toc) => `${toc}`,
   });
   // Feed plugin
-  eleventyConfig.addCollection("feed", (collectionApi) =>
+  $config.addCollection("feed", (collectionApi) =>
     collectionApi.getAll().filter((item) => item.data.date || item.data.revised),
   );
-  eleventyConfig.addPlugin(feedPlugin, {
+  $config.addPlugin(feedPlugin, {
     // per https://www.11ty.dev/docs/plugins/rss/#virtual-template
     type: "atom", // or "rss", "json"
     outputPath: "/feed.xml",
@@ -93,23 +93,23 @@ export default async function (eleventyConfig, pluginOptions = {}) {
     .catch(() => {
       /* optional – skip if not installed */
     });
-  eleventyConfig.setLibrary("md", md);
+  $config.setLibrary("md", md);
   //```<!--section:code,markdownify-->```js
-  eleventyConfig.addFilter("markdownify", (content) => md.render(String(content ?? "")));
+  $config.addFilter("markdownify", (content) => md.render(String(content ?? "")));
   //```<!--section:code-->```js
 
   /* Data */
-  eleventyConfig.addDataExtension("yml,yaml", (contents) => YAML.parse(contents));
-  eleventyConfig.addGlobalData("layout", "default");
+  $config.addDataExtension("yml,yaml", (contents) => YAML.parse(contents));
+  $config.addGlobalData("layout", "default");
   // Sitemap
-  eleventyConfig.addTemplate("sitemap.xml.njk", "", {
+  $config.addTemplate("sitemap.xml.njk", "", {
     permalink: "/sitemap.xml",
     layout: "blades/sitemap.xml.njk",
     eleventyExcludeFromCollections: true,
   });
 
   /* Build */
-  eleventyConfig.addPassthroughCopy(
+  $config.addPassthroughCopy(
     {
       // From current working directory
       _public: "./",
@@ -123,19 +123,19 @@ export default async function (eleventyConfig, pluginOptions = {}) {
 
   /* Internal */
   // Jekyll templates compatibility
-  eleventyConfig.addFilter("relative_url", (content) => content); // dummy
-  eleventyConfig.setLiquidOptions({
+  $config.addFilter("relative_url", (content) => content); // dummy
+  $config.setLiquidOptions({
     dynamicPartials: false, // allows unquoted Jekyll-style includes
     root: [
-      eleventyConfig.directories.includes,
+      $config.directories.includes,
       fs.realpathSync(path.resolve("./node_modules/@anyblades/blades/_includes")), // for symlinks to work after https://github.com/harttle/liquidjs/pull/870
     ],
   });
   // Dev tools
-  eleventyConfig.setChokidarConfig({ followSymlinks: true }); // follow symlinks in Chokidar used by 11ty to watch files
+  $config.setChokidarConfig({ followSymlinks: true }); // follow symlinks in Chokidar used by 11ty to watch files
   if (cwdIsDotEleventy) {
-    eleventyConfig.watchIgnores.add(`../.11ty/${outputDir}`); // !!! avoid circular watching
-    eleventyConfig.watchIgnores.add("../.11ty/node_modules/"); // avoid performance issues
+    $config.watchIgnores.add(`../.11ty/${outputDir}`); // !!! avoid circular watching
+    $config.watchIgnores.add("../.11ty/node_modules/"); // avoid performance issues
   }
 }
 //```

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@anyblades/buildawesome-kit",
-  "version": "1.3.0-alpha",
+  "version": "1.3.0-alpha.2",
   "type": "module",
-  "main": "./eleventy.config.js",
+  "main": "./buildawesome.config.js",
   "dependencies": {
     "@11ty/eleventy-navigation": "^1.0.5",
     "@11ty/eleventy-plugin-rss": "^3.0.0",
     "@anyblades/blades": "^2.4.6",
-    "@anyblades/buildawesome-kit-plugin": "^1.3.0-0",
+    "@anyblades/buildawesome-kit-plugin": "^1.3.0-alpha.2",
     "@uncenter/eleventy-plugin-toc": "^2.1.1",
     "markdown-it": "^14.1.0",
     "markdown-it-anchor": "^9.2.0",
@@ -32,7 +32,7 @@
   ],
   "=== METADATA": "===",
   "author": "Anton Staroverov",
-  "description": "A ready-to-go `eleventy.config.js` for popular 11ty plugins, bundled with npm scripts in one reusable, zero-maintenance package.",
+  "description": "A ready-to-go `buildawesome.config.js` for popular 11ty plugins, bundled with npm scripts in one reusable, zero-maintenance package.",
   "homepage": "https://build.blades.ninja/",
   "keywords": [
     "11ty",

package/plugin/features/autoLinkFavicons.js

@@ -60,8 +60,8 @@ export function replaceLinksInHtml(content, transformer) {
   );
 }
 
-export default function (eleventyConfig) {
-  eleventyConfig.addTransform("autoLinkFavicons", function (content) {
+export default function ($config) {
+  $config.addTransform("autoLinkFavicons", function (content) {
     if (this.page.outputPath && this.page.outputPath.endsWith(".html")) {
       return replaceLinksInHtml(content, transformLink);
     }

package/plugin/features/mdAutoNl2br.js

@@ -12,8 +12,8 @@ export function transformNl2br(content) {
   return content.replace(/\\n\\n/g, "<br>").replace(/\\n/g, "<br>");
 }
 
-export default function mdAutoNl2br(eleventyConfig) {
-  eleventyConfig.amendLibrary("md", (mdLib) => {
+export default function mdAutoNl2br($config) {
+  $config.amendLibrary("md", (mdLib) => {
     mdLib.renderer.rules.text = (tokens, idx) => {
       return transformNl2br(tokens[idx].content);
     };

package/plugin/features/mdAutoRawTags.js

@@ -9,8 +9,8 @@ export function transformAutoRaw(content) {
   return content.replace(/({{|}}|{%|%})/g, "{% raw %}$1{% endraw %}");
 }
 
-export default function mdAutoRawTags(eleventyConfig) {
-  eleventyConfig.addPreprocessor("mdAutoRawTags", "md", (data, content) => {
+export default function mdAutoRawTags($config) {
+  $config.addPreprocessor("mdAutoRawTags", "md", (data, content) => {
     return transformAutoRaw(content);
   });
 }

package/plugin/features/mdAutoUncommentAttrs.js

@@ -16,8 +16,8 @@ export function transformUncommentAttrs(content) {
   return content;
 }
 
-export default function mdAutoUncommentAttrs(eleventyConfig) {
-  eleventyConfig.amendLibrary("md", (mdLib) => {
+export default function mdAutoUncommentAttrs($config) {
+  $config.amendLibrary("md", (mdLib) => {
     mdLib.core.ruler.before("normalize", "uncomment_attrs", (state) => {
       state.src = transformUncommentAttrs(state.src);
     });

package/plugin/features/siteData.js

@@ -31,8 +31,8 @@ export const siteData = (data) => {
   };
 };
 
-export default function (eleventyConfig) {
-  eleventyConfig.addGlobalData("eleventyComputed", {
+export default function ($config) {
+  $config.addGlobalData("eleventyComputed", {
     site: (data) => ({
       ...siteData(data),
       prod: process.env.ELEVENTY_RUN_MODE === "build",

package/plugin/features/virtualPages.js

@@ -6,13 +6,13 @@
 import { readFileSync } from "fs";
 import YAML from "js-yaml";
 
-export default function (eleventyConfig) {
+export default function ($config) {
   // Virtual pages
-  const pages = YAML.load(readFileSync(eleventyConfig.directories.input + "/pages.yaml", "utf8"));
+  const pages = YAML.load(readFileSync($config.directories.input + "/pages.yaml", "utf8"));
   for (const [index, data] of pages.entries()) {
     const virtualSlug = data.permalink ? data.permalink + "index" : index;
     // console.log(data, virtualSlug);
-    eleventyConfig.addTemplate("." + virtualSlug + ".md", "", data);
+    $config.addTemplate("." + virtualSlug + ".md", "", data);
   }
 }
 //```

package/plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anyblades/buildawesome-kit-plugin",
-  "version": "1.3.0-alpha",
+  "version": "1.3.0-alpha.2",
   "type": "module",
   "main": "./plugin.js",
   "exports": {

package/plugin/plugin.js

@@ -8,7 +8,7 @@ export const discoverModules = (dir) =>
       .map((f) => [f.replace(/\.js$/, ""), true]),
   );
 
-export default async function (eleventyConfig, userOptions) {
+export default async function ($config, userOptions) {
   //```<!--section:code,def-options-->```js
   const defaultOptions = { mdAutoRawTags: false };
   //```<!--section:code-->```js
@@ -31,7 +31,7 @@ export default async function (eleventyConfig, userOptions) {
     try {
       if (filterName == "fetch") await import("@11ty/eleventy-fetch");
       const filterFunc = (await import("./filters/" + filterName + ".js")).default;
-      eleventyConfig.addFilter(filterName, filterFunc);
+      $config.addFilter(filterName, filterFunc);
     } catch (error) {
       console.log("^ N/A ^");
     }
@@ -44,7 +44,7 @@ export default async function (eleventyConfig, userOptions) {
     console.log("Loading feature: " + featureName + "...");
     try {
       const featureConfig = (await import("./features/" + featureName + ".js")).default;
-      featureConfig(eleventyConfig);
+      featureConfig($config);
     } catch (error) {
       console.log("^ N/A ^");
     }