Skip to content

Add MaxLines check #1232

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

Open
andershagbard wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add MaxLines check #1232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/max-lines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/theme-check-common': minor
---

Add `MaxLines` check that enforces a maximum number of lines per Liquid file, with configurable options to skip blank lines, comments, schema blocks, and doc blocks.
2 changes: 2 additions & 0 deletions packages/theme-check-common/src/checks/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { JSONSyntaxError } from './json-syntax-error';
import { LiquidFreeSettings } from './liquid-free-settings';
import { LiquidHTMLSyntaxError } from './liquid-html-syntax-error';
import { MatchingTranslations } from './matching-translations';
import { MaxLines } from './max-lines';
import { MissingAsset } from './missing-asset';
import { MissingContentForArguments } from './missing-content-for-arguments';
import { MissingRenderSnippetArguments } from './missing-render-snippet-arguments';
Expand Down Expand Up @@ -96,6 +97,7 @@ export const allChecks: (LiquidCheckDefinition | JSONCheckDefinition)[] = [
LiquidFreeSettings,
LiquidHTMLSyntaxError,
MatchingTranslations,
MaxLines,
MissingAsset,
MissingContentForArguments,
MissingRenderSnippetArguments,
Expand Down
302 changes: 302 additions & 0 deletions packages/theme-check-common/src/checks/max-lines/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,302 @@
import { expect, describe, it } from 'vitest';
import { runLiquidCheck, check } from '../../test';
import { MaxLines } from './index';

const sectionFile = 'sections/my-section.liquid';

describe('Module: MaxLines', () => {
it('does not report when file is within the default limit', async () => {
const source = Array(300).fill('<div></div>').join('\n');
const offenses = await runLiquidCheck(MaxLines, source, sectionFile);
expect(offenses).toHaveLength(0);
});

it('reports when file exceeds the default limit', async () => {
const source = Array(301).fill('<div></div>').join('\n');
const offenses = await runLiquidCheck(MaxLines, source, sectionFile);
expect(offenses).toHaveLength(1);
expect(offenses.at(0)?.message).toMatch(/301.*300/);
});

it('reports with a custom max', async () => {
const source = Array(6).fill('<div></div>').join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 5 } },
);
expect(offenses).toHaveLength(1);
expect(offenses.at(0)?.message).toMatch(/6.*5/);
});

it('does not report when file equals the max', async () => {
const source = Array(5).fill('<div></div>').join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 5 } },
);
expect(offenses).toHaveLength(0);
});

it('reports the offset at the first excess line', async () => {
const line1 = '<div>line1</div>';
const line2 = '<div>line2</div>';
const line3 = '<div>line3</div>';
const source = [line1, line2, line3].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2 } },
);
expect(offenses).toHaveLength(1);
expect(offenses.at(0)?.start.index).toBe(line1.length + 1 + line2.length + 1);
});

describe('skipBlankLines', () => {
it('counts blank lines by default', async () => {
const source = Array(3).fill('<div></div>').join('\n\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 4 } },
);
expect(offenses).toHaveLength(1);
});

it('skips blank lines when enabled', async () => {
const source = Array(3).fill('<div></div>').join('\n\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 4, skipBlankLines: true } },
);
expect(offenses).toHaveLength(0);
});
});

describe('skipComments', () => {
it('counts liquid comment lines by default', async () => {
const source = [
'<div></div>',
'{% comment %}',
'This is a comment',
'{% endcomment %}',
'<div></div>',
].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 4 } },
);
expect(offenses).toHaveLength(1);
});

it('skips liquid comment blocks when enabled', async () => {
const source = [
'<div></div>',
'{% comment %}',
'This is a comment',
'{% endcomment %}',
'<div></div>',
].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 4, skipComments: true } },
);
expect(offenses).toHaveLength(0);
});

it('skips liquid comment blocks with dash syntax', async () => {
const source = [
'<div></div>',
'{%- comment -%}',
'This is a comment',
'{%- endcomment -%}',
'<div></div>',
].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipComments: true } },
);
expect(offenses).toHaveLength(0);
});

it('skips HTML comment lines when enabled', async () => {
const source = ['<div></div>', '<!-- this is a comment -->', '<div></div>'].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipComments: true } },
);
expect(offenses).toHaveLength(0);
});

it('skips inline liquid comment blocks', async () => {
const source = ['<div></div>', '{% comment %}inline{% endcomment %}', '<div></div>'].join(
'\n',
);
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipComments: true } },
);
expect(offenses).toHaveLength(0);
});

it('skips {% # inline %} comments', async () => {
const source = ['<div></div>', '{% # this is an inline comment %}', '<div></div>'].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipComments: true } },
);
expect(offenses).toHaveLength(0);
});

it('skips {%- # inline -%} comments with dash syntax', async () => {
const source = ['<div></div>', '{%- # this is an inline comment -%}', '<div></div>'].join(
'\n',
);
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipComments: true } },
);
expect(offenses).toHaveLength(0);
});

it('counts {% # inline %} comments when skipComments is false', async () => {
const source = ['<div></div>', '{% # this is an inline comment %}', '<div></div>'].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2 } },
);
expect(offenses).toHaveLength(1);
});
});

describe('skipSchema', () => {
it('skips schema block by default', async () => {
const source = ['<div></div>', '{% schema %}', '{}', '{% endschema %}', '<div></div>'].join(
'\n',
);
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2 } },
);
expect(offenses).toHaveLength(0);
});

it('counts schema lines when skipSchema is false', async () => {
const source = ['<div></div>', '{% schema %}', '{}', '{% endschema %}', '<div></div>'].join(
'\n',
);
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipSchema: false } },
);
expect(offenses).toHaveLength(1);
});

it('skips schema block with dash syntax', async () => {
const source = [
'<div></div>',
'{%- schema -%}',
'{}',
'{%- endschema -%}',
'<div></div>',
].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2 } },
);
expect(offenses).toHaveLength(0);
});

it('skips start and end tags as well as inner content', async () => {
const source = [
'<div></div>',
'{% schema %}',
'{ "name": "My section",',
' "settings": [] }',
'{% endschema %}',
'<div></div>',
].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2 } },
);
expect(offenses).toHaveLength(0);
});
});

describe('skipDoc', () => {
it('skips doc block by default', async () => {
const source = ['<div></div>', '{% doc %}', 'Some docs', '{% enddoc %}', '<div></div>'].join(
'\n',
);
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2 } },
);
expect(offenses).toHaveLength(0);
});

it('counts doc block lines when skipDoc is false', async () => {
const source = ['<div></div>', '{% doc %}', 'Some docs', '{% enddoc %}', '<div></div>'].join(
'\n',
);
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 4, skipDoc: false } },
);
expect(offenses).toHaveLength(1);
});

it('skips doc block with dash syntax', async () => {
const source = [
'<div></div>',
'{%- doc -%}',
'Some docs',
'{%- enddoc -%}',
'<div></div>',
].join('\n');
const offenses = await check(
{ [sectionFile]: source },
[MaxLines],
{},
{ MaxLines: { enabled: true, max: 2, skipDoc: true } },
);
expect(offenses).toHaveLength(0);
});
});
});
Loading
Loading