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

package/src/__tests__/index.test.ts

@@ -11,19 +11,22 @@ const processMarkdown = (md: string, filePath: string): VFile => {
         .processSync(file);
 };
 
-describe('sfdocs-liquid-lint:partials-capture', () => {
-    describe('file path filtering', () => {
-        test('ignores regular content in files not in shared/partials folder', () => {
+describe('sfdocs-liquid-lint:liquid-capture-outside-partials', () => {
+    describe('files outside shared/partials', () => {
+        test('ignores regular content without capture blocks', () => {
             const md = dedent(`
                 # This is a regular heading
 
                 Some content here.
+
+                - List item
+                - Another item
             `);
             const result = processMarkdown(md, '/content/guides/example.md');
             expect(result.messages).toHaveLength(0);
         });
 
-        test('disallows capture blocks in files outside shared/partials folder', () => {
+        test('warns when capture block is found outside shared/partials', () => {
             const md = dedent(`
                 # This is a regular heading
 
@@ -32,25 +35,27 @@ describe('sfdocs-liquid-lint:partials-capture', () => {
                 {% endcapture %}
             `);
             const result = processMarkdown(md, '/content/guides/example.md');
+
             expect(result.messages).toHaveLength(1);
             expect(result.messages[0].message).toContain('Capture blocks are not allowed in files outside shared/partials folder');
             expect(result.messages[0].message).toContain('my_var');
         });
 
-        test('reports all capture blocks in non-partials files', () => {
+        test('warns for all capture blocks in non-partials files', () => {
             const md = dedent(`
                 {% capture var1 %}Content 1{% endcapture %}
                 {% capture var2 %}Content 2{% endcapture %}
                 {% capture var3 %}Content 3{% endcapture %}
             `);
             const result = processMarkdown(md, '/docs/guides/example.md');
+
             expect(result.messages).toHaveLength(3);
             expect(result.messages[0].message).toContain('var1');
             expect(result.messages[1].message).toContain('var2');
             expect(result.messages[2].message).toContain('var3');
         });
 
-        test('allows normal content but disallows only captures in non-partials', () => {
+        test('warns for captures mixed with normal content', () => {
             const md = dedent(`
                 # Normal Heading
 
@@ -59,20 +64,21 @@ describe('sfdocs-liquid-lint:partials-capture', () => {
                 - List item 1
                 - List item 2
 
-                {% capture should_fail %}Captured content{% endcapture %}
+                {% capture should_warn %}Captured content{% endcapture %}
 
                 More normal content here.
 
-                {% capture also_fails %}Another capture{% endcapture %}
+                {% capture also_warns %}Another capture{% endcapture %}
             `);
             const result = processMarkdown(md, '/docs/guide.md');
+
             expect(result.messages).toHaveLength(2);
             expect(result.messages[0].message).toContain('not allowed in files outside shared/partials');
-            expect(result.messages[0].message).toContain('should_fail');
-            expect(result.messages[1].message).toContain('also_fails');
+            expect(result.messages[0].message).toContain('should_warn');
+            expect(result.messages[1].message).toContain('also_warns');
         });
 
-        test('reports correct line positions for captures in non-partials', () => {
+        test('reports correct line numbers for captures', () => {
             const md = dedent(`
                 # Title
 
@@ -83,33 +89,76 @@ describe('sfdocs-liquid-lint:partials-capture', () => {
                 {% capture var2 %}Second{% endcapture %}
             `);
             const result = processMarkdown(md, '/docs/page.md');
+
             expect(result.messages).toHaveLength(2);
             expect(result.messages[0].line).toBe(3);
             expect(result.messages[1].line).toBe(7);
         });
 
-        test('validates files in shared/partials folder', () => {
+        test('warns for capture blocks with whitespace control', () => {
+            const md = '{%- capture my_var -%}Content{%- endcapture -%}';
+            const result = processMarkdown(md, '/content/docs/page.md');
+
+            expect(result.messages).toHaveLength(1);
+            expect(result.messages[0].message).toContain('not allowed in files outside shared/partials');
+            expect(result.messages[0].message).toContain('my_var');
+        });
+
+        test('warns for captures in various non-partials directories', () => {
+            const md = '{% capture test %}Content{% endcapture %}';
+            const paths = [
+                '/content/guides/intro.md',
+                '/docs/api/endpoints.md',
+                '/tutorials/getting-started.md',
+                '/content/shared/components/card.md',  // Not in partials
+            ];
+
+            paths.forEach(path => {
+                const result = processMarkdown(md, path);
+                expect(result.messages).toHaveLength(1);
+                expect(result.messages[0].message).toContain('not allowed in files outside shared/partials');
+            });
+        });
+
+        test('handles multiline capture content', () => {
             const md = dedent(`
-                # This is a heading
+                {% capture multiline %}
+                Line 1
+                Line 2
+                Line 3
+                {% endcapture %}
             `);
-            const result = processMarkdown(md, '/content/shared/partials/example.md');
-            expect(result.messages.length).toBeGreaterThan(0);
-            expect(result.messages[0].message).toContain('must be inside capture blocks');
+            const result = processMarkdown(md, '/content/tutorial.md');
+
+            expect(result.messages).toHaveLength(1);
+            expect(result.messages[0].message).toContain('multiline');
+        });
+
+        test('handles variable names with underscores and numbers', () => {
+            const md = dedent(`
+                {% capture my_var_123 %}Content{% endcapture %}
+                {% capture another_var_456 %}More content{% endcapture %}
+            `);
+            const result = processMarkdown(md, '/docs/test.md');
+
+            expect(result.messages).toHaveLength(2);
+            expect(result.messages[0].message).toContain('my_var_123');
+            expect(result.messages[1].message).toContain('another_var_456');
         });
     });
 
-    describe('valid capture blocks in partials', () => {
-        test('allows single capture block', () => {
+    describe('files inside shared/partials', () => {
+        test('allows capture blocks in shared/partials folder', () => {
             const md = dedent(`
                 {% capture my_variable %}
                 This is captured content.
                 {% endcapture %}
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+            const result = processMarkdown(md, '/content/shared/partials/example.md');
             expect(result.messages).toHaveLength(0);
         });
 
-        test('allows multiple capture blocks with different names', () => {
+        test('allows multiple capture blocks in partials', () => {
             const md = dedent(`
                 {% capture var1 %}
                 Content 1
@@ -127,7 +176,7 @@ describe('sfdocs-liquid-lint:partials-capture', () => {
             expect(result.messages).toHaveLength(0);
         });
 
-        test('allows capture blocks with whitespace control', () => {
+        test('allows capture blocks with whitespace control in partials', () => {
             const md = dedent(`
                 {%- capture my_variable -%}
                 Trimmed content
@@ -137,310 +186,178 @@ describe('sfdocs-liquid-lint:partials-capture', () => {
             expect(result.messages).toHaveLength(0);
         });
 
-        test('disallows whitespace-controlled captures in non-partials', () => {
-            const md = '{%- capture my_var -%}Content{%- endcapture -%}';
-            const result = processMarkdown(md, '/content/docs/page.md');
-            expect(result.messages).toHaveLength(1);
-            expect(result.messages[0].message).toContain('not allowed in files outside shared/partials');
-            expect(result.messages[0].message).toContain('my_var');
-        });
-
-        test('allows capture blocks with markdown content inside', () => {
-            const md = dedent(`
-                {% capture rich_content %}
-                # Heading inside capture
+        test('allows captures in various partials paths', () => {
+            const md = '{% capture test %}Content{% endcapture %}';
+            const paths = [
+                '/content/shared/partials/banner.md',
+                '/docs/shared/partials/footer.md',
+                '/api/v1/shared/partials/header.md',
+            ];
 
-                This is a paragraph with **bold** and *italic*.
-
-                - List item 1
-                - List item 2
-                {% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(0);
+            paths.forEach(path => {
+                const result = processMarkdown(md, path);
+                expect(result.messages).toHaveLength(0);
+            });
         });
-    });
 
-    describe('comments', () => {
-        test('allows HTML comments', () => {
+        test('allows regular content in partials', () => {
             const md = dedent(`
-                <!-- This is an HTML comment -->
-                {% capture my_var %}Content{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(0);
-        });
-
-        test('allows multi-line HTML comments', () => {
-            const md = dedent(`
-                <!--
-                This is a multi-line
-                HTML comment
-                -->
-                {% capture my_var %}Content{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(0);
-        });
+                # Heading in partials
 
-        test('allows Liquid comment blocks', () => {
-            const md = dedent(`
-                {% comment %}
-                This is a Liquid comment
-                {% endcomment %}
-                {% capture my_var %}Content{% endcapture %}
+                Regular content is allowed here.
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+            const result = processMarkdown(md, '/content/shared/partials/test.md');
             expect(result.messages).toHaveLength(0);
         });
 
-        test('allows Liquid comments with whitespace control', () => {
-            const md = dedent(`
-                {%- comment -%}
-                Trimmed comment
-                {%- endcomment -%}
-                {% capture my_var %}Content{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+        test('allows empty files in partials', () => {
+            const result = processMarkdown('', '/content/shared/partials/empty.md');
             expect(result.messages).toHaveLength(0);
         });
 
-        test('allows mix of HTML and Liquid comments', () => {
+        test('allows capture blocks with markdown content inside', () => {
             const md = dedent(`
-                <!-- HTML comment -->
-                {% comment %}Liquid comment{% endcomment %}
-                {% capture my_var %}Content{% endcapture %}
-                <!-- Another HTML comment -->
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(0);
-        });
-    });
+                {% capture rich_content %}
+                # Heading
 
-    describe('duplicate capture names', () => {
-        test('reports duplicate capture block names', () => {
-            const md = dedent(`
-                {% capture my_variable %}
-                First capture
-                {% endcapture %}
+                **Bold text** and *italic*.
 
-                {% capture my_variable %}
-                Duplicate capture
+                - List item
                 {% endcapture %}
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(1);
-            expect(result.messages[0].message).toContain('Duplicate capture block name "my_variable"');
-        });
-
-        test('reports multiple duplicates', () => {
-            const md = dedent(`
-                {% capture var1 %}First{% endcapture %}
-                {% capture var2 %}First{% endcapture %}
-                {% capture var1 %}Duplicate 1{% endcapture %}
-                {% capture var2 %}Duplicate 2{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(2);
-            expect(result.messages[0].message).toContain('Duplicate capture block name "var1"');
-            expect(result.messages[1].message).toContain('Duplicate capture block name "var2"');
-        });
-
-        test('reports all occurrences after the first', () => {
-            const md = dedent(`
-                {% capture my_var %}First{% endcapture %}
-                {% capture my_var %}Second{% endcapture %}
-                {% capture my_var %}Third{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(2);
+            const result = processMarkdown(md, '/content/shared/partials/rich.md');
+            expect(result.messages).toHaveLength(0);
         });
     });
 
-    describe('disallowed content', () => {
-        test('reports markdown heading outside capture', () => {
-            const md = dedent(`
-                # This is a heading
-
-                {% capture my_var %}Content{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages.length).toBeGreaterThan(0);
-            expect(result.messages[0].message).toContain('must be inside capture blocks');
-        });
-
-        test('reports paragraph content outside capture', () => {
-            const md = dedent(`
-                {% capture my_var %}Captured{% endcapture %}
-
-                This is regular paragraph content.
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages.length).toBeGreaterThan(0);
-            expect(result.messages[0].message).toContain('must be inside capture blocks');
-        });
-
-        test('reports list outside capture', () => {
+    describe('code block protection', () => {
+        test('ignores capture blocks inside code blocks', () => {
             const md = dedent(`
-                - List item 1
-                - List item 2
+                Example code:
 
-                {% capture my_var %}Captured{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages.length).toBeGreaterThan(0);
-            expect(result.messages[0].message).toContain('must be inside capture blocks');
-        });
-
-        test('reports code block outside capture', () => {
-            const md = dedent(`
-                \`\`\`js
-                const x = 1;
+                \`\`\`liquid
+                {% capture example %}
+                This is just example code
+                {% endcapture %}
                 \`\`\`
-
-                {% capture my_var %}Captured{% endcapture %}
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages.length).toBeGreaterThan(0);
-            expect(result.messages[0].message).toContain('must be inside capture blocks');
+            const result = processMarkdown(md, '/content/docs/tutorial.md');
+            expect(result.messages).toHaveLength(0);
         });
 
-        test('allows whitespace outside capture blocks', () => {
+        test('ignores multiple capture blocks in code blocks', () => {
             const md = dedent(`
-
-
-                {% capture my_var %}Content{% endcapture %}
-
-
-                {% capture another_var %}More content{% endcapture %}
-
-
+                \`\`\`
+                {% capture var1 %}Example 1{% endcapture %}
+                {% capture var2 %}Example 2{% endcapture %}
+                {% capture var3 %}Example 3{% endcapture %}
+                \`\`\`
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+            const result = processMarkdown(md, '/docs/examples.md');
             expect(result.messages).toHaveLength(0);
         });
-    });
 
-    describe('complex scenarios', () => {
-        test('valid file with multiple captures and comments', () => {
+        test('warns for real captures but ignores code block captures', () => {
             const md = dedent(`
-                <!-- Header comment explaining this file -->
-
-                {% comment %}
-                This section defines variable 1
-                {% endcomment %}
-                {% capture variable_one %}
-                # Section 1
+                # Documentation
 
-                Content for variable one.
-                {% endcapture %}
-
-                <!-- Separator comment -->
+                Here's an example:
 
-                {% capture variable_two %}
-                ## Section 2
+                \`\`\`
+                {% capture demo %}Example{% endcapture %}
+                \`\`\`
 
-                Content for variable two with **formatting**.
-                {% endcapture %}
+                Now using it for real:
 
-                {%- comment -%}End of file{%- endcomment -%}
+                {% capture real_usage %}Actual content{% endcapture %}
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages).toHaveLength(0);
-        });
-
-        test('reports both duplicate names and disallowed content', () => {
-            const md = dedent(`
-                # Invalid heading
+            const result = processMarkdown(md, '/docs/guide.md');
 
-                {% capture my_var %}First{% endcapture %}
-                {% capture my_var %}Duplicate{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
-            expect(result.messages.length).toBeGreaterThan(0);
-            // Should have both error types
-            const messages = result.messages.map(m => m.message);
-            expect(messages.some(m => m.includes('Duplicate capture'))).toBe(true);
-            expect(messages.some(m => m.includes('must be inside capture blocks'))).toBe(true);
+            expect(result.messages).toHaveLength(1);
+            expect(result.messages[0].message).toContain('real_usage');
+            expect(result.messages[0].line).toBe(11);
         });
 
-        test('handles nested liquid tags inside capture', () => {
+        test('ignores code blocks in partials too', () => {
             const md = dedent(`
-                {% capture my_content %}
-                This has {% if true %}conditional{% endif %} content.
-                And a {{ variable }} reference.
-                {% endcapture %}
+                \`\`\`
+                {% capture example %}Code example{% endcapture %}
+                \`\`\`
             `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+            const result = processMarkdown(md, '/content/shared/partials/doc.md');
             expect(result.messages).toHaveLength(0);
         });
     });
 
     describe('edge cases', () => {
-        test('handles empty file', () => {
-            const md = '';
-            const result = processMarkdown(md, '/shared/partials/example.md');
+        test('handles empty files', () => {
+            const result = processMarkdown('', '/content/docs/empty.md');
             expect(result.messages).toHaveLength(0);
         });
 
-        test('handles file with only comments', () => {
-            const md = dedent(`
-                <!-- Only comments here -->
-                {% comment %}No capture blocks{% endcomment %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+        test('handles files with no path', () => {
+            const file = vfile({ contents: '{% capture foo %}test{% endcapture %}' });
+            const result = remark()
+                .use(plugin as unified.Attacher)
+                .processSync(file);
             expect(result.messages).toHaveLength(0);
         });
 
-        test('handles file with only whitespace', () => {
-            const md = '   \n\n\t\n   ';
-            const result = processMarkdown(md, '/shared/partials/example.md');
+        test('handles files with null contents', () => {
+            const file = vfile({ path: '/content/test.md', contents: null });
+            const result = remark()
+                .use(plugin as unified.Attacher)
+                .processSync(file);
             expect(result.messages).toHaveLength(0);
         });
 
-        test('handles capture block with underscores and numbers in name', () => {
-            const md = dedent(`
-                {% capture my_var_123 %}Content{% endcapture %}
-            `);
-            const result = processMarkdown(md, '/shared/partials/example.md');
+        test('handles files with only whitespace', () => {
+            const md = '   \n\n   \n  ';
+            const result = processMarkdown(md, '/content/docs/whitespace.md');
             expect(result.messages).toHaveLength(0);
         });
 
-        test('handles missing file path gracefully', () => {
-            const file = vfile({ contents: '{% capture x %}test{% endcapture %}' });
-            const result = remark()
-                .use(plugin as unified.Attacher)
-                .processSync(file);
-            expect(result.messages).toHaveLength(0);
+        test('case sensitive directory matching', () => {
+            // Should NOT match because of case difference
+            const md = '{% capture test %}Content{% endcapture %}';
+            const result = processMarkdown(md, '/content/Shared/Partials/test.md');
+
+            // Capital S and P don't match 'shared/partials'
+            expect(result.messages).toHaveLength(1);
         });
+    });
 
-        test('validates various path formats for partials', () => {
-            const md = '{% capture x %}Content{% endcapture %}';
+    describe('mixed liquid tags', () => {
+        test('ignores other Liquid tags, only checks capture', () => {
+            const md = dedent(`
+                {% if condition %}
+                    Some content
+                {% endif %}
 
-            // These should all be treated as partials (valid) - must contain '/shared/partials/'
-            expect(processMarkdown(md, '/app/shared/partials/x.md').messages).toHaveLength(0);
-            expect(processMarkdown(md, '/shared/partials/x.md').messages).toHaveLength(0);
-            expect(processMarkdown(md, '/content/shared/partials/alerts.md').messages).toHaveLength(0);
-            expect(processMarkdown(md, 'docs/shared/partials/alerts.md').messages).toHaveLength(0);
+                {% for item in items %}
+                    {{ item }}
+                {% endfor %}
+
+                {% assign var = "value" %}
+            `);
+            const result = processMarkdown(md, '/content/docs/page.md');
+            expect(result.messages).toHaveLength(0);
         });
 
-        test('validates various path formats for non-partials', () => {
-            const md = '{% capture x %}Content{% endcapture %}';
+        test('warns for capture but ignores other tags', () => {
+            const md = dedent(`
+                {% if condition %}
+                    Content
+                {% endif %}
 
-            // These should all be treated as non-partials (invalid)
-            expect(processMarkdown(md, '/docs/guides/intro.md').messages).toHaveLength(1);
-            expect(processMarkdown(md, 'content/tutorials/example.md').messages).toHaveLength(1);
-            expect(processMarkdown(md, '/shared/snippets/code.md').messages).toHaveLength(1);
-            expect(processMarkdown(md, 'README.md').messages).toHaveLength(1);
-        });
+                {% capture my_var %}Should warn{% endcapture %}
 
-        test('does not match similar but different paths', () => {
-            const md = '# Heading';
+                {% assign foo = "bar" %}
+            `);
+            const result = processMarkdown(md, '/content/docs/page.md');
 
-            // These paths should NOT be treated as partials
-            expect(processMarkdown(md, '/shared-partials/x.md').messages).toHaveLength(0);
-            expect(processMarkdown(md, '/sharedpartials/x.md').messages).toHaveLength(0);
-            expect(processMarkdown(md, '/my-shared/partials/x.md').messages).toHaveLength(0);
+            expect(result.messages).toHaveLength(1);
+            expect(result.messages[0].message).toContain('my_var');
         });
     });
 });