From 4831ddc5290505fde4648341605f91b1724b5e40 Mon Sep 17 00:00:00 2001 From: Navdeep Date: Thu, 5 Dec 2024 15:43:04 -0500 Subject: [PATCH] Renaming to `JSONMissingBlock` --- .../theme-check-common/src/checks/index.ts | 4 ++-- .../checks/json-missing-block/index.spec.ts | 18 +++++++++--------- .../src/checks/json-missing-block/index.ts | 4 ++-- .../json-missing-block/missing-block-utils.ts | 2 +- packages/theme-check-node/configs/all.yml | 4 ++-- .../theme-check-node/configs/recommended.yml | 4 ++-- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/packages/theme-check-common/src/checks/index.ts b/packages/theme-check-common/src/checks/index.ts index 1fb8568f6..fbb892b64 100644 --- a/packages/theme-check-common/src/checks/index.ts +++ b/packages/theme-check-common/src/checks/index.ts @@ -17,7 +17,7 @@ import { DeprecatedFilter } from './deprecated-filter'; import { DeprecatedTag } from './deprecated-tag'; import { EmptyBlockContent } from './empty-block-content'; import { ImgWidthAndHeight } from './img-width-and-height'; -import { JsonMissingBlock } from './json-missing-block'; +import { JSONMissingBlock } from './json-missing-block'; import { JSONSyntaxError } from './json-syntax-error'; import { LiquidFreeSettings } from './liquid-free-settings'; import { LiquidHTMLSyntaxError } from './liquid-html-syntax-error'; @@ -63,7 +63,7 @@ export const allChecks: (LiquidCheckDefinition | JSONCheckDefinition)[] = [ DeprecateLazysizes, EmptyBlockContent, ImgWidthAndHeight, - JsonMissingBlock, + JSONMissingBlock, JSONSyntaxError, LiquidFreeSettings, LiquidHTMLSyntaxError, diff --git a/packages/theme-check-common/src/checks/json-missing-block/index.spec.ts b/packages/theme-check-common/src/checks/json-missing-block/index.spec.ts index ad8fd2790..7f36fcf6a 100644 --- a/packages/theme-check-common/src/checks/json-missing-block/index.spec.ts +++ b/packages/theme-check-common/src/checks/json-missing-block/index.spec.ts @@ -1,5 +1,5 @@ import { expect, describe, it } from 'vitest'; -import { JsonMissingBlock } from './index'; +import { JSONMissingBlock } from './index'; import { check, MockTheme } from '../../test'; describe('Module: JsonMissingBlock', () => { @@ -34,7 +34,7 @@ describe('Module: JsonMissingBlock', () => { `, }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.have.length(1); expect(offenses[0].message).to.equal( "Theme block 'blocks/missing_block.liquid' does not exist.", @@ -76,7 +76,7 @@ describe('Module: JsonMissingBlock', () => { 'blocks/text.liquid': '', }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.be.empty; }); @@ -127,7 +127,7 @@ describe('Module: JsonMissingBlock', () => { `, }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.have.length(1); expect(offenses[0].message).to.equal( "Theme block 'blocks/missing_nested.liquid' does not exist.", @@ -172,7 +172,7 @@ describe('Module: JsonMissingBlock', () => { 'blocks/image.liquid': '', }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.have.length(1); expect(offenses[0].message).to.equal( "Block type 'text' is not allowed in 'sections/custom-section.liquid'.", @@ -232,7 +232,7 @@ describe('Module: JsonMissingBlock', () => { 'blocks/missing_nested.liquid': '', }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.have.length(1); expect(offenses[0].message).to.equal( "Block type 'missing_nested' is not allowed in 'blocks/text.liquid'.", @@ -292,7 +292,7 @@ describe('Module: JsonMissingBlock', () => { 'blocks/_private_block.liquid': '', }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.have.length(1); expect(offenses[0].message).to.equal( "Block type '_private_block' is not allowed in 'blocks/text.liquid'.", @@ -316,7 +316,7 @@ describe('Module: JsonMissingBlock', () => { }`, }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.be.empty; }); @@ -371,7 +371,7 @@ describe('Module: JsonMissingBlock', () => { 'blocks/_private_block.liquid': '', }; - const offenses = await check(theme, [JsonMissingBlock]); + const offenses = await check(theme, [JSONMissingBlock]); expect(offenses).to.be.empty; }); }); diff --git a/packages/theme-check-common/src/checks/json-missing-block/index.ts b/packages/theme-check-common/src/checks/json-missing-block/index.ts index e64ebd1cf..7daa4fd0b 100644 --- a/packages/theme-check-common/src/checks/json-missing-block/index.ts +++ b/packages/theme-check-common/src/checks/json-missing-block/index.ts @@ -2,9 +2,9 @@ import { getSchemaFromJSON } from '../../to-schema'; import { JSONCheckDefinition, Severity, SourceCodeType } from '../../types'; import { getAllBlocks, isPropertyNode } from './missing-block-utils'; -export const JsonMissingBlock: JSONCheckDefinition = { +export const JSONMissingBlock: JSONCheckDefinition = { meta: { - code: 'JsonMissingBlock', + code: 'JSONMissingBlock', name: 'Check for missing blocks types in JSON templates', docs: { description: 'This check ensures that JSON templates contain valid block types.', diff --git a/packages/theme-check-common/src/checks/json-missing-block/missing-block-utils.ts b/packages/theme-check-common/src/checks/json-missing-block/missing-block-utils.ts index 451835ee2..8d7c450ea 100644 --- a/packages/theme-check-common/src/checks/json-missing-block/missing-block-utils.ts +++ b/packages/theme-check-common/src/checks/json-missing-block/missing-block-utils.ts @@ -1,4 +1,4 @@ -import { Context, SourceCodeType, JSONNode, Preset } from '../../types'; +import { Context, SourceCodeType, JSONNode } from '../../types'; import { LiteralNode, PropertyNode } from 'json-to-ast'; import { getLocEnd, getLocStart, nodeAtPath } from '../../json'; import { doesFileExist } from '../../utils/file-utils'; diff --git a/packages/theme-check-node/configs/all.yml b/packages/theme-check-node/configs/all.yml index aa18271d2..ab19f0993 100644 --- a/packages/theme-check-node/configs/all.yml +++ b/packages/theme-check-node/configs/all.yml @@ -55,10 +55,10 @@ EmptyBlockContent: ImgWidthAndHeight: enabled: true severity: 0 -JSONSyntaxError: +JSONMissingBlock: enabled: true severity: 0 -JsonMissingBlock: +JSONSyntaxError: enabled: true severity: 0 LiquidFreeSettings: diff --git a/packages/theme-check-node/configs/recommended.yml b/packages/theme-check-node/configs/recommended.yml index f87433b37..34b57a8a0 100644 --- a/packages/theme-check-node/configs/recommended.yml +++ b/packages/theme-check-node/configs/recommended.yml @@ -36,10 +36,10 @@ EmptyBlockContent: ImgWidthAndHeight: enabled: true severity: 0 -JSONSyntaxError: +JSONMissingBlock: enabled: true severity: 0 -JsonMissingBlock: +JSONSyntaxError: enabled: true severity: 0 LiquidFreeSettings: