@platformos/platformos-check-common 0.0.2

package/dist/checks/valid-visible-if/visible-if-utils.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.offsetAdjust = exports.adjustedSuffix = exports.adjustedPrefix = exports.variableExpressionMatcher = void 0;
+exports.getVariableLookupsInExpression = getVariableLookupsInExpression;
+exports.validateLookup = validateLookup;
+exports.getGlobalSettings = getGlobalSettings;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+const json_1 = require("../../json");
+const visitor_1 = require("../../visitor");
+exports.variableExpressionMatcher = /{{(.+?)}}/;
+exports.adjustedPrefix = '{% if ';
+exports.adjustedSuffix = ' %}{% endif %}';
+exports.offsetAdjust = '{{'.length - exports.adjustedPrefix.length;
+async function getVariableLookupsInExpression(expression) {
+    // As of February 2025, parsers other than LiquidJS don't yet support
+    // expressions in {{ variable }} tags. So we have to do something a little
+    // gnarly — before parsing it we extract the expression from within the tag
+    // and plunk it into an `{% if <expression> %}{% endif %}` statement instead.
+    // This requires us to adjust the reported character ranges and offer slightly
+    // less useful messages on syntax errors, but otherwise should behave
+    // similarly to a proper `{{ <expression> }}` syntax whenever it lands.
+    const match = exports.variableExpressionMatcher.exec(expression);
+    if (match == null) {
+        return {
+            warning: `Invalid visible_if expression. It should take the form "{{ <expression> }}".`,
+        };
+    }
+    const unwrappedExpression = match[1];
+    const adjustedExpression = `${exports.adjustedPrefix}${unwrappedExpression}${exports.adjustedSuffix}`;
+    try {
+        const innerAst = (0, liquid_html_parser_1.toLiquidHtmlAST)(adjustedExpression, {
+            mode: 'strict',
+            allowUnclosedDocumentNode: false,
+        });
+        if (innerAst.children.length !== 1) {
+            throw new Error('Unexpected child count for DocumentNode');
+        }
+        const ifTag = innerAst.children[0];
+        if (ifTag.type !== 'LiquidTag' || ifTag.name !== 'if') {
+            throw new Error("Expected DocumentNode to contain 'if' tag");
+        }
+        const expressionNode = ifTag.markup;
+        if (typeof expressionNode === 'string') {
+            return {
+                warning: `Invalid visible_if expression.`,
+            };
+        }
+        if (expressionNode.type === liquid_html_parser_1.NodeTypes.LiquidLiteral &&
+            ['true', 'false'].includes(expressionNode.keyword)) {
+            // Those are OK
+            return null;
+        }
+        const vars = await (0, visitor_1.visit)(ifTag, {
+            VariableLookup: async (node) => node,
+        });
+        if (vars.length === 0) {
+            return {
+                warning: `visible_if expression contains no references to any settings. This is likely an error.`,
+            };
+        }
+        return vars;
+    }
+    catch (error) {
+        if (error instanceof SyntaxError) {
+            // Because of our hackish approach, the underlying error is likely to
+            // include an incorrect character range and/or mention {% if %} tags.
+            // Squelch the details and just report it as a simple syntax error.
+            return { warning: 'Syntax error: cannot parse visible_if expression.' };
+        }
+        return { warning: String(error) };
+    }
+}
+function validateLookup(lookup, vars) {
+    const normalized = getNormalizedLookups(lookup);
+    const poppedSegments = [];
+    let scope = vars;
+    while (normalized.length > 0) {
+        const segment = normalized.shift();
+        poppedSegments.push(segment);
+        // "noUncheckedIndexedAccess" is false in our tsconfig.json
+        const next = scope[segment];
+        if (!next) {
+            return `Invalid variable: "${poppedSegments.join('.')}" was not found.`;
+        }
+        if (typeof next === 'boolean') {
+            if (normalized.length > 0) {
+                return `Invalid variable: "${poppedSegments.join('.')}" refers to a variable, but is being used here as a namespace.`;
+            }
+            return null;
+        }
+        scope = next;
+    }
+    // note this is the reverse of the above similar-looking case
+    return `Invalid variable: "${poppedSegments.join('.')}" refers to a namespace, but is being used here as a variable.`;
+}
+function getNormalizedLookups(lookup) {
+    const nestedLookups = lookup.lookups.map((lookup) => {
+        if (lookup.type !== liquid_html_parser_1.NodeTypes.String) {
+            throw new Error(`Expected lookups to be String nodes: ${JSON.stringify(lookup)}`);
+        }
+        return lookup.value;
+    });
+    return [lookup.name, ...nestedLookups];
+}
+async function getGlobalSettings(context) {
+    const globalSettings = [];
+    try {
+        const uri = context.toUri('config/settings_schema.json');
+        const settingsFile = await context.fs.readFile(uri);
+        const settings = (0, json_1.parseJSON)(settingsFile);
+        if (Array.isArray(settings)) {
+            for (const group of settings) {
+                if ('settings' in group && Array.isArray(group.settings)) {
+                    globalSettings.push(...group.settings.map((setting) => setting.id).filter((id) => id));
+                }
+            }
+        }
+    }
+    catch (e) {
+        console.error('Error fetching global settings:', e);
+        // ignore absent or malformed settings schema
+    }
+    return globalSettings;
+}
+//# sourceMappingURL=visible-if-utils.js.map

