@salesforcedevs/sfdocs-liquid-lint-capture 0.0.3-alpha → 0.0.5-alpha

package/README.md

@@ -1,173 +1,76 @@
-# liquid-lint-capture
+# @salesforcedevs/sfdocs-liquid-lint-capture
 
-This Markdown plugin validates the correct usage of Liquid capture blocks based on file location.
+## Overview
 
-## What it checks
+This plugin validates that Liquid `{% capture %}` blocks are only used in reusable partial files within the `shared/partials/` directory. Using capture blocks outside of partials results in warnings.
 
-### For files in `shared/partials/`:
+### Features
 
-1. **Content must be in capture blocks**: All markdown content (except comments) must be inside `{% capture %}` blocks
-2. **No duplicate capture names**: Each capture variable name must be unique within the file
-3. **Allowed content outside capture blocks**:
-   - HTML comments: `<!-- comment -->`
-   - Liquid comments: `{% comment %}...{% endcomment %}`
-   - Whitespace
+✅ **Directory-Based Validation** - Warns when captures are outside `shared/partials/`  
+✅ **Code Block Protection** - Ignores capture blocks inside markdown code blocks  
+✅ **Accurate Line Numbers** - Reports exact location of violations  
+✅ **Test Coverage** - Comprehensive test suite included
 
-### For files outside `shared/partials/`:
+## Installation
 
-1. **Capture blocks are not allowed**: Files outside the partials folder must not contain `{% capture %}` blocks
-
-## Why
-
-Partial files in `shared/partials/` are reusable snippets that define Liquid variables via capture blocks. These variables are then consumed by other markdown files through includes. Enforcing this structure ensures:
-
-- Predictable variable definitions
-- No unintended content rendering
-- Prevent variable name collisions
-- Clear separation between partials and regular content
-
-Regular content files outside `shared/partials/` should not use capture blocks, as they are meant to render content directly, not define reusable variables. This validation prevents:
-
-- Misplaced variable definitions in content files
-- Confusion about file purpose and behavior
-- Accidental capture block usage outside the partials system
-
-## Examples
-
-### ✅ Valid
-
-**Single capture block:**
-```markdown
-{% capture my_variable %}
-# Heading
-
-Content goes here.
-{% endcapture %}
+```bash
+yarn add @salesforcedevs/sfdocs-liquid-lint-capture
 ```
 
-**Multiple captures with comments:**
-```markdown
-<!-- This file defines common callouts -->
+## Usage
 
-{% comment %}Success message{% endcomment %}
-{% capture success_msg %}
-:::tip
-Operation completed successfully!
-:::
-{% endcapture %}
+### Basic Usage
 
-{% capture error_msg %}
-:::warning
-An error occurred.
-:::
-{% endcapture %}
-```
+Register the plugin in your `lintConfig.ts`:
 
-**Capture with whitespace control:**
-```markdown
-{%- capture trimmed_content -%}
-No extra whitespace before/after
-{%- endcapture -%}
+```typescript
+const internalPluginsConf = {
+    /**
+     * Warns when capture blocks are used outside shared/partials folder.
+     * Capture blocks should be in reusable partials.
+     */
+    'liquid-capture-outside-partials': [
+        require('@salesforcedevs/sfdocs-liquid-lint-capture'),
+        ['warning']
+    ],
+};
 ```
 
-### ❌ Invalid
+## Rules
 
-**Content outside capture block:**
-```markdown
-# This heading is not captured
+### ✅ Allowed: Capture blocks in `shared/partials/`
 
-{% capture my_var %}
-Captured content
-{% endcapture %}
-```
-Error: `Content in shared/partials files must be inside capture blocks.`
+Capture blocks are **allowed** in any file path containing `/shared/partials/`:
 
-**Duplicate capture names:**
 ```markdown
-{% capture my_variable %}
-First definition
-{% endcapture %}
+<!-- File: /content/shared/partials/banner.md -->
 
-{% capture my_variable %}
-Duplicate definition
+{% capture title %}
+Welcome to our documentation
 {% endcapture %}
-```
-Error: `Duplicate capture block name "my_variable". This variable already exists in file.`
 
-**Mixed issues:**
-```markdown
-Regular paragraph outside capture.
-
-{% capture my_var %}First{% endcapture %}
-{% capture my_var %}Duplicate{% endcapture %}
-```
-Errors:
-- `Content in shared/partials files must be inside capture blocks.`
-- `Duplicate capture block name "my_var"`
-
-### ❌ Invalid (Files outside shared/partials)
-
-**Capture block in regular content file:**
-```markdown
-# Guide Title
-
-{% capture my_variable %}
-Some content
+{% capture description %}
+Learn how to use our API
 {% endcapture %}
-
-Regular content here.
 ```
