@anydigital/11ty-bricks 1.0.0-alpha.8 → 1.0.0-alpha.9

package/README.md

@@ -48,11 +48,12 @@ Import only the specific helpers you need without using the plugin:
 
 **ES Modules:**
 ```javascript
-import { bricks, mdAutoRawTags } from "@anydigital/11ty-bricks";
+import { bricks, mdAutoRawTags, siteData } from "@anydigital/11ty-bricks";
 
 export default function(eleventyConfig) {
   bricks(eleventyConfig);
   mdAutoRawTags(eleventyConfig);
+  siteData(eleventyConfig);
   
   // Your other configuration...
 }
@@ -60,11 +61,12 @@ export default function(eleventyConfig) {
 
 **CommonJS:**
 ```javascript
-const { bricks, mdAutoRawTags } = require("@anydigital/11ty-bricks");
+const { bricks, mdAutoRawTags, siteData } = require("@anydigital/11ty-bricks");
 
 module.exports = function(eleventyConfig) {
   bricks(eleventyConfig);
   mdAutoRawTags(eleventyConfig);
+  siteData(eleventyConfig);
   
   // Your other configuration...
 };
@@ -82,13 +84,15 @@ When using the plugin (Option 1), you can configure which helpers to enable:
 | `fragments` | boolean | `false` | Enable the fragment shortcode for including content from fragments |
 | `setAttrFilter` | boolean | `false` | Enable the setAttr filter for overriding object attributes |
 | `byAttrFilter` | boolean | `false` | Enable the byAttr filter for filtering collections by attribute values |
+| `siteData` | boolean | `false` | Enable site.year and site.isProd global data |
 
 **Example:**
 ```javascript
 eleventyConfig.addPlugin(eleventyBricks, {
   bricks: true,
   mdAutoRawTags: true,
-  byAttrFilter: true
+  byAttrFilter: true,
+  siteData: true
 });
 ```
 
@@ -282,13 +286,13 @@ Fragments allow you to organize reusable content snippets in a dedicated directo
 
 **Usage:**
 
-1. Enable `fragment` in your Eleventy config:
+1. Enable `fragments` in your Eleventy config:
 
 ```javascript
-import { fragment } from "@anydigital/11ty-bricks";
+import { fragments } from "@anydigital/11ty-bricks";
 
 export default function(eleventyConfig) {
-  fragment(eleventyConfig);
+  fragments(eleventyConfig);
   // Or use as plugin:
   // eleventyConfig.addPlugin(eleventyBricks, { fragments: true });
 }
@@ -496,6 +500,80 @@ Template usage:
 {% set recentBlogPosts = collections.all | byAttr('category', 'blog') | reverse | limit(5) %}
 ```
 
+### siteData
+
+Adds global site data to your Eleventy project, providing commonly needed values that can be accessed in all templates.
+
+**Why use this?**
+
+Many websites need access to the current year (for copyright notices) and environment information (to conditionally enable features based on production vs development). This helper provides these as global `site` data without manually setting them up.
+
+**Usage:**
+
+1. Enable `siteData` in your Eleventy config:
+
+```javascript
+import { siteData } from "@anydigital/11ty-bricks";
+
+export default function(eleventyConfig) {
+  siteData(eleventyConfig);
+  // Or use as plugin:
+  // eleventyConfig.addPlugin(eleventyBricks, { siteData: true });
+}
+```
+
+2. Use the global data in your templates:
+
+**Current Year:**
+```njk
+<footer>
+  <p>&copy; {{ site.year }} Your Company Name. All rights reserved.</p>
+</footer>
+```
+
+**Environment Check:**
+```njk
+{% if site.isProd %}
+  <!-- Production-only features -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=GA_TRACKING_ID"></script>
+{% else %}
+  <!-- Development-only features -->
+  <div class="dev-toolbar">Development Mode</div>
+{% endif %}
+```
+
+**Available Data:**
+
+- `site.year`: The current year as a number (e.g., `2026`)
+- `site.isProd`: Boolean indicating if running in production mode (`true` for `eleventy build`, `false` for `eleventy serve`)
+
+**Features:**
+
+- Automatically updates the year value
+- Detects production vs development mode based on `ELEVENTY_RUN_MODE` environment variable
+- Available globally in all templates without manual setup
+- No configuration required
+
+**Examples:**
+
+```njk
+{# Copyright notice #}
+<p>Copyright &copy; {{ site.year }} My Site</p>
+
+{# Conditional loading of analytics #}
+{% if site.isProd %}
+  <script src="/analytics.js"></script>
+{% endif %}
+
+{# Different behavior in dev vs prod #}
+{% if site.isProd %}
+  <link rel="stylesheet" href="/css/styles.min.css">
+{% else %}
+  <link rel="stylesheet" href="/css/styles.css">
+  <script src="/live-reload.js"></script>
+{% endif %}
+```
+
 ### Additional Exports
 
 The plugin also exports the following for advanced usage:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anydigital/11ty-bricks",
