Skip to content

Validate section setting keys in JSON templates #1245

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
chippleh1392 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Validate section setting keys in JSON templates #1245

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/bright-keys-check.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
---

Validate section setting keys in JSON templates.
3 changes: 2 additions & 1 deletion 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 @@ -62,7 +62,7 @@ import { ValidRenderSnippetArgumentTypes } from './valid-render-snippet-argument
import { ValidSchema } from './valid-schema';
import { ValidSchemaName } from './valid-schema-name';
import { ValidSchemaTranslations } from './valid-schema-translations';
import { ValidSettingsKey } from './valid-settings-key';
import { ValidSettingsKey, ValidSettingsKeyJSON } from './valid-settings-key';
import { ValidStaticBlockType } from './valid-static-block-type';
import { ValidVisibleIf, ValidVisibleIfSettingsSchema } from './valid-visible-if';
import { VariableName } from './variable-name';
Expand Down Expand Up @@ -133,6 +133,7 @@ export const allChecks: (LiquidCheckDefinition | JSONCheckDefinition)[] = [
ValidRenderSnippetArgumentTypes,
ValidSchema,
ValidSettingsKey,
ValidSettingsKeyJSON,
ValidStaticBlockType,
ValidVisibleIf,
ValidVisibleIfSettingsSchema,
Expand Down
252 changes: 251 additions & 1 deletion packages/theme-check-common/src/checks/valid-settings-key/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { expect, describe, it } from 'vitest';
import { check } from '../../test';
import { ValidSettingsKey } from './index';
import { ValidSettingsKey, ValidSettingsKeyJSON } from './index';

describe('Module: ValidSettingsKey', () => {
const schemaTemplate = {
Expand Down Expand Up @@ -116,6 +116,256 @@ describe('Module: ValidSettingsKey', () => {
});
});

describe('template JSON section settings', () => {
it('does not report an error when a template JSON section setting exists in the section schema', async () => {
const theme = {
'templates/page.json': JSON.stringify({
sections: {
'main-page': {
type: 'main-page',
settings: {
heading_tag: 'h1',
},
},
},
order: ['main-page'],
}),
'sections/main-page.liquid': toLiquidFile({
name: 'Main page',
settings: [
{
id: 'heading_tag',
type: 'select',
label: 'Heading tag',
options: [
{ value: 'h1', label: 'H1' },
{ value: 'h2', label: 'H2' },
],
},
],
}),
};

const offenses = await check(theme, [ValidSettingsKey, ValidSettingsKeyJSON]);
expect(offenses).to.have.length(0);
});

it('reports an error when a template JSON section setting does not exist in the section schema', async () => {
const theme = {
'templates/page.json': JSON.stringify({
sections: {
'main-page': {
type: 'main-page',
settings: {
heading_tagg: 'h1',
},
},
},
order: ['main-page'],
}),
'sections/main-page.liquid': toLiquidFile({
name: 'Main page',
settings: [
{
id: 'heading_tag',
type: 'select',
label: 'Heading tag',
options: [
{ value: 'h1', label: 'H1' },
{ value: 'h2', label: 'H2' },
],
},
],
}),
};

const offenses = await check(theme, [ValidSettingsKey, ValidSettingsKeyJSON]);
expect(offenses).to.have.length(1);
expect(offenses[0].message).to.equal(
`Setting 'heading_tagg' does not exist in 'sections/main-page.liquid'.`,
);
});
});

describe('template JSON block settings', () => {
it('does not report an error when a template JSON block setting exists in the block schema', async () => {
const theme = {
'templates/page.json': JSON.stringify({
sections: {
'main-page': {
type: 'main-page',
blocks: {
text: {
type: 'text',
settings: {
heading: 'Hello',
},
},
},
block_order: ['text'],
},
},
order: ['main-page'],
}),
'sections/main-page.liquid': toLiquidFile({
name: 'Main page',
blocks: [{ type: 'text' }],
}),
'blocks/text.liquid': toLiquidFile({
name: 'Text',
settings: [
{
id: 'heading',
type: 'text',
label: 'Heading',
},
],
}),
};

const offenses = await check(theme, [ValidSettingsKey, ValidSettingsKeyJSON]);
expect(offenses).to.have.length(0);
});

it('reports an error when a template JSON block setting does not exist in the block schema', async () => {
const theme = {
'templates/page.json': JSON.stringify({
sections: {
'main-page': {
type: 'main-page',
blocks: {
text: {
type: 'text',
settings: {
headingg: 'Hello',
},
},
},
block_order: ['text'],
},
},
order: ['main-page'],
}),
'sections/main-page.liquid': toLiquidFile({
name: 'Main page',
blocks: [{ type: 'text' }],
}),
'blocks/text.liquid': toLiquidFile({
name: 'Text',
settings: [
{
id: 'heading',
type: 'text',
label: 'Heading',
},
],
}),
};

const offenses = await check(theme, [ValidSettingsKey, ValidSettingsKeyJSON]);
expect(offenses).to.have.length(1);
expect(offenses[0].message).to.equal(
`Setting 'headingg' does not exist in 'blocks/text.liquid'.`,
);
});

it('reports an error when a template JSON local block setting does not exist in the section schema', async () => {
const theme = {
'templates/page.json': JSON.stringify({
sections: {
'main-page': {
type: 'main-page',
blocks: {
foo: {
type: 'foo',
settings: {
headingg: 'Hello',
},
},
},
block_order: ['foo'],
},
},
order: ['main-page'],
}),
'sections/main-page.liquid': toLiquidFile({
name: 'Main page',
blocks: [
{
type: 'foo',
name: 'Foo',
settings: [
{
id: 'heading',
type: 'text',
label: 'Heading',
},
],
},
],
}),
};

const offenses = await check(theme, [ValidSettingsKey, ValidSettingsKeyJSON]);
expect(offenses).to.have.length(1);
expect(offenses[0].message).to.equal(
`Setting 'headingg' does not exist in 'sections/main-page.liquid'.`,
);
});

it('reports an error when a nested template JSON block setting does not exist in the nested block schema', async () => {
const theme = {
'templates/page.json': JSON.stringify({
sections: {
'main-page': {
type: 'main-page',
blocks: {
parent: {
type: 'parent',
blocks: {
text: {
type: 'text',
settings: {
headingg: 'Hello',
},
},
},
block_order: ['text'],
},
},
block_order: ['parent'],
},
},
order: ['main-page'],
}),
'sections/main-page.liquid': toLiquidFile({
name: 'Main page',
blocks: [{ type: 'parent' }],
}),
'blocks/parent.liquid': toLiquidFile({
name: 'Parent',
blocks: [{ type: 'text' }],
}),
'blocks/text.liquid': toLiquidFile({
name: 'Text',
settings: [
{
id: 'heading',
type: 'text',
label: 'Heading',
},
],
}),
};

const offenses = await check(theme, [ValidSettingsKey, ValidSettingsKeyJSON]);
expect(offenses).to.have.length(1);
expect(offenses[0].message).to.equal(
`Setting 'headingg' does not exist in 'blocks/text.liquid'.`,
);
});
});

const tests = [
{
label: 'default',
Expand Down
Loading
Loading