@platformos/platformos-check-common 0.0.6 → 0.0.8

package/src/checks/schema-presets-static-blocks/index.ts

@@ -1,126 +0,0 @@
-import { NamedTags, NodeTypes } from '@platformos/liquid-html-parser';
-import { getLocEnd, getLocStart, nodeAtPath } from '../../json';
-import { getSchema } from '../../to-schema';
-import { ArrayNode, LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
-import { isContentForBlock } from '../../utils/markup';
-
-export const SchemaPresetsStaticBlocks: LiquidCheckDefinition = {
-  meta: {
-    code: 'SchemaPresetsStaticBlocks',
-    name: 'Ensure the preset static blocks are used in the liquid',
-    docs: {
-      description:
-        'Warns if a preset static block does not have a corresponding content_for "block" tag.',
-      recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/schema-presets-static-blocks',
-    },
-    type: SourceCodeType.LiquidHtml,
-    severity: Severity.ERROR,
-    schema: {},
-    targets: [],
-  },
-
-  create(context) {
-    type contentForBlock = {
-      id: string;
-      type: string;
-    };
-    type StaticBlock = {
-      id: string;
-      type: string;
-      startIndex: number;
-      endIndex: number;
-    };
-    let contentForBlockList: contentForBlock[] = [];
-    let staticBlockList: StaticBlock[] = [];
-    let offset: number = 0;
-
-    function checkStaticBlocks() {
-      staticBlockList.forEach((block) => {
-        if (
-          !contentForBlockList.some(
-            (contentBlock) => contentBlock.id === block.id && contentBlock.type === block.type,
-          )
-        ) {
-          context.report({
-            message: `Static block ${block.id} is missing a corresponding content_for "block" tag.`,
-            startIndex: block.startIndex,
-            endIndex: block.endIndex,
-          });
-        }
-      });
-    }
-
-    return {
-      async LiquidTag(node) {
-        // Early return if not a content_for block tag
-        if (node.name !== NamedTags.content_for || !isContentForBlock(node.markup)) return;
-
-        // Extract id and type from markup args
-        const idValue = node.markup.args.find((arg) => arg.name === 'id')?.value;
-        const typeArg = node.markup.args.find((arg) => arg.name === 'type')?.value;
-        if (!typeArg || typeArg.type !== NodeTypes.String) {
-          return; // covered by VariableContentForArguments
-        }
-        const typeValue = typeArg.value;
-
-        // Add to list if valid string id
-        if (idValue?.type === NodeTypes.String) {
-          contentForBlockList.push({ id: idValue.value, type: typeValue });
-        }
-      },
-
-      async LiquidRawTag(node) {
-        // when we get the schema tag, get the list of static blocks from each preset
-        if (node.name === 'schema' && node.body.kind === 'json') {
-          offset = node.blockStartPosition.end;
-          const schema = await getSchema(context);
-          const { validSchema, ast } = schema ?? {};
-          if (!validSchema || validSchema instanceof Error) return;
-          if (!ast || ast instanceof Error) return;
-
-          const presets = validSchema.presets;
-          if (!presets) return;
-
-          presets.forEach((preset, index) => {
-            if ('blocks' in preset && preset.blocks) {
-              let ast_path: any[] = ['presets', index, 'blocks'];
-              // blocks as an array
-              if (Array.isArray(preset.blocks)) {
-                preset.blocks.forEach((block, block_index) => {
-                  if (block.static === true && block.id) {
-                    let node = nodeAtPath(ast, ast_path.concat([block_index]))! as ArrayNode;
-                    staticBlockList.push({
-                      id: block.id,
-                      type: block.type,
-                      startIndex: offset + getLocStart(node),
-                      endIndex: offset + getLocEnd(node),
-                    });
-                  }
-                });
-              }
-              // blocks as an object
-              else if (typeof preset.blocks === 'object') {
-                Object.entries(preset.blocks).forEach(([block_id, block]) => {
-                  if (block.static === true) {
-                    let node = nodeAtPath(ast, ast_path.concat(block_id))! as ArrayNode;
-                    staticBlockList.push({
-                      id: block_id,
-                      type: block.type,
-                      startIndex: offset + getLocStart(node),
-                      endIndex: offset + getLocEnd(node),
-                    });
-                  }
-                });
-              }
-            }
-          });
-        }
-      },
-
-      async onCodePathEnd() {
-        checkStaticBlocks();
-      },
-    };
-  },
-};

package/src/checks/static-stylesheet-and-javascript-tags/index.spec.ts

@@ -1,257 +0,0 @@
-import { check, highlightedOffenses } from '../../test';
-import { expect, describe, it } from 'vitest';
-import { StaticStylesheetAndJavascriptTags } from './index';
-
-describe('Module: StaticStylesheetAndJavascriptTags', () => {
-  it('should not report errors for static CSS content in stylesheet tags', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% stylesheet %}
-          .button {
-            background-color: blue;
-            color: white;
-            padding: 10px 20px;
-          }
-        {% endstylesheet %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should not report errors for static JavaScript content in javascript tags', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% javascript %}
-          function greet(name) {
-            console.log('Hello, ' + name + '!');
-          }
-          greet('World');
-        {% endjavascript %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should report error for liquid variable in stylesheet tag', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% stylesheet %}
-          .button {
-            background-color: {{ settings.button_color }};
-            color: white;
-          }
-        {% endstylesheet %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal(
-      'Liquid variable found in CSS block. {% stylesheet %} tags should only contain static CSS code.',
-    );
-
-    const highlights = highlightedOffenses(theme, offenses);
-    expect(highlights).to.eql(['{{ settings.button_color }}']);
-  });
-
-  it('should report error for liquid variable in javascript tag', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% javascript %}
-          const apiUrl = '{{ shop.url }}';
-          fetch(apiUrl);
-        {% endjavascript %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal(
-      'Liquid variable found in JavaScript block. {% javascript %} tags should only contain static JavaScript code.',
-    );
-
-    const highlights = highlightedOffenses(theme, offenses);
-    expect(highlights).to.eql(['{{ shop.url }}']);
-  });
-
-  it('should report error for liquid tag in stylesheet tag', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% stylesheet %}
-          .button {
-            {% if settings.enable_hover %}
-              background-color: blue;
-            {% endif %}
-          }
-        {% endstylesheet %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal(
-      'Liquid tag found in CSS block. {% stylesheet %} tags should only contain static CSS code.',
-    );
-
-    const highlights = highlightedOffenses(theme, offenses);
-    expect(highlights).to.eql([
-      `{% if settings.enable_hover %}
-              background-color: blue;
-            {% endif %}`,
-    ]);
-  });
-
-  it('should report error for liquid tag in javascript tag', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% javascript %}
-          {% if settings.enable_analytics %}
-            console.log('Analytics enabled');
-          {% endif %}
-        {% endjavascript %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal(
-      'Liquid tag found in JavaScript block. {% javascript %} tags should only contain static JavaScript code.',
-    );
-
-    const highlights = highlightedOffenses(theme, offenses);
-    expect(highlights).to.eql([
-      `{% if settings.enable_analytics %}
-            console.log('Analytics enabled');
-          {% endif %}`,
-    ]);
-  });
-
-  it('should report multiple errors for multiple liquid nodes', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% stylesheet %}
-          .button {
-            background-color: {{ settings.button_color }};
-            {% if settings.show_border %}
-              border: 1px solid {{ settings.border_color }};
-            {% endif %}
-          }
-        {% endstylesheet %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(2);
-    expect(offenses[0].message).to.include('Liquid variable found in CSS block');
-    expect(offenses[1].message).to.include('Liquid tag found in CSS block');
-
-    const highlights = highlightedOffenses(theme, offenses);
-    expect(highlights).to.eql([
-      '{{ settings.button_color }}',
-      `{% if settings.show_border %}
-              border: 1px solid {{ settings.border_color }};
-            {% endif %}`,
-    ]);
-  });
-
-  it('should not report errors for other raw tags like schema', async () => {
-    const theme = {
-      'sections/test.liquid': `
-        {% schema %}
-        {
-          "name": "Section",
-          "settings": [
-            {
-              "id": "color",
-              "type": "color",
-              "default": "{{ settings.default_color }}"
-            }
-          ]
-        }
-        {% endschema %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should not report errors for liquid in regular content outside raw tags', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        <div style="color: {{ settings.text_color }};">
-          {% if product.available %}
-            <button>Buy now</button>
-          {% endif %}
-        </div>
-
-        {% stylesheet %}
-          .static-style {
-            margin: 10px;
-          }
-        {% endstylesheet %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should report nested raw tags inside stylesheet tags', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% stylesheet %}
-          /* This should trigger an error */
-          {% raw %}
-            .nested { color: red; }
-          {% endraw %}
-        {% endstylesheet %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.include('Liquid tag found in CSS block');
-
-    const highlights = highlightedOffenses(theme, offenses);
-    expect(highlights).to.eql([
-      `{% raw %}
-            .nested { color: red; }
-          {% endraw %}`,
-    ]);
-  });
-
-  it('should not report offenses for empty stylesheet and javascript blocks', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% stylesheet %}
-        {% endstylesheet %}
-
-        {% javascript %}
-        {% endjavascript %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should not report errors for liquid in style tags (different from stylesheet)', async () => {
-    const theme = {
-      'templates/test.liquid': `
-        {% style %}
-          .button {
-            color: {{ settings.color }};
-          }
-        {% endstyle %}
-      `,
-    };
-
-    const offenses = await check(theme, [StaticStylesheetAndJavascriptTags]);
-    expect(offenses).to.have.length(0);
-  });
-});

package/src/checks/static-stylesheet-and-javascript-tags/index.ts

@@ -1,48 +0,0 @@
-import { NodeTypes } from '@platformos/liquid-html-parser';
-import { LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
-
-export const StaticStylesheetAndJavascriptTags: LiquidCheckDefinition = {
-  meta: {
-    code: 'StaticStylesheetAndJavascriptTags',
-    name: 'Reports non static stylesheet and javascript tags',
-    docs: {
-      description:
-        'Reports the usage of Liquid within {% stylesheet %} and {% javascript %} tags, which should only contain static content.',
-      recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/static-stylesheet-and-javascript-tags',
-    },
-    type: SourceCodeType.LiquidHtml,
-    severity: Severity.ERROR,
-    schema: {},
-    targets: [],
-  },
-
-  create(context) {
-    return {
-      async LiquidRawTag(node) {
-        if (node.name !== 'stylesheet' && node.name !== 'javascript') {
-          return;
-        }
-
-        const liquidNodes = node.body.nodes.filter(
-          (childNode) =>
-            childNode.type === NodeTypes.LiquidVariableOutput ||
-            childNode.type === NodeTypes.LiquidTag ||
-            childNode.type === NodeTypes.LiquidRawTag,
-        );
-
-        for (const liquidNode of liquidNodes) {
-          const tagType = node.name === 'stylesheet' ? 'CSS' : 'JavaScript';
-          const liquidType =
-            liquidNode.type === NodeTypes.LiquidVariableOutput ? 'variable' : 'tag';
-
-          context.report({
-            message: `Liquid ${liquidType} found in ${tagType} block. {% ${node.name} %} tags should only contain static ${tagType} code.`,
-            startIndex: liquidNode.position.start,
-            endIndex: liquidNode.position.end,
-          });
-        }
-      },
-    };
-  },
-};

package/src/checks/unique-settings-id/index.spec.ts

@@ -1,24 +0,0 @@
-import { expect, describe, it } from 'vitest';
-import { UniqueSettingIds } from './index';
-import { highlightedOffenses, runJSONCheck } from '../../test';
-import { invalidJson, validJson } from './test-data';
-
-describe('Module: UniqueSettingIds', () => {
-  it("Should report an error for duplicate id's in settings_schema (0)", async () => {
-    const offenses = await runJSONCheck(UniqueSettingIds, invalidJson, 'file.json');
-
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal('Duplicate setting id found: "nosto_account_id"');
-
-    const highlights = highlightedOffenses({ 'file.json': invalidJson }, offenses);
-
-    expect(highlights).to.have.length(1);
-    expect(highlights[0]).to.equal('"id": "nosto_account_id"');
-  });
-
-  it('should not report any errors for valid file', async () => {
-    const offenses = await runJSONCheck(UniqueSettingIds, validJson);
-
-    expect(offenses).to.be.empty;
-  });
-});

package/src/checks/unique-settings-id/index.ts

@@ -1,84 +0,0 @@
-import {
-  isArrayNode,
-  isLiteralNode,
-  isObjectNode,
-  isPropertyNode,
-  Severity,
-  SourceCodeType,
-} from '../../types';
-
-import type { ArrayNode, PropertyNode, JSONCheckDefinition } from '../../types';
-
-export const UniqueSettingIds: JSONCheckDefinition = {
-  meta: {
-    code: 'UniqueSettingId',
-    name: 'Prevent duplicate Ids in setting_schema',
-    docs: {
-      description: 'This check is aimed at eliminating duplicate Ids in settings_schema.json',
-      recommended: true,
-      // url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/valid-schema',
-    },
-    type: SourceCodeType.JSON,
-    severity: Severity.ERROR,
-    schema: {},
-    targets: [],
-  },
-
-  create(context) {
-    return {
-      async onCodePathEnd(file) {
-        if (isArrayNode(file.ast)) {
-          const settingIds: PropertyNode[] = [];
-
-          /* Find and loop through all of our nodes that have an id value and find their key value */
-          for (const child of file.ast.children) {
-            if (isObjectNode(child) && child.children) {
-              const settingsNode = child.children.find((node) => node.key.value === 'settings');
-
-              if (settingsNode && settingsNode.value && isArrayNode(settingsNode.value)) {
-                for (const setting of settingsNode.value.children) {
-                  if (isObjectNode(setting) && setting.children) {
-                    const idNode = setting.children.find((node) => node.key.value === 'id');
-                    if (isPropertyNode(idNode)) {
-                      settingIds.push(idNode);
-                    }
-                  }
-                }
-              }
-            }
-          }
-
-          /* Check for dupes */
-          const idMap = new Map<string, PropertyNode[]>();
-          for (const node of settingIds) {
-            if (isLiteralNode(node.value)) {
-              const id = node.value.value;
-              if (typeof id === 'string') {
-                if (!idMap.has(id)) {
-                  idMap.set(id, []);
-                }
-                idMap.get(id)!.push(node);
-              }
-            }
-          }
-
-          const duplicates: [string, PropertyNode[]][] = Array.from(idMap.entries()).filter(
-            ([_, nodes]) => nodes.length > 1,
-          );
-
-          if (duplicates.length > 0) {
-            for (const [id, nodes] of duplicates) {
-              const lastNodeFound = nodes[nodes.length - 1];
-
-              context.report({
-                message: `Duplicate setting id found: "${id}"`,
-                startIndex: lastNodeFound.loc.start.offset,
-                endIndex: lastNodeFound.loc.end.offset,
-              });
-            }
-          }
-        }
-      },
-    };
-  },
-};