-Error: `Capture blocks are not allowed in files outside shared/partials folder.`
-
-## File Scope
 
-This rule applies to **all** markdown files with different validation rules based on location:
+**Output:** ✅ No warnings
 
-### Files in `shared/partials/`:
-- **Must** use capture blocks for all content
-- **Must** have unique capture block names
-- `/content/shared/partials/common.md` ✅
-- `/docs/shared/partials/alerts.md` ✅
-- `shared/partials/buttons.md` ✅                                    
+### ⚠️ Warning: Capture blocks outside `shared/partials/`
 
-### Files outside `shared/partials/`:
-- **Must not** contain capture blocks
-- `/content/guides/example.md` ✅
-- `/shared/snippets/code.md` ✅
-- `docs/tutorials/intro.md` ✅ 
+Capture blocks **trigger warnings** in files outside the partials directory:
 
-## Install & build
-
-```bash
-yarn install && yarn build
-```
+```markdown
+<!-- File: /content/guides/tutorial.md -->
 
-## Testing
+# Getting Started
 
-```bash
-yarn test
+{% capture intro %}
+This is the introduction text
+{% endcapture %}
 ```
 
-## Usage
-
-In your unified pipeline:
-
-```typescript
-import unified from 'unified';
-import parse from 'remark-parse';
-import liquidLintPartialsCapture from '@salesforcedevs/sfdocs-liquid-lint-capture';
-
-const processor = unified()
-    .use(parse)
-    .use(liquidLintPartialsCapture);
-
-const file = await processor.process(markdownContent);
-
-if (file.messages.length > 0) {
-    file.messages.forEach(msg => {
-        console.log(`${msg.line}:${msg.column}: ${msg.message}`);
-    });
-}
+**Output:**
 ```
-
----
+3:1  warning  Capture blocks are not allowed in files outside shared/partials folder. Found capture block "intro".  liquid-capture-outside-partials
+```

package/coverage/clover.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<coverage generated="1781779022584" clover="3.2.0">
+  <project timestamp="1781779022584" name="All files">
+    <metrics statements="21" coveredstatements="21" conditionals="9" coveredconditionals="9" methods="3" coveredmethods="3" elements="33" coveredelements="33" complexity="0" loc="21" ncloc="21" packages="1" files="1" classes="1"/>
+    <file name="index.ts" path="/Users/sagarvk/Desktop/projects/sfdocs-lint/packages/liquid-lint-capture/src/index.ts">
+      <metrics statements="21" coveredstatements="21" conditionals="9" coveredconditionals="9" methods="3" coveredmethods="3"/>
+      <line num="5" count="1" type="stmt"/>
+      <line num="7" count="1" type="stmt"/>
+      <line num="9" count="1" type="stmt"/>
+      <line num="12" count="1" type="stmt"/>
+      <line num="21" count="31" type="stmt"/>
+      <line num="25" count="19" type="stmt"/>
+      <line num="26" count="19" type="stmt"/>
+      <line num="29" count="19" type="stmt"/>
+      <line num="30" count="19" type="stmt"/>
+      <line num="37" count="19" type="stmt"/>
+      <line num="42" count="32" type="cond" truecount="3" falsecount="0"/>
+      <line num="43" count="11" type="stmt"/>
+      <line num="46" count="21" type="cond" truecount="4" falsecount="0"/>
+      <line num="47" count="21" type="cond" truecount="1" falsecount="0"/>
+      <line num="49" count="19" type="stmt"/>
+      <line num="50" count="19" type="stmt"/>
+      <line num="52" count="19" type="cond" truecount="1" falsecount="0"/>
+      <line num="53" count="14" type="stmt"/>
+      <line num="54" count="19" type="stmt"/>
+      <line num="55" count="19" type="stmt"/>
+      <line num="64" count="1" type="stmt"/>
+    </file>
+  </project>
+</coverage>

package/coverage/coverage-final.json

