Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/source/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ filters:
sort: sort.html
sort_natural: sort_natural.html
split: split.html
squish: squish.html
strip: strip.html
strip_html: strip_html.html
strip_newlines: strip_newlines.html
Expand Down
18 changes: 18 additions & 0 deletions docs/source/filters/squish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: squish
---

{% since %}v10.28.0{% endsince %}

Removes leading and trailing whitespace from a string, and replaces every run of whitespace inside it with a single space.

Input
```liquid
{{ " Hello there,
Major Tom. " | squish }}
```

Output
```text
Hello there, Major Tom.
```
6 changes: 6 additions & 0 deletions src/filters/string.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ export function strip_newlines (this: FilterImpl, v: string) {
return str.replace(/\r?\n/gm, '')
}

export function squish (this: FilterImpl, v: string) {
const str = stringify(v)
this.context.memoryLimit.use(str.length)
return str.replace(/\s+/g, ' ').trim()

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the spaces trimed by .trim() is same with those \s matches, and whether the order of replace and trim matters (it's different with shopify).

Anyway this is good enough to merge. Will handle it when discrepancies arise.

}

export function capitalize (this: FilterImpl, str: string) {
str = stringify(str)
this.context.memoryLimit.use(str.length)
Expand Down
20 changes: 20 additions & 0 deletions test/integration/filters/string.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,26 @@ describe('filters/string', function () {
'{{ string_with_newlines | strip_newlines }}',
'Hellothere')
})
describe('squish', function () {
it('should collapse whitespace between words', function () {
return test('{{ "Hello World!" | squish }}', 'Hello World!')
})
it('should strip leading and trailing whitespace', function () {
return test('{{ " HelloWorld! " | squish }}', 'HelloWorld!')
})
it('should treat newlines and tabs as whitespace', function () {
return test('{{ " \n\t\r\nHello \n\t World! \n" | squish }}', 'Hello World!')
})
it('should return empty string for whitespace only', function () {
return test('{{ " \n\t " | squish }}', '')
})
it('should stringify a number', function () {
return test('{{ 5 | squish }}', '5')
})
it('should return empty string for undefined', function () {
return test('{{ nosuchthing | squish }}', '')
})
})
describe('truncate', function () {
it('should truncate when string too long', function () {
return test('{{ "Ground control to Major Tom." | truncate: 20 }}',
Expand Down
Loading