Modify LiquidDoc parsing to capture leading whitespace and add inline… #2258

Triggered via push February 25, 2025 23:30

jamesmengo

pushed 1b76a61

jm/example-newline-property

Status Failure

Total duration 2m 11s

Artifacts –

ci.yml

on: push

Code quality

2m 4s

Matrix: tests

Annotations

23 errors

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should return default snippet definition if no renderable content is present: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L20

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { - "content": "just a description", + "content": "just a description + ", "nodeType": "description", }, }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:20:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should extract examples from @example annotations: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L104

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} + "content": "{{ product }} ", "nodeType": "example", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:104:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should extract examples from @example annotations with multiple lines: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L127

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} + "content": "{{ product }} {{ product.title }} ", "nodeType": "example", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:127:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should extract example from @example and @param annotations: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L150

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} // This is an example + "content": "{{ product }} // This is an example ", "nodeType": "example", }, ], "parameters": Array [ Object { "description": "The product", "name": "product", "nodeType": "param", "required": true, "type": "String", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:150:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should extract multiple examples from @example annotations: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L183

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} + "content": "{{ product }} ", "nodeType": "example", }, Object { - "content": " - {{ product.title }} + "content": "{{ product.title }} ", "nodeType": "example", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:183:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should extract description from @description annotations: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L208

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { - "content": "This is a description", + "content": "This is a description + ", "nodeType": "description", }, }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:208:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should extract only the first @description annotation: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L228

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { - "content": "This is a description", + "content": "This is a description + ", "nodeType": "description", }, }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:228:28

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts > Unit: getSnippetDefinition > should return implicit description if multiple descriptions are provided: packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts#L275

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { "content": "this is an implicit description - in a header", + in a header + + ", "nodeType": "description", }, "parameters": Array [ Object { "description": null, "name": "asdf", "nodeType": "param", "required": true, "type": null, }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:275:28

Tests / OS ubuntu-latest / NodeJS 20

Process completed with exit code 1.

Tests / OS ubuntu-latest / NodeJS 18

The job was canceled because "ubuntu-latest_20" failed.

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} + "content": "{{ product }} ", "nodeType": "example", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:104:28

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} + "content": "{{ product }} {{ product.title }} ", "nodeType": "example", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:127:28

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} // This is an example + "content": "{{ product }} // This is an example ", "nodeType": "example", }, ], "parameters": Array [ Object { "description": "The product", "name": "product", "nodeType": "param", "required": true, "type": "String", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:150:28

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "examples": Array [ Object { - "content": " - {{ product }} + "content": "{{ product }} ", "nodeType": "example", }, Object { - "content": " - {{ product.title }} + "content": "{{ product.title }} ", "nodeType": "example", }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:183:28

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { - "content": "This is a description", + "content": "This is a description + ", "nodeType": "description", }, }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:208:28

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { - "content": "This is a description", + "content": "This is a description + ", "nodeType": "description", }, }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:228:28

AssertionError: expected { name: 'product-card', …(1) } to deeply equal { name: 'product-card', …(1) } - Expected + Received Object { "liquidDoc": Object { "description": Object { "content": "this is an implicit description - in a header", + in a header + + ", "nodeType": "description", }, "parameters": Array [ Object { "description": null, "name": "asdf", "nodeType": "param", "required": true, "type": null, }, ], }, "name": "product-card", } ❯ packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts:275:28

Tests / OS ubuntu-latest / NodeJS 18

Process completed with exit code 1.

Tests / OS windows-latest / NodeJS 20

The job was canceled because "ubuntu-latest_20" failed.

Tests / OS windows-latest / NodeJS 20

The operation was canceled.

Tests / OS windows-latest / NodeJS 18

The job was canceled because "ubuntu-latest_20" failed.

Tests / OS windows-latest / NodeJS 18

The operation was canceled.