package/dist/checks/valid-visible-if/visible-if-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visible-if-utils.js","sourceRoot":"","sources":["../../../src/checks/valid-visible-if/visible-if-utils.ts"],"names":[],"mappings":";;;AAgBA,wEAwEC;AAED,wCAgCC;AAaD,8CAsBC;AA7JD,uEAIwC;AAExC,qCAAuC;AACvC,2CAAsC;AAIzB,QAAA,yBAAyB,GAAG,WAAW,CAAC;AACxC,QAAA,cAAc,GAAG,QAAQ,CAAC;AAC1B,QAAA,cAAc,GAAG,gBAAgB,CAAC;AAClC,QAAA,YAAY,GAAG,IAAI,CAAC,MAAM,GAAG,sBAAc,CAAC,MAAM,CAAC;AAEzD,KAAK,UAAU,8BAA8B,CAClD,UAAkB;IAElB,qEAAqE;IACrE,0EAA0E;IAC1E,2EAA2E;IAC3E,6EAA6E;IAC7E,8EAA8E;IAC9E,qEAAqE;IACrE,uEAAuE;IACvE,MAAM,KAAK,GAAG,iCAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO;YACL,OAAO,EAAE,8EAA8E;SACxF,CAAC;IACJ,CAAC;IACD,MAAM,mBAAmB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAErC,MAAM,kBAAkB,GAAG,GAAG,sBAAc,GAAG,mBAAmB,GAAG,sBAAc,EAAE,CAAC;IAEtF,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAA,oCAAe,EAAC,kBAAkB,EAAE;YACnD,IAAI,EAAE,QAAQ;YACd,yBAAyB,EAAE,KAAK;SACjC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEnC,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC;QACpC,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,OAAO;gBACL,OAAO,EAAE,gCAAgC;aAC1C,CAAC;QACJ,CAAC;QAED,IACE,cAAc,CAAC,IAAI,KAAK,8BAAS,CAAC,aAAa;YAC/C,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAClD,CAAC;YACD,eAAe;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAA,eAAK,EAAkD,KAAK,EAAE;YAC/E,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI;SACrC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO;gBACL,OAAO,EAAE,wFAAwF;aAClG,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,qEAAqE;YACrE,qEAAqE;YACrE,mEAAmE;YACnE,OAAO,EAAE,OAAO,EAAE,mDAAmD,EAAE,CAAC;QAC1E,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IACpC,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,MAA4B,EAAE,IAAU;IACrE,MAAM,UAAU,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAEhD,MAAM,cAAc,GAAG,EAAE,CAAC;IAC1B,IAAI,KAAK,GAAG,IAAI,CAAC;IACjB,OAAO,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,EAAG,CAAC;QACpC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE7B,2DAA2D;QAC3D,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAA4B,CAAC;QAEvD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,sBAAsB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC;QAC1E,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,sBAAsB,cAAc,CAAC,IAAI,CAC9C,GAAG,CACJ,gEAAgE,CAAC;YACpE,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,KAAK,GAAG,IAAI,CAAC;IACf,CAAC;IAED,6DAA6D;IAC7D,OAAO,sBAAsB,cAAc,CAAC,IAAI,CAC9C,GAAG,CACJ,gEAAgE,CAAC;AACpE,CAAC;AAED,SAAS,oBAAoB,CAAC,MAA4B;IACxD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAClD,IAAI,MAAM,CAAC,IAAI,KAAK,8BAAS,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,aAAa,CAAC,CAAC;AACzC,CAAC;AAEM,KAAK,UAAU,iBAAiB,CAAC,OAAgC;IACtE,MAAM,cAAc,GAAa,EAAE,CAAC;IAEpC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACzD,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,IAAA,gBAAS,EAAC,YAAY,CAAC,CAAC;QACzC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACzD,cAAc,CAAC,IAAI,CACjB,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAC5E,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,CAAC,CAAC,CAAC;QACpD,6CAA6C;IAC/C,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/dist/checks/variable-name/index.d.ts

@@ -0,0 +1,6 @@
+import { LiquidCheckDefinition, SchemaProp } from '../../types';
+declare const schema: {
+    format: SchemaProp<string>;
+};
+export declare const VariableName: LiquidCheckDefinition<typeof schema>;
+export {};