@@ -0,0 +1,2 @@
+{"/Users/sagarvk/Desktop/projects/sfdocs-lint/packages/liquid-lint-capture/src/index.ts": {"path":"/Users/sagarvk/Desktop/projects/sfdocs-lint/packages/liquid-lint-capture/src/index.ts","statementMap":{"0":{"start":{"line":5,"column":0},"end":{"line":5,"column":37}},"1":{"start":{"line":7,"column":0},"end":{"line":7,"column":95}},"2":{"start":{"line":9,"column":15},"end":{"line":9,"column":50}},"3":{"start":{"line":12,"column":25},"end":{"line":12,"column":91}},"4":{"start":{"line":21,"column":4},"end":{"line":21,"column":50}},"5":{"start":{"line":25,"column":37},"end":{"line":25,"column":39}},"6":{"start":{"line":26,"column":15},"end":{"line":26,"column":55}},"7":{"start":{"line":29,"column":4},"end":{"line":35,"column":null}},"8":{"start":{"line":30,"column":8},"end":{"line":34,"column":11}},"9":{"start":{"line":37,"column":4},"end":{"line":37,"column":20}},"10":{"start":{"line":42,"column":4},"end":{"line":44,"column":null}},"11":{"start":{"line":43,"column":8},"end":{"line":43,"column":15}},"12":{"start":{"line":46,"column":16},"end":{"line":46,"column":43}},"13":{"start":{"line":47,"column":4},"end":{"line":47,"column":21}},"14":{"start":{"line":47,"column":14},"end":{"line":47,"column":21}},"15":{"start":{"line":49,"column":29},"end":{"line":49,"column":51}},"16":{"start":{"line":50,"column":26},"end":{"line":50,"column":64}},"17":{"start":{"line":52,"column":4},"end":{"line":60,"column":null}},"18":{"start":{"line":53,"column":8},"end":{"line":59,"column":null}},"19":{"start":{"line":54,"column":29},"end":{"line":54,"column":71}},"20":{"start":{"line":55,"column":12},"end":{"line":58,"column":14}},"21":{"start":{"line":64,"column":0},"end":{"line":64,"column":42}}},"fnMap":{"0":{"name":"isInPartialsFolder","decl":{"start":{"line":20,"column":9},"end":{"line":20,"column":27}},"loc":{"start":{"line":20,"column":44},"end":{"line":22,"column":1}}},"1":{"name":"extractCaptureBlocks","decl":{"start":{"line":24,"column":9},"end":{"line":24,"column":29}},"loc":{"start":{"line":24,"column":45},"end":{"line":38,"column":1}}},"2":{"name":"checkLiquidCapture","decl":{"start":{"line":40,"column":9},"end":{"line":40,"column":27}},"loc":{"start":{"line":40,"column":55},"end":{"line":62,"column":1}}}},"branchMap":{"0":{"loc":{"start":{"line":42,"column":4},"end":{"line":44,"column":null}},"type":"if","locations":[{"start":{"line":42,"column":4},"end":{"line":44,"column":null}}]},"1":{"loc":{"start":{"line":42,"column":8},"end":{"line":42,"column":51}},"type":"binary-expr","locations":[{"start":{"line":42,"column":8},"end":{"line":42,"column":18}},{"start":{"line":42,"column":22},"end":{"line":42,"column":51}}]},"2":{"loc":{"start":{"line":46,"column":23},"end":{"line":46,"column":42}},"type":"cond-expr","locations":[{"start":{"line":46,"column":36},"end":{"line":46,"column":40}},{"start":{"line":46,"column":40},"end":{"line":46,"column":42}}]},"3":{"loc":{"start":{"line":46,"column":23},"end":{"line":46,"column":40}},"type":"binary-expr","locations":[{"start":{"line":46,"column":23},"end":{"line":46,"column":40}},{"start":{"line":46,"column":36},"end":{"line":46,"column":40}}]},"4":{"loc":{"start":{"line":47,"column":4},"end":{"line":47,"column":21}},"type":"if","locations":[{"start":{"line":47,"column":4},"end":{"line":47,"column":21}}]},"5":{"loc":{"start":{"line":52,"column":4},"end":{"line":60,"column":null}},"type":"if","locations":[{"start":{"line":52,"column":4},"end":{"line":60,"column":null}}]}},"s":{"0":1,"1":1,"2":1,"3":1,"4":31,"5":19,"6":19,"7":19,"8":19,"9":19,"10":32,"11":11,"12":21,"13":21,"14":2,"15":19,"16":19,"17":19,"18":14,"19":19,"20":19,"21":1},"f":{"0":31,"1":19,"2":32},"b":{"0":[11],"1":[32,31],"2":[20,1],"3":[21,20],"4":[2],"5":[14]}}
+}

package/coverage/lcov-report/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/lcov-report/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selector that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);