@platformos/platformos-check-common 0.0.2

package/dist/checks/unknown-property/property-shape.js

@@ -0,0 +1,267 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inferShapeFromJSON = inferShapeFromJSON;
+exports.inferShapeFromJSONString = inferShapeFromJSONString;
+exports.inferShapeFromGraphQL = inferShapeFromGraphQL;
+exports.lookupPropertyPath = lookupPropertyPath;
+exports.getAvailableProperties = getAvailableProperties;
+exports.mergePropertyIntoShape = mergePropertyIntoShape;
+const language_1 = require("graphql/language");
+const graphql_1 = require("graphql");
+const json_1 = require("../../json");
+const utils_1 = require("../../utils");
+/**
+ * Merge two shapes together, combining their properties
+ */
+function mergeShapes(a, b) {
+    // If same kind, merge appropriately
+    if (a.kind === 'object' && b.kind === 'object') {
+        const properties = new Map(a.properties);
+        if (b.properties) {
+            for (const [key, val] of b.properties) {
+                const existing = properties.get(key);
+                if (existing) {
+                    properties.set(key, mergeShapes(existing, val));
+                }
+                else {
+                    properties.set(key, val);
+                }
+            }
+        }
+        return { kind: 'object', properties };
+    }
+    if (a.kind === 'array' && b.kind === 'array') {
+        const itemShape = a.itemShape && b.itemShape
+            ? mergeShapes(a.itemShape, b.itemShape)
+            : a.itemShape || b.itemShape;
+        return { kind: 'array', itemShape };
+    }
+    // Different kinds or primitives - prefer the first
+    return a;
+}
+/**
+ * Infer shape from a parsed JSON value
+ */
+function inferShapeFromJSON(value) {
+    if (value === null) {
+        return { kind: 'primitive', primitiveType: 'null' };
+    }
+    if (typeof value === 'string') {
+        return { kind: 'primitive', primitiveType: 'string' };
+    }
+    if (typeof value === 'number') {
+        return { kind: 'primitive', primitiveType: 'number' };
+    }
+    if (typeof value === 'boolean') {
+        return { kind: 'primitive', primitiveType: 'boolean' };
+    }
+    if (Array.isArray(value)) {
+        // Merge shapes from all array elements
+        let itemShape;
+        for (const item of value) {
+            const shape = inferShapeFromJSON(item);
+            itemShape = itemShape ? mergeShapes(itemShape, shape) : shape;
+        }
+        return { kind: 'array', itemShape };
+    }
+    if (typeof value === 'object') {
+        const properties = new Map();
+        for (const [key, val] of Object.entries(value)) {
+            properties.set(key, inferShapeFromJSON(val));
+        }
+        return { kind: 'object', properties };
+    }
+    return { kind: 'primitive' };
+}
+/**
+ * Try to parse a string as JSON and infer its shape
+ */
+function inferShapeFromJSONString(jsonString) {
+    const parsed = (0, json_1.parseJSON)(jsonString);
+    // parseJSON returns Error on strict mode failure, or undefined for invalid JSON
+    // We only want to infer shapes for valid JSON objects/arrays
+    if ((0, utils_1.isError)(parsed) || parsed === undefined || parsed === null) {
+        return undefined;
+    }
+    // Only infer shapes for objects and arrays, not primitive JSON values
+    if (typeof parsed !== 'object') {
+        return undefined;
+    }
+    return inferShapeFromJSON(parsed);
+}
+/**
+ * Unwrap NonNull and get the underlying type
+ */
+function unwrapType(type) {
+    if ((0, graphql_1.isNonNullType)(type)) {
+        return type.ofType;
+    }
+    return type;
+}
+/**
+ * Check if a type is a list (array) type
+ */
+function isArrayType(type) {
+    const unwrapped = unwrapType(type);
+    return (0, graphql_1.isListType)(unwrapped);
+}
+/**
+ * Convert a GraphQL SelectionSet to a PropertyShape using schema for type info
+ */
+function selectionSetToShape(selectionSet, parentType) {
+    const properties = new Map();
+    for (const selection of selectionSet.selections) {
+        if (selection.kind === 'Field') {
+            const field = selection;
+            const fieldName = (field.alias ?? field.name).value;
+            const schemaFieldName = field.name.value;
+            // Get field type from schema if available
+            const schemaField = parentType?.getFields()[schemaFieldName];
+            const fieldType = schemaField?.type;
+            if (field.selectionSet) {
+                // Nested object or array of objects
+                let nestedType;
+                if (fieldType) {
+                    // Get the named type (unwrap NonNull and List)
+                    const namedType = (0, graphql_1.getNamedType)(fieldType);
+                    if ((0, graphql_1.isObjectType)(namedType)) {
+                        nestedType = namedType;
+                    }
+                }
+                const nestedShape = selectionSetToShape(field.selectionSet, nestedType);
+                if (fieldType && isArrayType(fieldType)) {
+                    // Field returns an array
+                    properties.set(fieldName, { kind: 'array', itemShape: nestedShape });
+                }
+                else {
+                    properties.set(fieldName, nestedShape);
+                }
+            }
+            else {
+                // Leaf field
+                if (fieldType && isArrayType(fieldType)) {
+                    properties.set(fieldName, { kind: 'array', itemShape: { kind: 'primitive' } });
+                }
+                else {
+                    properties.set(fieldName, { kind: 'primitive' });
+                }
+            }
+        }
+        // FragmentSpread and InlineFragment could be handled for more complete support
+    }
+    return { kind: 'object', properties };
+}
+/**
+ * Extract response shape from GraphQL document content
+ * @param content - The GraphQL query/mutation content
+ * @param schemaString - Optional GraphQL schema SDL string for accurate type inference
+ */
+function inferShapeFromGraphQL(content, schemaString) {
+    try {
+        const document = (0, language_1.parse)(content);
+        let schema;
+        let rootType;
+        if (schemaString) {
+            try {
+                schema = (0, graphql_1.buildSchema)(schemaString);
+            }
+            catch {
+                // Schema parse error - continue without schema
+            }
+        }
+        for (const definition of document.definitions) {
+            if (definition.kind === 'OperationDefinition' && definition.selectionSet) {
+                // Get the root type based on operation type
+                if (schema) {
+                    if (definition.operation === 'query') {
+                        rootType = schema.getQueryType() ?? undefined;
+                    }
+                    else if (definition.operation === 'mutation') {
+                        rootType = schema.getMutationType() ?? undefined;
+                    }
+                }
+                return selectionSetToShape(definition.selectionSet, rootType);
+            }
+        }
+        return undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Look up a property path in a shape, returning the shape at that path.
+ * Returns undefined shape with error info if the path doesn't exist or passes through a primitive.
+ */
+function lookupPropertyPath(shape, path) {
+    let current = shape;
+    for (let i = 0; i < path.length; i++) {
+        const key = path[i];
+        if (current.kind === 'primitive') {
+            return { shape: undefined, error: 'primitive_access', errorAt: i };
+        }
+        if (current.kind === 'array') {
+            // Array access: check for built-in properties or index access
+            if (key === 'first' || key === 'last') {
+                if (!current.itemShape) {
+                    return { shape: undefined, error: 'unknown_property', errorAt: i };
+                }
+                current = current.itemShape;
+                continue;
+            }
+            if (key === 'size') {
+                current = { kind: 'primitive', primitiveType: 'number' };
+                continue;
+            }
+            // Numeric index access returns item shape
+            if (/^\d+$/.test(key)) {
+                if (!current.itemShape) {
+                    return { shape: undefined, error: 'unknown_property', errorAt: i };
+                }
+                current = current.itemShape;
+                continue;
+            }
+            // Unknown array property
+            return { shape: undefined, error: 'unknown_property', errorAt: i };
+        }
+        if (current.kind === 'object') {
+            const prop = current.properties?.get(key);
+            if (prop) {
+                current = prop;
+                continue;
+            }
+            return { shape: undefined, error: 'unknown_property', errorAt: i };
+        }
+    }
+    return { shape: current };
+}
+/**
+ * Get available properties at a given shape (for autocomplete)
+ */
+function getAvailableProperties(shape) {
+    if (shape.kind === 'object' && shape.properties) {
+        return Array.from(shape.properties.keys());
+    }
+    if (shape.kind === 'array') {
+        return ['first', 'last', 'size'];
+    }
+    if (shape.kind === 'primitive' && shape.primitiveType === 'string') {
+        return ['size'];
+    }
+    return [];
+}
+/**
+ * Merge a new property into an existing shape (for hash_assign tracking)
+ */
+function mergePropertyIntoShape(shape, key, valueShape) {
+    if (shape.kind !== 'object') {
+        // Convert to object
+        const properties = new Map();
+        properties.set(key, valueShape);
+        return { kind: 'object', properties };
+    }
+    const newProperties = new Map(shape.properties);
+    newProperties.set(key, valueShape);
+    return { kind: 'object', properties: newProperties };
+}
+//# sourceMappingURL=property-shape.js.map

package/dist/checks/unknown-property/property-shape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-shape.js","sourceRoot":"","sources":["../../../src/checks/unknown-property/property-shape.ts"],"names":[],"mappings":";;AA+DA,gDA8BC;AAKD,4DAYC;AA+ED,sDAoCC;AAMD,gDA+CC;AAKD,wDAWC;AAKD,wDAeC;AA1TD,+CAAsE;AACtE,qCASiB;AACjB,qCAAuC;AACvC,uCAAsC;AAkBtC;;GAEG;AACH,SAAS,WAAW,CAAC,CAAgB,EAAE,CAAgB;IACrD,oCAAoC;IACpC,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;YACjB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;gBACtC,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,QAAQ,EAAE,CAAC;oBACb,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;gBAClD,CAAC;qBAAM,CAAC;oBACN,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC7C,MAAM,SAAS,GACb,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,SAAS;YACxB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,SAAS,CAAC;QACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IACtC,CAAC;IACD,mDAAmD;IACnD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;IACtD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;IACxD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;IACxD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;IACzD,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,uCAAuC;QACvC,IAAI,SAAoC,CAAC;QACzC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACvC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAChE,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IACtC,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,UAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;QACpD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACxC,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,SAAgB,wBAAwB,CAAC,UAAkB;IACzD,MAAM,MAAM,GAAG,IAAA,gBAAS,EAAC,UAAU,CAAC,CAAC;IACrC,gFAAgF;IAChF,6DAA6D;IAC7D,IAAI,IAAA,eAAO,EAAC,MAAM,CAAC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC/D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,sEAAsE;IACtE,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,IAAuB;IACzC,IAAI,IAAA,uBAAa,EAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAuB;IAC1C,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,IAAA,oBAAU,EAAC,SAAS,CAAC,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAC1B,YAA8B,EAC9B,UAA8B;IAE9B,MAAM,UAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;IAEpD,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QAChD,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,SAAsB,CAAC;YACrC,MAAM,SAAS,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;YACpD,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YAEzC,0CAA0C;YAC1C,MAAM,WAAW,GAAG,UAAU,EAAE,SAAS,EAAE,CAAC,eAAe,CAAC,CAAC;YAC7D,MAAM,SAAS,GAAG,WAAW,EAAE,IAAI,CAAC;YAEpC,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;gBACvB,oCAAoC;gBACpC,IAAI,UAAyC,CAAC;gBAE9C,IAAI,SAAS,EAAE,CAAC;oBACd,+CAA+C;oBAC/C,MAAM,SAAS,GAAG,IAAA,sBAAY,EAAC,SAAS,CAAC,CAAC;oBAC1C,IAAI,IAAA,sBAAY,EAAC,SAAS,CAAC,EAAE,CAAC;wBAC5B,UAAU,GAAG,SAAS,CAAC;oBACzB,CAAC;gBACH,CAAC;gBAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;gBAExE,IAAI,SAAS,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;oBACxC,yBAAyB;oBACzB,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;gBACvE,CAAC;qBAAM,CAAC;oBACN,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,aAAa;gBACb,IAAI,SAAS,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;oBACxC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;gBACjF,CAAC;qBAAM,CAAC;oBACN,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;QACD,+EAA+E;IACjF,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CACnC,OAAe,EACf,YAAqB;IAErB,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAA,gBAAK,EAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,MAAiC,CAAC;QACtC,IAAI,QAAuC,CAAC;QAE5C,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC;gBACH,MAAM,GAAG,IAAA,qBAAW,EAAC,YAAY,CAAC,CAAC;YACrC,CAAC;YAAC,MAAM,CAAC;gBACP,+CAA+C;YACjD,CAAC;QACH,CAAC;QAED,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC9C,IAAI,UAAU,CAAC,IAAI,KAAK,qBAAqB,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;gBACzE,4CAA4C;gBAC5C,IAAI,MAAM,EAAE,CAAC;oBACX,IAAI,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;wBACrC,QAAQ,GAAG,MAAM,CAAC,YAAY,EAAE,IAAI,SAAS,CAAC;oBAChD,CAAC;yBAAM,IAAI,UAAU,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;wBAC/C,QAAQ,GAAG,MAAM,CAAC,eAAe,EAAE,IAAI,SAAS,CAAC;oBACnD,CAAC;gBACH,CAAC;gBAED,OAAO,mBAAmB,CAAC,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,KAAoB,EAAE,IAAc;IACrE,IAAI,OAAO,GAAkB,KAAK,CAAC;IAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QACrE,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC7B,8DAA8D;YAC9D,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;gBACtC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBACvB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;gBACrE,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;gBAC5B,SAAS;YACX,CAAC;YACD,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;gBACnB,OAAO,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;gBACzD,SAAS;YACX,CAAC;YACD,0CAA0C;YAC1C,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBACvB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;gBACrE,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;gBAC5B,SAAS;YACX,CAAC;YACD,yBAAyB;YACzB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QACrE,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,GAAG,IAAI,CAAC;gBACf,SAAS;YACX,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QACrE,CAAC;IACH,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,KAAoB;IACzD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;QACnE,OAAO,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CACpC,KAAoB,EACpB,GAAW,EACX,UAAyB;IAEzB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,oBAAoB;QACpB,MAAM,UAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;QACpD,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAChC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACxC,CAAC;IAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAChD,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACnC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;AACvD,CAAC"}

package/dist/checks/unrecognized-content-for-arguments/index.d.ts

@@ -0,0 +1,2 @@
+import { LiquidCheckDefinition } from '../../types';
+export declare const UnrecognizedContentForArguments: LiquidCheckDefinition;

package/dist/checks/unrecognized-content-for-arguments/index.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnrecognizedContentForArguments = void 0;
+const types_1 = require("../../types");
+const arguments_1 = require("../../liquid-doc/arguments");
+const content_for_1 = require("../../tags/content-for");
+exports.UnrecognizedContentForArguments = {
+    meta: {
+        code: 'UnrecognizedContentForArguments',
+        name: 'Unrecognized ContentFor Arguments',
+        docs: {
+            description: 'This check ensures that no unknown arguments are used when rendering a static block.',
+            recommended: true,
+            url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unrecognized-content-for-arguments',
+        },
+        type: types_1.SourceCodeType.LiquidHtml,
+        severity: types_1.Severity.WARNING,
+        schema: {},
+        targets: [],
+    },
+    create(context) {
+        const DEFAULT_CONTENT_FOR_ARGS = new Set([
+            ...content_for_1.RESERVED_CONTENT_FOR_ARGUMENTS,
+            ...content_for_1.REQUIRED_CONTENT_FOR_ARGUMENTS,
+        ]);
+        return {
+            async ContentForMarkup(node) {
+                const blockName = (0, arguments_1.getBlockName)(node);
+                if (!blockName)
+                    return;
+                const liquidDocParameters = await (0, arguments_1.getLiquidDocParams)(context, `blocks/${blockName}.liquid`);
+                if (!liquidDocParameters)
+                    return;
+                const unknownProvidedParams = node.args
+                    .filter((p) => !liquidDocParameters.has(p.name))
+                    .filter((p) => !DEFAULT_CONTENT_FOR_ARGS.has(p.name))
+                    .filter((p) => !p.name.startsWith(content_for_1.CLOSEST_ARGUMENT));
+                (0, arguments_1.reportUnknownArguments)(context, node, unknownProvidedParams, blockName);
+            },
+        };
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/checks/unrecognized-content-for-arguments/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/unrecognized-content-for-arguments/index.ts"],"names":[],"mappings":";;;AAAA,uCAA8E;AAE9E,0DAIoC;AACpC,wDAIgC;AAEnB,QAAA,+BAA+B,GAA0B;IACpE,IAAI,EAAE;QACJ,IAAI,EAAE,iCAAiC;QACvC,IAAI,EAAE,mCAAmC;QACzC,IAAI,EAAE;YACJ,WAAW,EACT,sFAAsF;YACxF,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,yGAAyG;SAC/G;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,OAAO;QAC1B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ;IAED,MAAM,CAAC,OAAO;QACZ,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC;YACvC,GAAG,4CAA8B;YACjC,GAAG,4CAA8B;SAClC,CAAC,CAAC;QAEH,OAAO;YACL,KAAK,CAAC,gBAAgB,CAAC,IAAsB;gBAC3C,MAAM,SAAS,GAAG,IAAA,wBAAY,EAAC,IAAI,CAAC,CAAC;gBAErC,IAAI,CAAC,SAAS;oBAAE,OAAO;gBAEvB,MAAM,mBAAmB,GAAG,MAAM,IAAA,8BAAkB,EAAC,OAAO,EAAE,UAAU,SAAS,SAAS,CAAC,CAAC;gBAE5F,IAAI,CAAC,mBAAmB;oBAAE,OAAO;gBAEjC,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI;qBACpC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;qBAC/C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;qBACpD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,8BAAgB,CAAC,CAAC,CAAC;gBAEvD,IAAA,kCAAsB,EAAC,OAAO,EAAE,IAAI,EAAE,qBAAqB,EAAE,SAAS,CAAC,CAAC;YAC1E,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/checks/unrecognized-render-partial-arguments/index.d.ts

@@ -0,0 +1,2 @@
+import { LiquidCheckDefinition } from '../../types';
+export declare const UnrecognizedRenderPartialArguments: LiquidCheckDefinition;

package/dist/checks/unrecognized-render-partial-arguments/index.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnrecognizedRenderPartialArguments = void 0;
+const types_1 = require("../../types");
+const arguments_1 = require("../../liquid-doc/arguments");
+exports.UnrecognizedRenderPartialArguments = {
+    meta: {
+        code: 'UnrecognizedRenderPartialArguments',
+        name: 'Unrecognized Render Partial Arguments',
+        aliases: ['UnrecognizedRenderPartialParams'],
+        docs: {
+            description: 'This check ensures that no unknown arguments are used when rendering a partial.',
+            recommended: true,
+            url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unrecognized-render-partial-arguments',
+        },
+        type: types_1.SourceCodeType.LiquidHtml,
+        severity: types_1.Severity.WARNING,
+        schema: {},
+        targets: [],
+    },
+    create(context) {
+        function reportUnknownAliases(node, liquidDocParameters, partialName) {
+            const alias = node.alias;
+            const variable = node.variable;
+            if (alias && !liquidDocParameters.has(alias.value) && variable) {
+                const startIndex = variable.position.start + 1;
+                context.report({
+                    message: `Unknown argument '${alias.value}' in render tag for partial '${partialName}'.`,
+                    startIndex: startIndex,
+                    endIndex: alias.position.end,
+                    suggest: [
+                        {
+                            message: `Remove '${alias.value}'`,
+                            fix: (fixer) => {
+                                if (variable) {
+                                    return fixer.remove(variable.position.start, alias.position.end);
+                                }
+                            },
+                        },
+                    ],
+                });
+            }
+        }
+        return {
+            async RenderMarkup(node) {
+                const partialName = (0, arguments_1.getPartialName)(node);
+                if (!partialName)
+                    return;
+                const liquidDocParameters = await (0, arguments_1.getLiquidDocParams)(context, `app/views/partials/${partialName}.liquid`);
+                if (!liquidDocParameters)
+                    return;
+                const unknownProvidedParams = node.args.filter((p) => !liquidDocParameters.has(p.name));
+                reportUnknownAliases(node, liquidDocParameters, partialName);
+                (0, arguments_1.reportUnknownArguments)(context, node, unknownProvidedParams, partialName);
+            },
+        };
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/checks/unrecognized-render-partial-arguments/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/unrecognized-render-partial-arguments/index.ts"],"names":[],"mappings":";;;AAAA,uCAA8E;AAG9E,0DAIoC;AAEvB,QAAA,kCAAkC,GAA0B;IACvE,IAAI,EAAE;QACJ,IAAI,EAAE,oCAAoC;QAC1C,IAAI,EAAE,uCAAuC;QAC7C,OAAO,EAAE,CAAC,iCAAiC,CAAC;QAC5C,IAAI,EAAE;YACJ,WAAW,EACT,iFAAiF;YACnF,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,4GAA4G;SAClH;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,OAAO;QAC1B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ;IAED,MAAM,CAAC,OAAO;QACZ,SAAS,oBAAoB,CAC3B,IAAkB,EAClB,mBAAoD,EACpD,WAAmB;YAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAE/B,IAAI,KAAK,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;gBAC/D,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC;gBAE/C,OAAO,CAAC,MAAM,CAAC;oBACb,OAAO,EAAE,qBAAqB,KAAK,CAAC,KAAK,gCAAgC,WAAW,IAAI;oBACxF,UAAU,EAAE,UAAU;oBACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG;oBAC5B,OAAO,EAAE;wBACP;4BACE,OAAO,EAAE,WAAW,KAAK,CAAC,KAAK,GAAG;4BAClC,GAAG,EAAE,CAAC,KAAU,EAAE,EAAE;gCAClB,IAAI,QAAQ,EAAE,CAAC;oCACb,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gCACnE,CAAC;4BACH,CAAC;yBACF;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO;YACL,KAAK,CAAC,YAAY,CAAC,IAAkB;gBACnC,MAAM,WAAW,GAAG,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAC;gBAEzC,IAAI,CAAC,WAAW;oBAAE,OAAO;gBAEzB,MAAM,mBAAmB,GAAG,MAAM,IAAA,8BAAkB,EAClD,OAAO,EACP,sBAAsB,WAAW,SAAS,CAC3C,CAAC;gBAEF,IAAI,CAAC,mBAAmB;oBAAE,OAAO;gBAEjC,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBACxF,oBAAoB,CAAC,IAAI,EAAE,mBAAmB,EAAE,WAAW,CAAC,CAAC;gBAC7D,IAAA,kCAAsB,EAAC,OAAO,EAAE,IAAI,EAAE,qBAAqB,EAAE,WAAW,CAAC,CAAC;YAC5E,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/checks/unused-assign/index.d.ts

@@ -0,0 +1,2 @@
+import { LiquidCheckDefinition } from '../../types';
+export declare const UnusedAssign: LiquidCheckDefinition;

package/dist/checks/unused-assign/index.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnusedAssign = void 0;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+const types_1 = require("../../types");
+const utils_1 = require("../utils");
+exports.UnusedAssign = {
+    meta: {
+        code: 'UnusedAssign',
+        name: 'Prevent unused assigns',
+        docs: {
+            description: 'This check exists to prevent bloat in themes by surfacing variable definitions that are not used.',
+            recommended: true,
+            url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unused-assign',
+        },
+        type: types_1.SourceCodeType.LiquidHtml,
+        severity: types_1.Severity.WARNING,
+        schema: {},
+        targets: [],
+    },
+    create(context) {
+        const assignedVariables = new Map();
+        const usedVariables = new Set();
+        function checkVariableUsage(node) {
+            if (node.type === liquid_html_parser_1.NodeTypes.VariableLookup) {
+                usedVariables.add(node.name);
+            }
+        }
+        return {
+            async LiquidTag(node, ancestors) {
+                if ((0, utils_1.isWithinRawTagThatDoesNotParseItsContents)(ancestors))
+                    return;
+                if (isLiquidTagAssign(node)) {
+                    assignedVariables.set(node.markup.name, node);
+                }
+                else if (isLiquidTagCapture(node) && node.markup.name) {
+                    assignedVariables.set(node.markup.name, node);
+                }
+            },
+            async VariableLookup(node, ancestors) {
+                if ((0, utils_1.isWithinRawTagThatDoesNotParseItsContents)(ancestors))
+                    return;
+                const parentNode = ancestors.at(-1);
+                if (parentNode && isLiquidTagCapture(parentNode)) {
+                    return;
+                }
+                checkVariableUsage(node);
+            },
+            async onCodePathEnd() {
+                for (const [variable, node] of assignedVariables.entries()) {
+                    if (!usedVariables.has(variable) && !variable.startsWith('_')) {
+                        context.report({
+                            message: `The variable '${variable}' is assigned but not used`,
+                            startIndex: isLiquidTagCapture(node)
+                                ? node.blockStartPosition.start
+                                : node.position.start,
+                            endIndex: isLiquidTagCapture(node) ? node.blockStartPosition.end : node.position.end,
+                            suggest: [
+                                {
+                                    message: `Remove the unused variable '${variable}'`,
+                                    fix: (corrector) => corrector.remove(node.position.start, node.position.end),
+                                },
+                            ],
+                        });
+                    }
+                }
+            },
+        };
+    },
+};
+function isLiquidTagAssign(node) {
+    return node.name === 'assign' && typeof node.markup !== 'string';
+}
+function isLiquidTagCapture(node) {
+    return (node.type == liquid_html_parser_1.NodeTypes.LiquidTag && node.name === 'capture' && typeof node.markup !== 'string');
+}
+//# sourceMappingURL=index.js.map

package/dist/checks/unused-assign/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/unused-assign/index.ts"],"names":[],"mappings":";;;AAAA,uEAMwC;AACxC,uCAA8E;AAC9E,oCAAqE;AAExD,QAAA,YAAY,GAA0B;IACjD,IAAI,EAAE;QACJ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE;YACJ,WAAW,EACT,mGAAmG;YACrG,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,oFAAoF;SAC1F;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,OAAO;QAC1B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ;IAED,MAAM,CAAC,OAAO;QACZ,MAAM,iBAAiB,GAAoD,IAAI,GAAG,EAAE,CAAC;QACrF,MAAM,aAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;QAE7C,SAAS,kBAAkB,CAAC,IAAS;YACnC,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;gBAC3C,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QAED,OAAO;YACL,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS;gBAC7B,IAAI,IAAA,iDAAyC,EAAC,SAAS,CAAC;oBAAE,OAAO;gBACjE,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,CAAC;qBAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBACxD,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,CAAC;YACH,CAAC;YAED,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS;gBAClC,IAAI,IAAA,iDAAyC,EAAC,SAAS,CAAC;oBAAE,OAAO;gBACjE,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpC,IAAI,UAAU,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;oBACjD,OAAO;gBACT,CAAC;gBACD,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;YAED,KAAK,CAAC,aAAa;gBACjB,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC3D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;wBAC9D,OAAO,CAAC,MAAM,CAAC;4BACb,OAAO,EAAE,iBAAiB,QAAQ,4BAA4B;4BAC9D,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC;gCAClC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK;gCAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK;4BACvB,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG;4BACpF,OAAO,EAAE;gCACP;oCACE,OAAO,EAAE,+BAA+B,QAAQ,GAAG;oCACnD,GAAG,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;iCAC7E;6BACF;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,SAAS,iBAAiB,CAAC,IAAe;IACxC,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;AACnE,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAoB;IAC9C,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"}

package/dist/checks/unused-doc-param/index.d.ts

@@ -0,0 +1,2 @@
+import { LiquidCheckDefinition } from '../../types';
+export declare const UnusedDocParam: LiquidCheckDefinition;

package/dist/checks/unused-doc-param/index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnusedDocParam = void 0;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+const types_1 = require("../../types");
+const utils_1 = require("../utils");
+exports.UnusedDocParam = {
+    meta: {
+        code: 'UnusedDocParam',
+        name: 'Prevent unused doc parameters',
+        docs: {
+            description: 'This check exists to ensure any parameters defined in the `doc` tag are used within the partial.',
+            recommended: true,
+            url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unused-doc-param',
+        },
+        type: types_1.SourceCodeType.LiquidHtml,
+        severity: types_1.Severity.WARNING,
+        schema: {},
+        targets: [],
+    },
+    create(context) {
+        const definedLiquidDocParams = new Map();
+        const usedVariables = new Set();
+        return {
+            async LiquidDocParamNode(node) {
+                definedLiquidDocParams.set(node.paramName.value, node);
+            },
+            async VariableLookup(node, ancestors) {
+                if (node.type === liquid_html_parser_1.NodeTypes.VariableLookup &&
+                    node.name &&
+                    !(0, utils_1.isLoopScopedVariable)(node.name, ancestors)) {
+                    usedVariables.add(node.name);
+                }
+            },
+            async onCodePathEnd() {
+                for (const [variable, node] of definedLiquidDocParams.entries()) {
+                    if (!usedVariables.has(variable)) {
+                        context.report({
+                            message: `The parameter '${variable}' is defined but not used in this file.`,
+                            startIndex: node.position.start,
+                            endIndex: node.position.end,
+                            suggest: [
+                                {
+                                    message: `Remove unused parameter '${variable}'`,
+                                    fix: (corrector) => corrector.remove(node.position.start, node.position.end),
+                                },
+                            ],
+                        });
+                    }
+                }
+            },
+        };
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/checks/unused-doc-param/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/unused-doc-param/index.ts"],"names":[],"mappings":";;;AAAA,uEAA+E;AAC/E,uCAA8E;AAC9E,oCAAgD;AAEnC,QAAA,cAAc,GAA0B;IACnD,IAAI,EAAE;QACJ,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,+BAA+B;QACrC,IAAI,EAAE;YACJ,WAAW,EACT,kGAAkG;YACpG,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,uFAAuF;SAC7F;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,OAAO;QAC1B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ;IAED,MAAM,CAAC,OAAO;QACZ,MAAM,sBAAsB,GAAoC,IAAI,GAAG,EAAE,CAAC;QAC1E,MAAM,aAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;QAE7C,OAAO;YACL,KAAK,CAAC,kBAAkB,CAAC,IAAI;gBAC3B,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACzD,CAAC;YAED,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS;gBAClC,IACE,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc;oBACtC,IAAI,CAAC,IAAI;oBACT,CAAC,IAAA,4BAAoB,EAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAC3C,CAAC;oBACD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;YAED,KAAK,CAAC,aAAa;gBACjB,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;oBAChE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACjC,OAAO,CAAC,MAAM,CAAC;4BACb,OAAO,EAAE,kBAAkB,QAAQ,yCAAyC;4BAC5E,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;4BAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG;4BAC3B,OAAO,EAAE;gCACP;oCACE,OAAO,EAAE,4BAA4B,QAAQ,GAAG;oCAChD,GAAG,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;iCAC7E;6BACF;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/checks/utils.d.ts

@@ -0,0 +1,22 @@
+import { Position, NodeTypes, HtmlElement, AttrEmpty, AttrSingleQuoted, AttrDoubleQuoted, AttrUnquoted, LiquidHtmlNode, LiquidBranch, LiquidTagFor, LiquidTagTablerow, LiquidTag } from '@platformos/liquid-html-parser';
+import { LiquidHtmlNodeOfType as NodeOfType } from '../types';
+type ElementType<T> = T extends (infer E)[] ? E : never;
+export type ValuedHtmlAttribute = AttrSingleQuoted | AttrDoubleQuoted | AttrUnquoted;
+export declare function isNodeOfType<T extends NodeTypes>(type: T, node?: LiquidHtmlNode): node is NodeOfType<T>;
+export declare function isLiquidBranch(node: LiquidHtmlNode): node is LiquidBranch;
+export declare function isHtmlTag<T>(node: HtmlElement, name: T): node is HtmlElement & {
+    name: [{
+        name: T;
+    }];
+    blockEndPosition: Position;
+};
+export declare function isAttr(attr: ValuedHtmlAttribute | AttrEmpty, name: string): boolean;
+export declare function isHtmlAttribute(attr: ElementType<HtmlElement['attributes']>): attr is ValuedHtmlAttribute | AttrEmpty;
+export declare function isValuedHtmlAttribute(attr: ElementType<HtmlElement['attributes']>): attr is ValuedHtmlAttribute;
+export declare function valueIncludes(attr: ValuedHtmlAttribute, word: string): boolean;
+export declare function hasAttributeValueOf(attr: ValuedHtmlAttribute, value: string): boolean;
+export declare function isLiquidString(node: LiquidHtmlNode): node is NodeOfType<NodeTypes.String>;
+export declare function isLoopScopedVariable(variableName: string, ancestors: LiquidHtmlNode[]): boolean;
+export declare function isLoopLiquidTag(tag: LiquidTag): tag is LiquidTagFor | LiquidTagTablerow;
+export declare function isWithinRawTagThatDoesNotParseItsContents(ancestors: LiquidHtmlNode[]): boolean;
+export {};

package/dist/checks/utils.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNodeOfType = isNodeOfType;
+exports.isLiquidBranch = isLiquidBranch;
+exports.isHtmlTag = isHtmlTag;
+exports.isAttr = isAttr;
+exports.isHtmlAttribute = isHtmlAttribute;
+exports.isValuedHtmlAttribute = isValuedHtmlAttribute;
+exports.valueIncludes = valueIncludes;
+exports.hasAttributeValueOf = hasAttributeValueOf;
+exports.isLiquidString = isLiquidString;
+exports.isLoopScopedVariable = isLoopScopedVariable;
+exports.isLoopLiquidTag = isLoopLiquidTag;
+exports.isWithinRawTagThatDoesNotParseItsContents = isWithinRawTagThatDoesNotParseItsContents;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+function isNodeOfType(type, node) {
+    return node?.type === type;
+}
+function isLiquidBranch(node) {
+    return isNodeOfType(liquid_html_parser_1.NodeTypes.LiquidBranch, node);
+}
+function isHtmlTag(node, name) {
+    return (node.name.length === 1 &&
+        node.name[0].type === liquid_html_parser_1.NodeTypes.TextNode &&
+        node.name[0].value === name &&
+        !!node.blockEndPosition);
+}
+function isAttr(attr, name) {
+    return (attr.name.length === 1 &&
+        isNodeOfType(liquid_html_parser_1.NodeTypes.TextNode, attr.name[0]) &&
+        attr.name[0].value === name);
+}
+function isHtmlAttribute(attr) {
+    return [
+        liquid_html_parser_1.NodeTypes.AttrUnquoted,
+        liquid_html_parser_1.NodeTypes.AttrDoubleQuoted,
+        liquid_html_parser_1.NodeTypes.AttrSingleQuoted,
+        liquid_html_parser_1.NodeTypes.AttrEmpty,
+    ].some((type) => isNodeOfType(type, attr));
+}
+function isValuedHtmlAttribute(attr) {
+    return [liquid_html_parser_1.NodeTypes.AttrUnquoted, liquid_html_parser_1.NodeTypes.AttrDoubleQuoted, liquid_html_parser_1.NodeTypes.AttrSingleQuoted].some((type) => isNodeOfType(type, attr));
+}
+function valueIncludes(attr, word) {
+    const regex = new RegExp(`(^|\\s)${word}(\\s|$)`, 'g');
+    return attr.value
+        .filter((node) => isNodeOfType(liquid_html_parser_1.NodeTypes.TextNode, node))
+        .some((valueNode) => regex.test(valueNode.value));
+}
+function hasAttributeValueOf(attr, value) {
+    return (attr.value.length === 1 &&
+        isNodeOfType(liquid_html_parser_1.NodeTypes.TextNode, attr.value[0]) &&
+        attr.value[0].value === value);
+}
+function isLiquidString(node) {
+    return node.type === liquid_html_parser_1.NodeTypes.String;
+}
+function isLoopScopedVariable(variableName, ancestors) {
+    return ancestors.some((ancestor) => ancestor.type === liquid_html_parser_1.NodeTypes.LiquidTag &&
+        isLoopLiquidTag(ancestor) &&
+        typeof ancestor.markup !== 'string' &&
+        ancestor.markup.variableName === variableName);
+}
+function isLoopLiquidTag(tag) {
+    return liquid_html_parser_1.LoopNamedTags.includes(tag.name);
+}
+const RawTagsThatDoNotParseTheirContents = ['raw', 'stylesheet', 'javascript', 'schema'];
+function isRawTagThatDoesNotParseItsContent(node) {
+    return (node.type === liquid_html_parser_1.NodeTypes.LiquidRawTag && RawTagsThatDoNotParseTheirContents.includes(node.name));
+}
+function isWithinRawTagThatDoesNotParseItsContents(ancestors) {
+    return ancestors.some(isRawTagThatDoesNotParseItsContent);
+}
+//# sourceMappingURL=utils.js.map