@anydigital/eleventy-bricks 1.0.0-alpha.13 → 1.0.0-alpha.14

package/README.md

@@ -50,13 +50,12 @@ Import only the specific helpers you need without using the plugin:
 
 **ES Modules:**
 ```javascript
-import { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter, siteData } from "@anydigital/eleventy-bricks";
+import { bricks, mdAutoRawTags, mdAutoNl2br, setAttrFilter, byAttrFilter, siteData } from "@anydigital/eleventy-bricks";
 
 export default function(eleventyConfig) {
   bricks(eleventyConfig);
   mdAutoRawTags(eleventyConfig);
   mdAutoNl2br(eleventyConfig);
-  fragments(eleventyConfig);
   setAttrFilter(eleventyConfig);
   byAttrFilter(eleventyConfig);
   siteData(eleventyConfig);
@@ -67,13 +66,12 @@ export default function(eleventyConfig) {
 
 **CommonJS:**
 ```javascript
-const { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter, siteData } = require("@anydigital/eleventy-bricks");
+const { bricks, mdAutoRawTags, mdAutoNl2br, setAttrFilter, byAttrFilter, siteData } = require("@anydigital/eleventy-bricks");
 
 module.exports = async function(eleventyConfig) {
   await bricks(eleventyConfig);
   await mdAutoRawTags(eleventyConfig);
   await mdAutoNl2br(eleventyConfig);
-  await fragments(eleventyConfig);
   await setAttrFilter(eleventyConfig);
   await byAttrFilter(eleventyConfig);
   await siteData(eleventyConfig);
@@ -93,7 +91,6 @@ When using the plugin (Option 1), you can configure which helpers to enable:
 | `bricks` | boolean | `false` | Enable the bricks system for dependency management |
 | `mdAutoRawTags` | boolean | `false` | Enable the mdAutoRawTags preprocessor for Markdown files |
 | `mdAutoNl2br` | boolean | `false` | Enable the mdAutoNl2br preprocessor to convert \n to `<br>` tags |
-| `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 |
@@ -285,80 +282,6 @@ Will render as:
 
 **Note:** This processes literal `\n` sequences (backslash followed by 'n'), not actual newline characters. Type `\n` in your source files where you want line breaks.
 
-### fragment
-
-A shortcode that includes content from fragment files stored in the `_fragments` directory. The content will be processed by the template engine.
-
-**Why use this?**
-
-Fragments allow you to organize reusable content snippets in a dedicated directory and include them in your templates. This is useful for:
-- Reusable content blocks
-- Shared template sections
-- Component-like content organization
-
-**Usage:**
-
-1. Enable `fragments` in your Eleventy config:
-
-```javascript
-import { fragments } from "@anydigital/eleventy-bricks";
-
-export default function(eleventyConfig) {
-  fragments(eleventyConfig);
-  // Or use as plugin:
-  // eleventyConfig.addPlugin(eleventyBricks, { fragments: true });
-}
-```
-
-2. Create fragment files in the `_fragments` directory (relative to your input directory):
-
-```
-your-project/
-  _fragments/
-    header.njk
-    footer.njk
-    callout.md
-```
-
-3. Use the `fragment` shortcode in your templates:
-
-```njk
-{% fragment "header.njk" %}
-
-<main>
-  <!-- Your content -->
-</main>
-
-{% fragment "footer.njk" %}
-```
-
-**Parameters:**
-
-- `path`: The path to the fragment file relative to the `_fragments` directory
-
-**Features:**
-
-- Reads files from `_fragments` directory in your input directory
-- Content is processed by the template engine
-- Supports any template language that Eleventy supports
-- Shows helpful error comment if fragment is not found
-
-**Example:**
-
-Create `_fragments/callout.njk`:
-```njk
-<div class="callout callout-{{ type | default('info') }}">
-  {{ content }}
-</div>
-```
-
-Use it in your template:
-```njk
-{% set type = "warning" %}
-{% set content = "This is important!" %}
-{% fragment "callout.njk" %}
-```
-
 ### setAttr
 
 A filter that creates a new object with an overridden attribute value. This is useful for modifying data objects in templates without mutating the original.
@@ -595,7 +518,7 @@ The plugin also exports the following for advanced usage:
 
 ## Starter Configuration Files
 
-The package includes pre-configured starter files in `node_modules/@anydigital/eleventy-bricks/src/starter/` that you can symlink to your project for quick setup:
+The package includes pre-configured starter files in `node_modules/@anydigital/eleventy-bricks/src/` that you can symlink to your project for quick setup:
 
 ### Available Starter Files
 
@@ -616,7 +539,7 @@ npm install @11ty/eleventy-navigation markdown-it markdown-it-anchor js-yaml min
 
 **Symlink to your project:**
 ```bash
-ln -s node_modules/@anydigital/eleventy-bricks/src/starter/eleventy.config.js eleventy.config.js
+ln -s node_modules/@anydigital/eleventy-bricks/src/eleventy.config.js eleventy.config.js
 ```
 
 #### admin/index.html
@@ -626,7 +549,7 @@ A ready-to-use Sveltia CMS admin interface for content management.
 **Symlink to your project:**
 ```bash
 mkdir -p admin
-ln -s ../node_modules/@anydigital/eleventy-bricks/src/starter/admin/index.html admin/index.html
+ln -s ../node_modules/@anydigital/eleventy-bricks/src/admin/index.html admin/index.html
 ```
 
 ### Benefits of Symlinking
@@ -641,9 +564,9 @@ ln -s ../node_modules/@anydigital/eleventy-bricks/src/starter/admin/index.html a
 If you prefer to customize the configurations extensively, you can copy the files instead:
 
 ```bash
-cp node_modules/@anydigital/eleventy-bricks/src/starter/eleventy.config.js .
+cp node_modules/@anydigital/eleventy-bricks/src/eleventy.config.js .
 mkdir -p admin
-cp node_modules/@anydigital/eleventy-bricks/src/starter/admin/index.html admin/
+cp node_modules/@anydigital/eleventy-bricks/src/admin/index.html admin/
 ```
 
 ## CLI Helper Commands

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anydigital/eleventy-bricks",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.14",
   "description": "A collection of helpful utilities and filters for Eleventy (11ty)",
   "type": "module",
   "main": "./src/index.js",
@@ -46,6 +46,6 @@
     "node": ">=18.0.0"
   },
   "_downloadFiles": {
-    "https://raw.githubusercontent.com/danurbanowicz/eleventy-sveltia-cms-starter/refs/heads/master/admin/index.html": "src/starter/admin/index.html"
+    "https://raw.githubusercontent.com/danurbanowicz/eleventy-sveltia-cms-starter/refs/heads/master/admin/index.html": "src/admin/index.html"
   }
 }

package/src/{starter/eleventy.config.js → eleventy.config.js}

@@ -25,7 +25,6 @@ export default function(eleventyConfig) {
   eleventyConfig.addPlugin(eleventyNavigationPlugin);
   eleventyConfig.addPlugin(eleventyBricksPlugin, {
     bricks: true,
-    fragments: true,
     mdAutoNl2br: true,
     mdAutoRawTags: true,
     setAttrFilter: true,

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', 'siteData'].forEach(name => {
+['bricks', 'mdAutoRawTags', 'mdAutoNl2br', 'setAttrFilter', 'byAttrFilter', 'siteData'].forEach(name => {
   module.exports[name] = async (eleventyConfig) => {
     const module = await import('./index.js');
     return module[name](eleventyConfig);

package/src/index.js

@@ -1,6 +1,5 @@
 import { bricks } from "./bricks.js";
 import { mdAutoRawTags, mdAutoNl2br, transformAutoRaw, transformNl2br } from "./markdown.js";
-import { fragments } from "./fragments.js";
 import { setAttrFilter } from "./setAttrFilter.js";
 import { byAttrFilter } from "./byAttrFilter.js";
 import { siteData } from "./siteData.js";
@@ -16,18 +15,17 @@ import { siteData } from "./siteData.js";
  * @param {boolean} options.bricks - Enable bricks system with dependencies injection (default: false)
  * @param {boolean} options.mdAutoRawTags - Enable mdAutoRawTags preprocessor (default: false)
  * @param {boolean} options.mdAutoNl2br - Enable mdAutoNl2br for \n to <br> conversion (default: false)
- * @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 and site.isProd global data (default: false)
  */
 export default function eleventyBricksPlugin(eleventyConfig, options = {}) {
-  const plugins = { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter, siteData };
+  const plugins = { bricks, mdAutoRawTags, mdAutoNl2br, 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, siteData };
+export { bricks, mdAutoRawTags, mdAutoNl2br, setAttrFilter, byAttrFilter, siteData };
 
 // Export transform functions for advanced usage
 export { transformAutoRaw, transformNl2br };

package/src/fragments.js

@@ -1,34 +0,0 @@
-import { readFileSync } from "fs";
-import { join } from "path";
-
-/**
- * fragment shortcode - Include content from fragments
- * 
- * This shortcode reads a file from the _fragments directory and includes
- * its content. The content will be processed by the template engine.
- * 
- * @param {Object} eleventyConfig - The Eleventy configuration object
- */
-export function fragments(eleventyConfig) {
-  eleventyConfig.addShortcode("fragment", function(path) {
-    // Get the input directory from Eleventy's context
-    const inputDir = this.page?.inputPath 
-      ? join(process.cwd(), eleventyConfig.dir?.input || ".") 
-      : process.cwd();
-    
-    // Construct the full path to the fragment file
-    const fragmentPath = join(inputDir, "_fragments", path);
-    
-    try {
-      // Read the fragment file
-      const content = readFileSync(fragmentPath, "utf8");
-      
-      // Return content to be processed by the template engine
-      return content;
-    } catch (error) {
-      console.error(`Error reading fragment at ${fragmentPath}:`, error.message);
-      return `<!-- Fragment not found: ${path} -->`;
-    }
-  });
-}
-