Merge pull request #150 from Shopify/sections_tag_support

Add support for sections tag
Shopify · Jan 4, 2023 · 43d6330 · 43d6330
2 parents e3318d8 + 05bf390
commit 43d6330
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 0 deletions.
diff --git a/grammar/liquid-html.ohm b/grammar/liquid-html.ohm
@@ -57,6 +57,7 @@ Liquid <: Helpers {
     | liquidTagLiquid
     | liquidTagRender
     | liquidTagSection
+    | liquidTagSections
     | liquidTagWhen
     | liquidTagBaseCase
 
@@ -97,6 +98,9 @@ Liquid <: Helpers {
   liquidTagSection = liquidTagRule<"section", liquidTagSectionMarkup>
   liquidTagSectionMarkup = liquidString space*
 
+  liquidTagSections = liquidTagRule<"sections", liquidTagSectionsMarkup>
+  liquidTagSectionsMarkup = liquidString space*
+
   liquidTagLayout = liquidTagRule<"layout", liquidTagLayoutMarkup>
   liquidTagLayoutMarkup = liquidExpression space*
 

diff --git a/src/parser/stage-1-cst.ts b/src/parser/stage-1-cst.ts
@@ -295,6 +295,7 @@ export type ConcreteLiquidTagNamed =
   | ConcreteLiquidTagLiquid
   | ConcreteLiquidTagRender
   | ConcreteLiquidTagSection
+  | ConcreteLiquidTagSections
   | ConcreteLiquidTagWhen;
 
 export interface ConcreteLiquidTagNode<Name, Markup>
@@ -319,6 +320,8 @@ export interface ConcreteLiquidTagDecrement
   > {}
 export interface ConcreteLiquidTagSection
   extends ConcreteLiquidTagNode<NamedTags.section, ConcreteStringLiteral> {}
+export interface ConcreteLiquidTagSections
+  extends ConcreteLiquidTagNode<NamedTags.sections, ConcreteStringLiteral> {}
 export interface ConcreteLiquidTagLayout
   extends ConcreteLiquidTagNode<NamedTags.layout, ConcreteLiquidExpression> {}
 
@@ -685,6 +688,7 @@ export function toLiquidHtmlCST(source: string): LiquidHtmlCST {
     liquidTagRender: 0,
     liquidTagInclude: 0,
     liquidTagSection: 0,
+    liquidTagSections: 0,
     liquidTagLayout: 0,
     liquidTagRule: {
       type: ConcreteNodeTypes.LiquidTag,
@@ -729,6 +733,7 @@ export function toLiquidHtmlCST(source: string): LiquidHtmlCST {
 
     liquidTagEchoMarkup: 0,
     liquidTagSectionMarkup: 0,
+    liquidTagSectionsMarkup: 0,
     liquidTagLayoutMarkup: 0,
     liquidTagAssignMarkup: {
       type: ConcreteNodeTypes.AssignMarkup,

diff --git a/src/parser/stage-2-ast.ts b/src/parser/stage-2-ast.ts
@@ -176,6 +176,7 @@ export type LiquidTagNamed =
   | LiquidTagPaginate
   | LiquidTagRender
   | LiquidTagSection
+  | LiquidTagSections
   | LiquidTagTablerow
   | LiquidTagUnless;
 
@@ -285,6 +286,8 @@ export interface LiquidTagInclude
 
 export interface LiquidTagSection
   extends LiquidTagNode<NamedTags.section, LiquidString> {}
+export interface LiquidTagSections
+  extends LiquidTagNode<NamedTags.sections, LiquidString> {}
 export interface LiquidTagLayout
   extends LiquidTagNode<NamedTags.layout, LiquidExpression> {}
 
@@ -1006,6 +1009,13 @@ function toNamedLiquidTag(
         markup: toExpression(node.markup) as LiquidString,
       };
     }
+    case NamedTags.sections: {
+      return {
+        ...liquidTagBaseAttributes(node),
+        name: node.name,
+        markup: toExpression(node.markup) as LiquidString,
+      };
+    }
 
     case NamedTags.form: {
       return {

diff --git a/src/printer/print/liquid.ts b/src/printer/print/liquid.ts
@@ -196,6 +196,9 @@ function printNamedLiquidBlockStart(
     case NamedTags.section: {
       return tag(' ');
     }
+    case NamedTags.sections: {
+      return tag(' ');
+    }
 
     case NamedTags.form: {
       const trailingWhitespace = node.markup.length > 1 ? line : ' ';

diff --git a/src/types.ts b/src/types.ts
@@ -73,6 +73,7 @@ export enum NamedTags {
   paginate = 'paginate',
   render = 'render',
   section = 'section',
+  sections = 'sections',
   tablerow = 'tablerow',
   unless = 'unless',
   when = 'when',

diff --git a/test/liquid-tag-sections/fixed.liquid b/test/liquid-tag-sections/fixed.liquid
@@ -0,0 +1,6 @@
+It should never break a name
+printWidth: 1
+{% sections 'sectionName' %}
+{% sections 'sectionName' %}
+{% sections 'sectionName' %}
+{%- sections 'sectionName' -%}
diff --git a/test/liquid-tag-sections/index.liquid b/test/liquid-tag-sections/index.liquid
@@ -0,0 +1,8 @@
+It should never break a name
+printWidth: 1
+{% sections  "sectionName"  %}
+{% sections "sectionName" %}
+{% sections "sectionName"%}
+{%- sections
+"sectionName"
+-%}
diff --git a/test/liquid-tag-sections/index.spec.ts b/test/liquid-tag-sections/index.spec.ts
@@ -0,0 +1,6 @@
+import { assertFormattedEqualsFixed } from '../test-helpers';
+import * as path from 'path';
+
+describe(`Unit: ${path.basename(__dirname)}`, () => {
+  assertFormattedEqualsFixed(__dirname);
+});