@anyblades/buildawesome-kit-plugin 1.3.0-alpha

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@anyblades/buildawesome-kit-plugin",
+  "version": "1.3.0-alpha",
+  "type": "module",
+  "main": "./plugin.js",
+  "exports": {
+    ".": "./plugin.js",
+    "./features/*": "./features/*"
+  },
+  "peerDependencies": {
+    "@11ty/eleventy": "^3.0.0 || ^4.0.0-0",
+    "@awesome.me/buildawesome": "^3.0.0 || ^4.0.0-0"
+  },
+  "peerDependenciesMeta": {
+    "@11ty/eleventy": {
+      "optional": true
+    },
+    "@awesome.me/buildawesome": {
+      "optional": true
+    }
+  },
+  "=== DEV ONLY": "===",
+  "scripts": {
+    "test": "node --test ./**/*.test.js",
+    "prepublishOnly": "npm run test"
+  },
+  "devDependencies": {
+    "@11ty/lodash-custom": "^4.17.21"
+  },
+  "=== METADATA": "===",
+  "author": "Anton Staroverov",
+  "description": "Essential 11ty filters, pre/post-processors, and other toggleable features as a simple, configurable plugin",
+  "homepage": "https://build.blades.ninja/plugin/",
+  "keywords": [
+    "11ty",
+    "buildawesome",
+    "eleventy",
+    "filters",
+    "plugin"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anyblades/buildawesome-kit.git",
+    "directory": "plugin/"
+  },
+  "===": "==="
+}

package/plugin.js

@@ -0,0 +1,53 @@
+//<!--section:code-->```js
+import { readdirSync } from "node:fs";
+
+export const discoverModules = (dir) =>
+  Object.fromEntries(
+    readdirSync(new URL(dir, import.meta.url))
+      .filter((f) => f.endsWith(".js") && !f.endsWith(".test.js"))
+      .map((f) => [f.replace(/\.js$/, ""), true]),
+  );
+
+export default async function (eleventyConfig, userOptions) {
+  //```<!--section:code,def-options-->```js
+  const defaultOptions = { mdAutoRawTags: false };
+  //```<!--section:code-->```js
+  const options = Object.assign(
+    {},
+    discoverModules("./features"),
+    { filters: discoverModules("./filters") },
+    defaultOptions,
+    userOptions,
+  );
+  // console.log("[options]", defaultOptions, userOptions, options);
+
+  /* FILTERS
+   * Fallback to default list if options.filters doesn't exist
+   * By using import.meta.url, Node figures out exactly where your script is installed inside their node_modules folder and targets the directory relative to that script.
+   */
+  const filterNames = Object.entries(options.filters).filter(([, v]) => v);
+  for (const [filterName] of filterNames) {
+    console.log("Loading filter: " + filterName + "...");
+    try {
+      if (filterName == "fetch") await import("@11ty/eleventy-fetch");
+      const filterFunc = (await import("./filters/" + filterName + ".js")).default;
+      eleventyConfig.addFilter(filterName, filterFunc);
+    } catch (error) {
+      console.log("^ N/A ^");
+    }
+  }
+
+  /* FEATURES */
+  delete options.filters;
+  const featureNames = Object.entries(options).filter(([, v]) => v);
+  for (const [featureName] of featureNames) {
+    console.log("Loading feature: " + featureName + "...");
+    try {
+      const featureConfig = (await import("./features/" + featureName + ".js")).default;
+      featureConfig(eleventyConfig);
+    } catch (error) {
+      console.log("^ N/A ^");
+    }
+  }
+}
+//```

package/plugin.test.js

@@ -0,0 +1,8 @@
+import { test } from "node:test";
+import assert from "node:assert";
+import { discoverModules } from "./plugin.js";
+
+test("discoverModules - project root returns only 'plugin'", () => {
+  const result = discoverModules("./");
+  assert.deepStrictEqual(result, { plugin: true });
+});

package/scripts/README.md

@@ -0,0 +1,59 @@
+This package provides a pre-configured `do` folder setup that helps organize your development workflow using npm workspaces. The `do` folder contains scripts for building and running your Eleventy project.
+
+## Install
+
+1. Install https://github.com/anyblades/eleventy-blades to reuse pre-defined 11ty scripts from there:
+
+```sh
+npm install @anyblades/eleventy-blades
+```
+
+2. Create a helper folder `do` to symlink the `do/package.json` within:
+
+```sh
+mkdir do
+cd do/
+ln -s ../node_modules/@anyblades/eleventy-blades/packages/do/package.json
+```
+
+3. Finally register `do` folder as npm workspace in your root `package.json`:
+
+```json {data-caption=./package.json}
+{
+  ...
+  "workspaces": ["do"],
+  "scripts": {
+    "start": "npm -w do run start",
+    "stage": "npm -w do run stage",
+    "build": "npm -w do run build"
+  },
+  ...
+}
+```
+
+**Done!** 🎉 Now you can run:
+
+- `npm start` to start 11ty dev server with live reload and Tailwind watch mode
+- `npm run stage` to build and serve production-like site locally
+- `npm run build` to finally build the site for production
+- all available scripts: https://github.com/anyblades/eleventy-blades/blob/main/packages/do/package.json
+
+## Live examples
+
+- https://github.com/anyblades/buildawesome-starters
+- https://github.com/anyblades/subtle/tree/main/.11ty
+- https://github.com/johnheenan/minform
+
+## Benefits
+
+**Clean separation**
+: Keep build scripts separate from project configuration
+
+**Reusable workflows**
+: Update scripts by upgrading the package
+
+**Workspace isolation**
+: Scripts run in their own workspace context
+
+**Easy maintenance**
+: No need to manually maintain build scripts

package/scripts/package.json

@@ -0,0 +1,17 @@
+{
+  "private": true,
+  "name": "do",
+  "scripts": {
+    "=== START": "with-tw: 1) `&` for parallel run 2) `tw` is last to stay alive 3) trap/wait for graceful exit",
+    "start": "npm run 11ty -- --serve --incremental",
+    "start:with-tw": "trap 'kill 0' INT; npm start & npm run tw -- --watch & wait",
+    "=== STAGE": "1) `rm -r` w/o trailing slash to avoid symlink catastrophe! 2) `;` to bypass no dir errors",
+    "stage": "rm -r ../_site; npm run build && serve ../_site/",
+    "=== BUILD": "`;` to make `tw` optional",
+    "build": "npm run tw; npm run 11ty",
+    "=== INNER": "commands written so that extra arguments can be passed",
+    "11ty": "cd ../ && NODE_OPTIONS='--preserve-symlinks' eleventy ${ELTY_OPTIONS}",
+    "tw": "[ -z \"$TW_OPTIONS\" ] && exit 0; cd ../ && tailwindcss ${TW_OPTIONS}",
+    "dev:blades": "cd ../ && npm link @anyblades/eleventy-blades-base && cd ./node_modules/@anyblades/ && ln -sf ./eleventy-blades-base/node_modules/@anyblades/*blades* ./ && cd eleventy-blades-base && npm link @anyblades/blades @anyblades/eleventy-blades"
+  }
+}