-  "version": "1.0.0-alpha.8",
+  "version": "1.0.0-alpha.9",
   "description": "A collection of helpful utilities and filters for Eleventy (11ty)",
   "type": "module",
   "main": "./src/index.js",

package/src/index.cjs

@@ -10,7 +10,7 @@ module.exports = async function eleventyBricksPlugin(eleventyConfig, options) {
 };
 
 // Export individual helpers for granular usage
-['bricks', 'mdAutoRawTags', 'mdAutoNl2br', 'fragments', 'setAttrFilter', 'byAttrFilter'].forEach(name => {
+['bricks', 'mdAutoRawTags', 'mdAutoNl2br', 'fragments', 'setAttrFilter', 'byAttrFilter', 'siteData'].forEach(name => {
   module.exports[name] = async (eleventyConfig) => {
     const module = await import('./index.js');
     return module[name](eleventyConfig);

package/src/index.js

@@ -3,6 +3,7 @@ import { mdAutoRawTags, mdAutoNl2br, transformAutoRaw, transformNl2br } from "./
 import { fragments } from "./fragments.js";
 import { setAttrFilter } from "./setAttrFilter.js";
 import { byAttrFilter } from "./byAttrFilter.js";
+import { siteData } from "./siteData.js";
 
 /**
  * 11ty Bricks Plugin
@@ -18,14 +19,15 @@ import { byAttrFilter } from "./byAttrFilter.js";
  * @param {boolean} options.fragments - Enable fragment shortcode (default: false)
  * @param {boolean} options.setAttrFilter - Enable setAttr filter (default: false)
  * @param {boolean} options.byAttrFilter - Enable byAttr filter (default: false)
+ * @param {boolean} options.siteData - Enable site.year global data (default: false)
  */
 export default function eleventyBricksPlugin(eleventyConfig, options = {}) {
-  const plugins = { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter };
+  const plugins = { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter, siteData };
   Object.entries(options).forEach(([key, enabled]) => enabled && plugins[key]?.(eleventyConfig));
 }
 
 // Export individual helpers for granular usage
-export { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter };
+export { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter, siteData };
 
 // Export transform functions for advanced usage
 export { transformAutoRaw, transformNl2br };

package/src/siteData.js

@@ -0,0 +1,12 @@
+/**
+ * Add site.year and site.isProd global data
+ * - site.isProd: Boolean indicating if running in production mode (build) vs development (serve)
+ * - site.year: Sets the current year to be available in all templates as {{ site.year }}
+ * 
+ * @param {Object} eleventyConfig - The Eleventy configuration object
+ */
+export function siteData(eleventyConfig) {
+  eleventyConfig.addGlobalData("site.isProd", () => process.env.ELEVENTY_RUN_MODE === "build");
+  eleventyConfig.addGlobalData("site.year", () => new Date().getFullYear());
+}
+