@anydigital/11ty-bricks 1.0.0-alpha

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Anton Staroverov 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# 11ty-bricks
+
+A collection of helpful utilities and filters for Eleventy (11ty).
+
+## Installation
+
+```bash
+npm install @anydigital/11ty-bricks
+```
+
+## Usage
+
+You can use this library in two ways:
+
+### Option 1: As a Plugin
+
+Import and use the entire plugin. You can configure which helpers to enable using the options parameter:
+
+**ES Modules:**
+```javascript
+import eleventyBricks from "@anydigital/11ty-bricks";
+
+export default function(eleventyConfig) {
+  eleventyBricks(eleventyConfig, {
+    autoRaw: true  // Enable autoRaw preprocessor (default: false)
+  });
+  
+  // Your other configuration...
+}
+```
+
+**CommonJS:**
+```javascript
+const eleventyBricks = require("@anydigital/11ty-bricks");
+
+module.exports = function(eleventyConfig) {
+  eleventyBricks(eleventyConfig, {
+    autoRaw: true  // Enable autoRaw preprocessor (default: false)
+  });
+  
+  // Your other configuration...
+};
+```
+
+### Option 2: Import Individual Helpers (Recommended)
+
+Import only the specific helpers you need without using the plugin:
+
+**ES Modules:**
+```javascript
+import { autoRaw } from "@anydigital/11ty-bricks";
+
+export default function(eleventyConfig) {
+  autoRaw(eleventyConfig);
+  
+  // Your other configuration...
+}
+```
+
+**CommonJS:**
+```javascript
+const { autoRaw } = require("@anydigital/11ty-bricks");
+
+module.exports = function(eleventyConfig) {
+  autoRaw(eleventyConfig);
+  
+  // Your other configuration...
+};
+```
+
+## Configuration Options
+
+When using the plugin (Option 1), you can configure which helpers to enable:
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `autoRaw` | boolean | `false` | Enable the autoRaw preprocessor for Markdown files |
+
+**Example:**
+```javascript
+eleventyBricks(eleventyConfig, {
+  autoRaw: true
+});
+```
+
+## Available Helpers
+
+### autoRaw
+
+Prevents Nunjucks syntax from being processed in Markdown files by automatically wrapping `{{`, `}}`, `{%`, and `%}` with `{% raw %}` tags.
+
+**Why use this?**
+
+When writing documentation or tutorials about templating in Markdown files, you often want to show Nunjucks/Liquid syntax as literal text. This helper automatically escapes these special characters so they display as-is instead of being processed by the template engine.
+
+**Example:**
+
+Before `autoRaw`, writing this in Markdown:
+```markdown
+Use {{ variable }} to output variables.
+```
+
+Would try to process `{{ variable }}` as a template variable. With `autoRaw`, it displays exactly as written.
+
+## Requirements
+
+- Node.js >= 18.0.0
+- Eleventy >= 2.0.0
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@anydigital/11ty-bricks",
+  "version": "1.0.0-alpha",
+  "description": "A collection of helpful utilities and filters for Eleventy (11ty)",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.cjs"
+    }
+  },
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "test": "node --test src/**/*.test.js"
+  },
+  "keywords": [
+    "11ty",
+    "eleventy",
+    "plugin",
+    "helpers",
+    "filters",
+    "markdown",
+    "nunjucks"
+  ],
+  "author": "Anton Staroverov",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anydigital/11ty-bricks.git"
+  },
+  "bugs": {
+    "url": "https://github.com/anydigital/11ty-bricks/issues"
+  },
+  "homepage": "https://github.com/anydigital/11ty-bricks#readme",
+  "peerDependencies": {
+    "@11ty/eleventy": "^2.0.0 || ^3.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/autoRaw.js

@@ -0,0 +1,28 @@
+/**
+ * Transform Nunjucks syntax in content by wrapping it with raw tags
+ * 
+ * This function wraps Nunjucks syntax ({{, }}, {%, %}) with {% raw %} tags
+ * to prevent them from being processed by the template engine.
+ * 
+ * @param {string} content - The content to transform
+ * @returns {string} The transformed content with Nunjucks syntax wrapped
+ */
+export function transformAutoRaw(content) {
+  // This regex looks for {{, }}, {%, or %} individually and wraps them
+  return content.replace(/({{|}}|{%|%})/g, "{% raw %}$1{% endraw %}");
+}
+
+/**
+ * autoRaw - Forbid Nunjucks processing in Markdown files
+ * 
+ * This preprocessor wraps Nunjucks syntax ({{, }}, {%, %}) with {% raw %} tags
+ * to prevent them from being processed by the template engine in Markdown files.
+ * 
+ * @param {Object} eleventyConfig - The Eleventy configuration object
+ */
+export function autoRaw(eleventyConfig) {
+  eleventyConfig.addPreprocessor("autoRaw", "md", (data, content) => {
+    return transformAutoRaw(content);
+  });
+}
+

package/src/autoRaw.test.js

@@ -0,0 +1,87 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { transformAutoRaw } from "./autoRaw.js";
+
+describe("transformAutoRaw", () => {
+  it("should wrap opening double curly braces with raw tags", () => {
+    const input = "Use {{ variable }} to output.";
+    const expected =
+      "Use {% raw %}{{{% endraw %} variable {% raw %}}}{% endraw %} to output.";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should wrap closing double curly braces with raw tags", () => {
+    const input = "{{ name }}";
+    const expected =
+      "{% raw %}{{{% endraw %} name {% raw %}}}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should wrap opening template tags with raw tags", () => {
+    const input = "{% if condition %}";
+    const expected =
+      "{% raw %}{%{% endraw %} if condition {% raw %}%}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should wrap closing template tags with raw tags", () => {
+    const input = "{% endif %}";
+    const expected =
+      "{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should handle multiple Nunjucks patterns in one string", () => {
+    const input = "{{ var1 }} and {% if test %} something {% endif %}";
+    const expected =
+      "{% raw %}{{{% endraw %} var1 {% raw %}}}{% endraw %} and {% raw %}{%{% endraw %} if test {% raw %}%}{% endraw %} something {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should handle multiline content with Nunjucks syntax", () => {
+    const input = `# Title
+{{ variable }}
+Some text
+{% for item in items %}
+  {{ item }}
+{% endfor %}`;
+    const expected = `# Title
+{% raw %}{{{% endraw %} variable {% raw %}}}{% endraw %}
+Some text
+{% raw %}{%{% endraw %} for item in items {% raw %}%}{% endraw %}
+  {% raw %}{{{% endraw %} item {% raw %}}}{% endraw %}
+{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %}`;
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should return unchanged content when no Nunjucks syntax is present", () => {
+    const input = "This is just plain text with no templates.";
+    assert.equal(transformAutoRaw(input), input);
+  });
+
+  it("should handle empty string", () => {
+    assert.equal(transformAutoRaw(""), "");
+  });
+
+  it("should handle content with only Nunjucks syntax", () => {
+    const input = "{{}}";
+    const expected =
+      "{% raw %}{{{% endraw %}{% raw %}}}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should handle consecutive Nunjucks patterns", () => {
+    const input = "{{{{}}}}";
+    const expected =
+      "{% raw %}{{{% endraw %}{% raw %}{{{% endraw %}{% raw %}}}{% endraw %}{% raw %}}}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+
+  it("should wrap each delimiter individually", () => {
+    const input = "Show {{ and }} and {% and %}";
+    const expected =
+      "Show {% raw %}{{{% endraw %} and {% raw %}}}{% endraw %} and {% raw %}{%{% endraw %} and {% raw %}%}{% endraw %}";
+    assert.equal(transformAutoRaw(input), expected);
+  });
+});
+

package/src/index.cjs

@@ -0,0 +1,17 @@
+/**
+ * CommonJS wrapper for 11ty Bricks Plugin
+ * Provides compatibility for projects using require()
+ */
+
+// Dynamic import for ES modules
+module.exports = async function eleventyBricksPlugin(eleventyConfig, options) {
+  const { default: plugin } = await import('./index.js');
+  return plugin(eleventyConfig, options);
+};
+
+// Export individual helpers
+module.exports.autoRaw = async function(eleventyConfig) {
+  const { autoRaw } = await import('./index.js');
+  return autoRaw(eleventyConfig);
+};
+

package/src/index.js

@@ -0,0 +1,24 @@
+import { autoRaw } from "./autoRaw.js";
+
+/**
+ * 11ty Bricks Plugin
+ * 
+ * A collection of helpful utilities and filters for Eleventy (11ty).
+ * Can be used as a plugin or by importing individual helpers.
+ * 
+ * @param {Object} eleventyConfig - The Eleventy configuration object
+ * @param {Object} options - Plugin options
+ * @param {boolean} options.autoRaw - Enable autoRaw preprocessor (default: false)
+ */
+export default function eleventyBricksPlugin(eleventyConfig, options = {}) {
+  const { autoRaw: enableAutoRaw = false } = options;
+
+  // Register helpers based on options
+  if (enableAutoRaw) {
+    autoRaw(eleventyConfig);
+  }
+}
+
+// Export individual helpers for granular usage
+export { autoRaw };
+