package/dist/checks/variable-name/index.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariableName = void 0;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+const types_1 = require("../../types");
+const lodash_1 = require("lodash");
+const pascalCase = (string) => {
+    const camelCased = (0, lodash_1.camelCase)(string);
+    return camelCased.charAt(0).toUpperCase() + camelCased.slice(1);
+};
+const isLiquidTagAssign = (node) => {
+    return node.name === 'assign' && typeof node.markup !== 'string';
+};
+const isLiquidTagCapture = (node) => {
+    return (node.type == liquid_html_parser_1.NodeTypes.LiquidTag && node.name === 'capture' && typeof node.markup !== 'string');
+};
+const formatTypes = {
+    camelCase: lodash_1.camelCase,
+    PascalCase: pascalCase,
+    snake_case: lodash_1.snakeCase,
+    'kebab-case': lodash_1.kebabCase,
+};
+const schema = {
+    format: types_1.SchemaProp.string('snake_case'),
+};
+// It's impossible to make an idempotent rule that works for all cases. We
+// have to accept whatever spacing the user has input as valid.
+// This function strips dash/underscores around digits so that we can at least
+// make sure that the variable name is in the "correct" format. (e.g. snake case)
+const collapseNumberSpacing = (varName) => varName.replace(/[-_]?\d[-_]?/g, '');
+exports.VariableName = {
+    meta: {
+        code: 'VariableName',
+        name: 'Invalid variable naming format',
+        docs: {
+            description: 'This check is aimed at using certain variable naming conventions',
+            url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/variable-name',
+            recommended: true,
+        },
+        type: types_1.SourceCodeType.LiquidHtml,
+        severity: types_1.Severity.WARNING,
+        schema,
+        targets: [],
+    },
+    create(context) {
+        const formatter = (node) => {
+            if (!node.markup.name) {
+                return {
+                    valid: false,
+                };
+            }
+            const formatter = formatTypes[context.settings.format];
+            const suggestion = formatter(node.markup.name);
+            return {
+                valid: collapseNumberSpacing(node.markup.name) === collapseNumberSpacing(suggestion),
+                suggestion,
+            };
+        };
+        const reportHandler = (node) => {
+            return context.report({
+                message: `The variable '${node.markup.name}' uses wrong naming format`,
+                startIndex: node.markup.position.start,
+                endIndex: node.markup.position.end,
+                suggest: [
+                    {
+                        message: `Change variable '${node.markup.name}' to '${formatter(node).suggestion}'`,
+                        fix: (corrector) => {
+                            const { position, name, source } = node.markup;
+                            return corrector.replace(position.start, position.end, source
+                                .slice(position.start, position.end)
+                                .replace(name, formatter(node).suggestion));
+                        },
+                    },
+                ],
+            });
+        };
+        return {
+            async LiquidTag(node) {
+                if (isLiquidTagAssign(node)) {
+                    if (!formatter(node).valid) {
+                        reportHandler(node);
+                    }
+                }
+                else if (isLiquidTagCapture(node) && node.markup.name) {
+                    if (!formatter(node).valid) {
+                        reportHandler(node);
+                    }
+                }
+            },
+        };
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/checks/variable-name/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/variable-name/index.ts"],"names":[],"mappings":";;;AAAA,uEAMwC;AACxC,uCAA0F;AAC1F,mCAAyD;AAEzD,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE;IACpC,MAAM,UAAU,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;IACrC,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,IAAe,EAA2B,EAAE;IACrE,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,IAAoB,EAA4B,EAAE;IAC5E,OAAO,CACL,IAAI,CAAC,IAAI,IAAI,8BAAS,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAC/F,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG;IAClB,SAAS,EAAE,kBAAS;IACpB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE,kBAAS;IACrB,YAAY,EAAE,kBAAS;CACxB,CAAC;AAIF,MAAM,MAAM,GAAG;IACb,MAAM,EAAE,kBAAU,CAAC,MAAM,CAAC,YAAY,CAAC;CACxC,CAAC;AAEF,0EAA0E;AAC1E,+DAA+D;AAC/D,8EAA8E;AAC9E,iFAAiF;AACjF,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;AAE3E,QAAA,YAAY,GAAyC;IAChE,IAAI,EAAE;QACJ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE;YACJ,WAAW,EAAE,kEAAkE;YAC/E,GAAG,EAAE,oFAAoF;YACzF,WAAW,EAAE,IAAI;SAClB;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,OAAO;QAC1B,MAAM;QACN,OAAO,EAAE,EAAE;KACZ;IAED,MAAM,CAAC,OAAO;QACZ,MAAM,SAAS,GAAG,CAAC,IAAwC,EAAE,EAAE;YAC7D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACtB,OAAO;oBACL,KAAK,EAAE,KAAK;iBACb,CAAC;YACJ,CAAC;YAED,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAqB,CAAC,CAAC;YACtE,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAE/C,OAAO;gBACL,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,qBAAqB,CAAC,UAAU,CAAC;gBACpF,UAAU;aACX,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,CAAC,IAAwC,EAAE,EAAE;YACjE,OAAO,OAAO,CAAC,MAAM,CAAC;gBACpB,OAAO,EAAE,iBAAiB,IAAI,CAAC,MAAM,CAAC,IAAI,4BAA4B;gBACtE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK;gBACtC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG;gBAClC,OAAO,EAAE;oBACP;wBACE,OAAO,EAAE,oBAAoB,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,SAAS,CAAC,IAAI,CAAC,CAAC,UAAU,GAAG;wBACnF,GAAG,EAAE,CAAC,SAAS,EAAE,EAAE;4BACjB,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;4BAE/C,OAAO,SAAS,CAAC,OAAO,CACtB,QAAQ,CAAC,KAAK,EACd,QAAQ,CAAC,GAAG,EACZ,MAAM;iCACH,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC;iCACnC,OAAO,CAAC,IAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,UAAW,CAAC,CAC/C,CAAC;wBACJ,CAAC;qBACF;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,OAAO;YACL,KAAK,CAAC,SAAS,CAAC,IAAI;gBAClB,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;wBAC3B,aAAa,CAAC,IAAI,CAAC,CAAC;oBACtB,CAAC;gBACH,CAAC;qBAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBACxD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;wBAC3B,aAAa,CAAC,IAAI,CAAC,CAAC;oBACtB,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/context-utils.d.ts

@@ -0,0 +1,15 @@
+import { AbstractFileSystem, FileTuple, UriString } from '@platformos/platformos-common';
+import { MetafieldCategory, MetafieldDefinitionMap, Theme, Translations } from './types';
+export type FileExists = (uri: string) => Promise<boolean>;
+export declare const makeFileExists: (fs: AbstractFileSystem) => FileExists;
+export declare const makeFileSize: (fs: AbstractFileSystem) => (uri: string) => Promise<number>;
+export declare const makeGetDefaultLocaleFileUri: (fs: AbstractFileSystem) => (rootUri: string) => Promise<string | undefined>;
+export declare const makeGetDefaultSchemaLocaleFileUri: (fs: AbstractFileSystem) => (rootUri: string) => Promise<string | undefined>;
+export declare const makeGetDefaultLocale: (fs: AbstractFileSystem, rootUri: string) => () => Promise<string>;
+export declare const makeGetDefaultSchemaLocale: (fs: AbstractFileSystem, rootUri: string) => () => Promise<string>;
+export declare const makeGetDefaultTranslations: (fs: AbstractFileSystem, theme: Theme, rootUri: string) => () => Promise<Translations>;
+export declare const makeGetDefaultSchemaTranslations: (fs: AbstractFileSystem, theme: Theme, rootUri: string) => () => Promise<Translations>;
+export declare function recursiveReadDirectory(fs: AbstractFileSystem, uri: string, filter: (fileTuple: FileTuple) => boolean): Promise<UriString[]>;
+export declare function isDirectory([_, type]: FileTuple): boolean;
+export declare const FETCHED_METAFIELD_CATEGORIES: MetafieldCategory[];
+export declare const makeGetMetafieldDefinitions: (fs: AbstractFileSystem) => (rootUri: string) => Promise<MetafieldDefinitionMap>;

package/dist/context-utils.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeGetMetafieldDefinitions = exports.FETCHED_METAFIELD_CATEGORIES = exports.makeGetDefaultSchemaTranslations = exports.makeGetDefaultTranslations = exports.makeGetDefaultSchemaLocale = exports.makeGetDefaultLocale = exports.makeGetDefaultSchemaLocaleFileUri = exports.makeGetDefaultLocaleFileUri = exports.makeFileSize = exports.makeFileExists = void 0;
+exports.recursiveReadDirectory = recursiveReadDirectory;
+exports.isDirectory = isDirectory;
+const vscode_uri_1 = require("vscode-uri");
+const platformos_common_1 = require("@platformos/platformos-common");
+const json_1 = require("./json");
+const path_1 = require("./path");
+const types_1 = require("./types");
+const utils_1 = require("./utils");
+const makeFileExists = (fs) => async function fileExists(uri) {
+    try {
+        await fs.stat(uri);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+};
+exports.makeFileExists = makeFileExists;
+const makeFileSize = (fs) => async function fileSize(uri) {
+    try {
+        const stats = await fs.stat(uri);
+        return stats.size;
+    }
+    catch (error) {
+        return 0;
+    }
+};
+exports.makeFileSize = makeFileSize;
+exports.makeGetDefaultLocaleFileUri = getDefaultLocaleFileUriFactoryFactory('default.json');
+exports.makeGetDefaultSchemaLocaleFileUri = getDefaultLocaleFileUriFactoryFactory('.default.schema.json');
+function getDefaultLocaleFileUriFactoryFactory(postfix = '.default.json') {
+    return function getDefaultLocaleFileUriFactory(fs) {
+        return (rootUri) => getDefaultLocaleFile(fs, rootUri, postfix);
+    };
+}
+exports.makeGetDefaultLocale = getDefaultLocaleFactoryFactory('.default.json');
+exports.makeGetDefaultSchemaLocale = getDefaultLocaleFactoryFactory('.default.schema.json');
+function getDefaultLocaleFactoryFactory(postfix = '.default.json') {
+    return function getDefaultLocaleFactory(fs, rootUri) {
+        return cached(() => getDefaultLocale(fs, rootUri, postfix));
+    };
+}
+exports.makeGetDefaultTranslations = getDefaultTranslationsFactoryFactory('.default.json');
+exports.makeGetDefaultSchemaTranslations = getDefaultTranslationsFactoryFactory('.default.schema.json');
+// prettier-ignore
+function getDefaultTranslationsFactoryFactory(postfix = '.default.json') {
+    return function getDefaultTranslationsFactory(fs, theme, rootUri) {
+        return cached(() => getDefaultTranslations(fs, theme, rootUri, postfix));
+    };
+}
+async function getDefaultLocaleFile(fs, rootUri, postfix = '.default.json') {
+    const files = await fs.readDirectory((0, path_1.join)(rootUri, 'locales'));
+    return files.find(([uri]) => uri.endsWith(postfix))?.[0];
+}
+async function getDefaultLocale(fs, rootUri, postfix) {
+    try {
+        const defaultLocaleFile = await getDefaultLocaleFile(fs, rootUri, postfix);
+        if (!defaultLocaleFile)
+            return 'en';
+        const defaultLocaleFileName = vscode_uri_1.Utils.basename(vscode_uri_1.URI.parse(defaultLocaleFile));
+        return defaultLocaleFileName.split('.')[0];
+    }
+    catch (error) {
+        console.error(error);
+        return 'en';
+    }
+}
+async function getDefaultTranslations(fs, theme, rootUri, postfix) {
+    try {
+        const bufferTranslations = getDefaultTranslationsFromBuffer(theme, postfix);
+        if (bufferTranslations)
+            return bufferTranslations;
+        const defaultLocaleFile = await getDefaultLocaleFile(fs, rootUri, postfix);
+        if (!defaultLocaleFile)
+            return {};
+        const defaultTranslationsFile = await fs.readFile(defaultLocaleFile);
+        return (0, json_1.parseJSON)(defaultTranslationsFile, {});
+    }
+    catch (error) {
+        console.error(error);
+        return {};
+    }
+}
+/** It might be that you have an open buffer, we prefer translations from there if available */
+function getDefaultTranslationsFromBuffer(theme, postfix) {
+    const defaultTranslationsSourceCode = theme.find((sourceCode) => sourceCode.type === types_1.SourceCodeType.JSON &&
+        sourceCode.uri.match(/locales/) &&
+        sourceCode.uri.endsWith(postfix));
+    if (!defaultTranslationsSourceCode)
+        return undefined;
+    const translations = (0, json_1.parseJSON)(defaultTranslationsSourceCode.source);
+    if ((0, utils_1.isError)(translations))
+        return undefined;
+    return translations;
+}
+function cached(fn) {
+    let cachedPromise;
+    return async (...args) => {
+        if (!cachedPromise)
+            cachedPromise = fn(...args);
+        return cachedPromise;
+    };
+}
+async function recursiveReadDirectory(fs, uri, filter) {
+    const allFiles = await fs.readDirectory(uri);
+    const files = allFiles.filter((ft) => !isIgnored(ft) && (isDirectory(ft) || filter(ft)));
+    const results = await Promise.all(files.map((ft) => {
+        if (isDirectory(ft)) {
+            return recursiveReadDirectory(fs, ft[0], filter);
+        }
+        else {
+            return Promise.resolve([ft[0]]);
+        }
+    }));
+    return results.flat();
+}
+function isDirectory([_, type]) {
+    return type === platformos_common_1.FileType.Directory;
+}
+const ignoredFolders = ['.git', 'node_modules', 'dist', 'build', 'tmp', 'vendor'];
+function isIgnored([uri, type]) {
+    return type === platformos_common_1.FileType.Directory && ignoredFolders.some((folder) => uri.endsWith(folder));
+}
+exports.FETCHED_METAFIELD_CATEGORIES = [
+    'article',
+    'blog',
+    'collection',
+    'company',
+    'company_location',
+    'location',
+    'market',
+    'order',
+    'page',
+    'product',
+    'variant',
+    'shop',
+];
+const makeGetMetafieldDefinitions = (fs) => async function (rootUri) {
+    const definitions = {
+        article: [],
+        blog: [],
+        collection: [],
+        company: [],
+        company_location: [],
+        location: [],
+        market: [],
+        order: [],
+        page: [],
+        product: [],
+        variant: [],
+        shop: [],
+    };
+    try {
+        const content = await fs.readFile((0, path_1.join)(rootUri, '.shopify', 'metafields.json'));
+        const json = (0, json_1.parseJSON)(content);
+        if ((0, utils_1.isError)(json))
+            return definitions;
+        return exports.FETCHED_METAFIELD_CATEGORIES.reduce((definitions, group) => {
+            try {
+                definitions[group] = json[group].map((definition) => ({
+                    key: definition.key,
+                    name: definition.name,
+                    namespace: definition.namespace,
+                    description: definition.description,
+                    type: {
+                        category: definition.type.category,
+                        name: definition.type.name,
+                    },
+                }));
+            }
+            catch (error) {
+                // If there are errors in the file, we ignore it
+            }
+            return definitions;
+        }, definitions);
+    }
+    catch (err) {
+        return definitions;
+    }
+};
+exports.makeGetMetafieldDefinitions = makeGetMetafieldDefinitions;
+//# sourceMappingURL=context-utils.js.map

package/dist/context-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-utils.js","sourceRoot":"","sources":["../src/context-utils.ts"],"names":[],"mappings":";;;AAiIA,wDAmBC;AAED,kCAEC;AAxJD,2CAAwC;AACxC,qEAAmG;AACnG,iCAAmC;AACnC,iCAA8B;AAC9B,mCAMiB;AACjB,mCAAkC;AAI3B,MAAM,cAAc,GAAG,CAAC,EAAsB,EAAc,EAAE,CACnE,KAAK,UAAU,UAAU,CAAC,GAAW;IACnC,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AARS,QAAA,cAAc,kBAQvB;AAEG,MAAM,YAAY,GAAG,CAAC,EAAsB,EAAE,EAAE,CACrD,KAAK,UAAU,QAAQ,CAAC,GAAW;IACjC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC,CAAC;AARS,QAAA,YAAY,gBAQrB;AAES,QAAA,2BAA2B,GAAG,qCAAqC,CAAC,cAAc,CAAC,CAAC;AACpF,QAAA,iCAAiC,GAC5C,qCAAqC,CAAC,sBAAsB,CAAC,CAAC;AAChE,SAAS,qCAAqC,CAAC,OAAO,GAAG,eAAe;IACtE,OAAO,SAAS,8BAA8B,CAAC,EAAsB;QACnE,OAAO,CAAC,OAAe,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC,CAAC;AACJ,CAAC;AAEY,QAAA,oBAAoB,GAAG,8BAA8B,CAAC,eAAe,CAAC,CAAC;AACvE,QAAA,0BAA0B,GAAG,8BAA8B,CAAC,sBAAsB,CAAC,CAAC;AACjG,SAAS,8BAA8B,CAAC,OAAO,GAAG,eAAe;IAC/D,OAAO,SAAS,uBAAuB,CAAC,EAAsB,EAAE,OAAe;QAC7E,OAAO,MAAM,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAEY,QAAA,0BAA0B,GAAG,oCAAoC,CAAC,eAAe,CAAC,CAAC;AACnF,QAAA,gCAAgC,GAC3C,oCAAoC,CAAC,sBAAsB,CAAC,CAAC;AAC/D,kBAAkB;AAClB,SAAS,oCAAoC,CAAC,OAAO,GAAG,eAAe;IACrE,OAAO,SAAS,6BAA6B,CAAC,EAAsB,EAAE,KAAY,EAAE,OAAe;QACjG,OAAO,MAAM,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,EAAsB,EACtB,OAAe,EACf,OAAO,GAAG,eAAe;IAEzB,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/D,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,EAAsB,EACtB,OAAe,EACf,OAAe;IAEf,IAAI,CAAC;QACH,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,iBAAiB;YAAE,OAAO,IAAI,CAAC;QACpC,MAAM,qBAAqB,GAAG,kBAAK,CAAC,QAAQ,CAAC,gBAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAC3E,OAAO,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,EAAsB,EACtB,KAAY,EACZ,OAAe,EACf,OAAe;IAEf,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,gCAAgC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC5E,IAAI,kBAAkB;YAAE,OAAO,kBAAkB,CAAC;QAClD,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,iBAAiB;YAAE,OAAO,EAAE,CAAC;QAClC,MAAM,uBAAuB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACrE,OAAO,IAAA,gBAAS,EAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,+FAA+F;AAC/F,SAAS,gCAAgC,CAAC,KAAY,EAAE,OAAe;IACrE,MAAM,6BAA6B,GAAG,KAAK,CAAC,IAAI,CAC9C,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,IAAI;QACvC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC;QAC/B,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CACnC,CAAC;IACF,IAAI,CAAC,6BAA6B;QAAE,OAAO,SAAS,CAAC;IACrD,MAAM,YAAY,GAAG,IAAA,gBAAS,EAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;IACrE,IAAI,IAAA,eAAO,EAAC,YAAY,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5C,OAAO,YAAY,CAAC;AACtB,CAAC;AAGD,SAAS,MAAM,CAAI,EAAkC;IACnD,IAAI,aAAyB,CAAC;IAC9B,OAAO,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;QACvB,IAAI,CAAC,aAAa;YAAE,aAAa,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAChD,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,sBAAsB,CAC1C,EAAsB,EACtB,GAAW,EACX,MAAyC;IAEzC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACf,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;YACpB,OAAO,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC;AAED,SAAgB,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAY;IAC9C,OAAO,IAAI,KAAK,4BAAQ,CAAC,SAAS,CAAC;AACrC,CAAC;AAED,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AAElF,SAAS,SAAS,CAAC,CAAC,GAAG,EAAE,IAAI,CAAY;IACvC,OAAO,IAAI,KAAK,4BAAQ,CAAC,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9F,CAAC;AAEY,QAAA,4BAA4B,GAAwB;IAC/D,SAAS;IACT,MAAM;IACN,YAAY;IACZ,SAAS;IACT,kBAAkB;IAClB,UAAU;IACV,QAAQ;IACR,OAAO;IACP,MAAM;IACN,SAAS;IACT,SAAS;IACT,MAAM;CACP,CAAC;AAEK,MAAM,2BAA2B,GAAG,CAAC,EAAsB,EAAE,EAAE,CACpE,KAAK,WAAW,OAAe;IAC7B,MAAM,WAAW,GAAG;QAClB,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,EAAE;QACR,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,EAAE;QACX,gBAAgB,EAAE,EAAE;QACpB,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,EAAE;QACT,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,EAAE;KACiB,CAAC;IAE5B,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC;QAChF,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,IAAA,eAAO,EAAC,IAAI,CAAC;YAAE,OAAO,WAAW,CAAC;QAEtC,OAAO,oCAA4B,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE;YAChE,IAAI,CAAC;gBACH,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,UAAe,EAAE,EAAE,CAAC,CAAC;oBACzD,GAAG,EAAE,UAAU,CAAC,GAAG;oBACnB,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,SAAS,EAAE,UAAU,CAAC,SAAS;oBAC/B,WAAW,EAAE,UAAU,CAAC,WAAW;oBACnC,IAAI,EAAE;wBACJ,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ;wBAClC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI;qBAC3B;iBACF,CAAC,CAAC,CAAC;YACN,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,gDAAgD;YAClD,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC,EAAE,WAAW,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,WAAW,CAAC;IACrB,CAAC;AACH,CAAC,CAAC;AA5CS,QAAA,2BAA2B,+BA4CpC"}

package/dist/create-safe-check.d.ts

@@ -0,0 +1,2 @@
+import { Check, SourceCodeType } from './types';
+export declare function createSafeCheck<S extends SourceCodeType>(check: Partial<Check<S>>): Check<S>;

package/dist/create-safe-check.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSafeCheck = createSafeCheck;
+const resolve = () => Promise.resolve(undefined);
+const handleMissingMethod = {
+    get(target, prop) {
+        if (!(prop in target))
+            return resolve;
+        return target[prop];
+    },
+};
+function createSafeCheck(check) {
+    return new Proxy(check, handleMissingMethod);
+}
+//# sourceMappingURL=create-safe-check.js.map

package/dist/create-safe-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-safe-check.js","sourceRoot":"","sources":["../src/create-safe-check.ts"],"names":[],"mappings":";;AAUA,0CAEC;AAVD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,mBAAmB,GAAG;IAC1B,GAAG,CAAC,MAAW,EAAE,IAAY;QAC3B,IAAI,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC;YAAE,OAAO,OAAO,CAAC;QACtC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;CACF,CAAC;AAEF,SAAgB,eAAe,CAA2B,KAAwB;IAChF,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;AAC/C,CAAC"}

package/dist/disabled-checks/index.d.ts

@@ -0,0 +1,7 @@
+import { LiquidHtmlNode, Position } from '@platformos/liquid-html-parser';
+import { LiquidCheckDefinition, Offense } from '../types';
+export declare function createDisabledChecksModule(): {
+    DisabledChecksVisitor: LiquidCheckDefinition;
+    isDisabled: (offense: Offense) => boolean;
+};
+export declare function findNextLinePosition(ast: LiquidHtmlNode, node: LiquidHtmlNode): Position | undefined;

package/dist/disabled-checks/index.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDisabledChecksModule = createDisabledChecksModule;
+exports.findNextLinePosition = findNextLinePosition;
+const types_1 = require("../types");
+const visitor_1 = require("../visitor");
+const utils_1 = require("../utils");
+function createDisabledChecksModule() {
+    const SPECIFIC_CHECK_NOT_DEFINED = '@all';
+    const INLINE_COMMENT_TAG = '#';
+    const disabledChecks = new Map();
+    function determineRanges(file, value, node) {
+        const [_, command, checksJoined] = value.trim().match(/^(?:theme\-check\-(disable-next-line|disable|enable)) ?(.*)/) || [];
+        const checks = checksJoined ? checksJoined.split(/,[ ]*/) : [SPECIFIC_CHECK_NOT_DEFINED];
+        checks.forEach((check) => {
+            const disabledRanges = disabledChecks.get(file.uri);
+            if (command === 'disable-next-line' && !(0, utils_1.isError)(file.ast)) {
+                const nextLinePosition = findNextLinePosition(file.ast, node);
+                if (nextLinePosition) {
+                    if (!disabledRanges.has(check)) {
+                        disabledRanges.set(check, []);
+                    }
+                    disabledRanges.get(check).push({
+                        from: nextLinePosition.start,
+                        to: nextLinePosition.end,
+                    });
+                }
+            }
+            if (command === 'disable') {
+                if (!disabledRanges.has(check)) {
+                    disabledRanges.set(check, []);
+                }
+                disabledRanges.get(check).push({ from: node.position.end });
+            }
+            if (command === 'enable') {
+                let disabledRangesForCheck = disabledRanges.get(check);
+                if (disabledRangesForCheck) {
+                    disabledRangesForCheck[disabledRangesForCheck.length - 1].to = node.position.start;
+                }
+                else {
+                    if (check === SPECIFIC_CHECK_NOT_DEFINED) {
+                        for (let ranges of disabledRanges.values()) {
+                            for (let range of ranges) {
+                                if (!range.to) {
+                                    range.to = node.position.start;
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        });
+    }
+    const DisabledChecksVisitor = {
+        meta: { schema: {} },
+        create: ({ file }) => ({
+            async onCodePathStart() {
+                disabledChecks.set(file.uri, new Map());
+            },
+            async LiquidRawTag(node) {
+                if (node.name !== 'comment') {
+                    return;
+                }
+                determineRanges(file, node.body.value, node);
+            },
+            async LiquidTag(node) {
+                if (typeof node.markup !== 'string' || node.name !== INLINE_COMMENT_TAG) {
+                    return;
+                }
+                determineRanges(file, node.markup, node);
+            },
+        }),
+    };
+    function isDisabled(offense) {
+        const ranges = [SPECIFIC_CHECK_NOT_DEFINED, offense.check].flatMap((check) => {
+            if (!disabledChecks.has(offense.uri)) {
+                return [];
+            }
+            if (!disabledChecks.get(offense.uri).has(check)) {
+                return [];
+            }
+            return disabledChecks.get(offense.uri).get(check);
+        });
+        return ranges.some((range) => offense.start.index >= range.from && (!range.to || offense.end.index <= range.to));
+    }
+    return {
+        DisabledChecksVisitor,
+        isDisabled,
+    };
+}
+function findNextLinePosition(ast, node) {
+    const [currentNode, ancestors] = (0, visitor_1.findCurrentNode)(ast, node.position.end);
+    const parentNode = ancestors.at(-1);
+    const grandParentNode = ancestors.at(-2);
+    let nextNode = getNextNode(parentNode, currentNode);
+    /*
+     * If there is no "next" node, assume they mean the parent block's next node.
+     *
+     * E.g. The following disables check for `elsif` tag
+     *
+     * {% if condition %}
+     *   {% #theme-check-disable-next-line %}
+     * {% elsif other_condition %}
+     *   {{ prouduct }}
+     * {% endif %}
+     *
+     * NOTE: We don't want to do this recursively since it doesn't make sense to go
+     * past 1 depth.
+     */
+    if (!nextNode) {
+        if (parentNode) {
+            nextNode = getNextNode(grandParentNode, parentNode);
+        }
+        if (!nextNode) {
+            return;
+        }
+    }
+    /*
+     * If the node contains children nodes, we don't want to disable checks for them.
+     * We want to keep it exclusively to the tag itself.
+     */
+    if ('blockStartPosition' in nextNode) {
+        return nextNode.blockStartPosition;
+    }
+    return nextNode.position;
+}
+function getNextNode(parentNode, node) {
+    if (!parentNode) {
+        return;
+    }
+    let siblingNodes = [];
+    // Could be sibling nodes within a `liquid` tag
+    if (parentNode.type === types_1.LiquidHtmlNodeTypes.LiquidTag && Array.isArray(parentNode.markup)) {
+        siblingNodes = parentNode.markup;
+    }
+    else if ('children' in parentNode) {
+        siblingNodes = parentNode.children || [];
+    }
+    const currentNodeIdx = siblingNodes.findIndex((c) => c === node);
+    if (currentNodeIdx === -1)
+        return;
+    const nextNode = siblingNodes.at(currentNodeIdx + 1);
+    return nextNode;
+}
+//# sourceMappingURL=index.js.map

package/dist/disabled-checks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/disabled-checks/index.ts"],"names":[],"mappings":";;AAeA,gEAuGC;AAED,oDA0CC;AAjKD,oCAOkB;AAClB,wCAA6C;AAC7C,oCAAmC;AAKnC,SAAgB,0BAA0B;IACxC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC1C,MAAM,kBAAkB,GAAG,GAAG,CAAC;IAC/B,MAAM,cAAc,GAAsB,IAAI,GAAG,EAAE,CAAC;IAEpD,SAAS,eAAe,CACtB,IAA2C,EAC3C,KAAa,EACb,IAA8B;QAE9B,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,GAC9B,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,6DAA6D,CAAC,IAAI,EAAE,CAAC;QAE1F,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC;QAEzF,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAE,CAAC;YAErD,IAAI,OAAO,KAAK,mBAAmB,IAAI,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAE9D,IAAI,gBAAgB,EAAE,CAAC;oBACrB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBAChC,CAAC;oBACD,cAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC;wBAC9B,IAAI,EAAE,gBAAgB,CAAC,KAAK;wBAC5B,EAAE,EAAE,gBAAgB,CAAC,GAAG;qBACzB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAChC,CAAC;gBACD,cAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;YAC/D,CAAC;YAED,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACzB,IAAI,sBAAsB,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACvD,IAAI,sBAAsB,EAAE,CAAC;oBAC3B,sBAAsB,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACrF,CAAC;qBAAM,CAAC;oBACN,IAAI,KAAK,KAAK,0BAA0B,EAAE,CAAC;wBACzC,KAAK,IAAI,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC;4BAC3C,KAAK,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;gCACzB,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;oCACd,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gCACjC,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,qBAAqB,GAA0B;QACnD,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAS;QAC3B,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YACrB,KAAK,CAAC,eAAe;gBACnB,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;YAC1C,CAAC;YAED,KAAK,CAAC,YAAY,CAAC,IAAI;gBACrB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO;gBACT,CAAC;gBAED,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/C,CAAC;YAED,KAAK,CAAC,SAAS,CAAC,IAAI;gBAClB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;oBACxE,OAAO;gBACT,CAAC;gBAED,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC;KACH,CAAC;IAEF,SAAS,UAAU,CAAC,OAAgB;QAClC,MAAM,MAAM,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjD,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAE,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,IAAI,CAChB,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,qBAAqB;QACrB,UAAU;KACX,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,GAAmB,EACnB,IAAoB;IAEpB,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,IAAA,yBAAe,EAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,eAAe,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzC,IAAI,QAAQ,GAAG,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACpD;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,IAAI,UAAU,EAAE,CAAC;YACf,QAAQ,GAAG,WAAW,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAI,oBAAoB,IAAI,QAAQ,EAAE,CAAC;QACrC,OAAO,QAAQ,CAAC,kBAAkB,CAAC;IACrC,CAAC;IAED,OAAO,QAAQ,CAAC,QAAQ,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAClB,UAAsC,EACtC,IAAoB;IAEpB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,IAAI,YAAY,GAAqB,EAAE,CAAC;IAExC,+CAA+C;IAC/C,IAAI,UAAU,CAAC,IAAI,KAAK,2BAAmB,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1F,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;IACnC,CAAC;SAAM,IAAI,UAAU,IAAI,UAAU,EAAE,CAAC;QACpC,YAAY,GAAG,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IAEjE,IAAI,cAAc,KAAK,CAAC,CAAC;QAAE,OAAO;IAElC,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;IAErD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/disabled-checks/test-checks.d.ts

@@ -0,0 +1,3 @@
+import { LiquidCheckDefinition } from '..';
+export declare const LiquidFilter: LiquidCheckDefinition;
+export declare const RenderMarkup: LiquidCheckDefinition;