Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Liquid capture sorting #135

Merged
merged 2 commits into from
Mar 22, 2023
Merged

Fix Liquid capture sorting #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57a5619
Collect all changes to Liquid sources before applying them
thecrypticace Mar 20, 2023
ed0148a
Add tests
thecrypticace Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 47 additions & 27 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,55 +358,75 @@ function transformLiquid(ast, { env }) {
: node.name === 'class'
}

function sortAttribute(attr, path) {
/** @type {{type: string, source: string}[]} */
let sources = []

/** @type {{pos: {start: number, end: number}, value: string}[]} */
let changes = []

function sortAttribute(attr) {
visit(attr.value, {
TextNode(node) {
node.value = sortClasses(node.value, { env });

let source = node.source.slice(0, node.position.start) + node.value + node.source.slice(node.position.end)
path.forEach(node => (node.source = source))
changes.push({
pos: node.position,
value: node.value,
})
},

String(node) {
node.value = sortClasses(node.value, { env });

// String position includes the quotes even if the value doesn't
// Hence the +1 and -1 when slicing
let source = node.source.slice(0, node.position.start+1) + node.value + node.source.slice(node.position.end-1)
path.forEach(node => (node.source = source))
changes.push({
pos: {
// String position includes the quotes even if the value doesn't
// Hence the +1 and -1 when slicing
start: node.position.start+1,
end: node.position.end-1,
},
value: node.value,
})
},
})
}

visit(ast, {
LiquidTag(node, _parent, _key, _index, meta) {
meta.path = [...meta.path ?? [], node];
LiquidTag(node) {
sources.push(node)
},

HtmlElement(node, _parent, _key, _index, meta) {
meta.path = [...meta.path ?? [], node];
HtmlElement(node) {
sources.push(node)
},

AttrSingleQuoted(node, _parent, _key, _index, meta) {
if (!isClassAttr(node)) {
return;
AttrSingleQuoted(node) {
if (isClassAttr(node)) {
sources.push(node)
sortAttribute(node)
}

meta.path = [...meta.path ?? [], node];

sortAttribute(node, meta.path)
},

AttrDoubleQuoted(node, _parent, _key, _index, meta) {
if (!isClassAttr(node)) {
return;
AttrDoubleQuoted(node) {
if (isClassAttr(node)) {
sources.push(node)
sortAttribute(node)
}

meta.path = [...meta.path ?? [], node];

sortAttribute(node, meta.path)
},
});

// Sort so all changes occur in order
changes = changes.sort((a, b) => {
return a.start - b.start
|| a.end - b.end
})

for (let change of changes) {
for (let node of sources) {
node.source =
node.source.slice(0, change.pos.start) +
change.value +
node.source.slice(change.pos.end)
}
}
}

function sortStringLiteral(node, { env }) {
Expand Down
8 changes: 8 additions & 0 deletions tests/plugins.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,14 @@ let tests = [
`{%- capture class_ordering -%}<div class="sm:p-0 p-4"></div>{%- endcapture -%}`,
`{%- capture class_ordering -%}<div class="p-4 sm:p-0"></div>{%- endcapture -%}`,
],
[
`{%- capture class_ordering -%}<div class="foo1 sm:p-0 p-4"></div><div class="foo2 sm:p-0 p-4"></div>{%- endcapture -%}`,
`{%- capture class_ordering -%}<div class="foo1 p-4 sm:p-0"></div><div class="foo2 p-4 sm:p-0"></div>{%- endcapture -%}`,
],
[
`{%- capture class_ordering -%}<div class="foo1 sm:p-0 p-4"><div class="foo2 sm:p-0 p-4"></div></div>{%- endcapture -%}`,
`{%- capture class_ordering -%}<div class="foo1 p-4 sm:p-0"><div class="foo2 p-4 sm:p-0"></div></div>{%- endcapture -%}`,
],
],
}
},
Expand Down