@platformos/platformos-check-common 0.0.12 → 0.0.16

package/dist/liquid-doc/utils.d.ts

@@ -14,6 +14,9 @@ export declare enum BasicParamTypes {
     Boolean = "boolean",
     Object = "object"
 }
+/** Inferred type for null/nil literals — not a valid @param type, only used in type mismatch messages. */
+export declare const InferredNull: "null";
+export type InferredParamType = BasicParamTypes | typeof InferredNull;
 export declare enum SupportedDocTagTypes {
     Param = "param",
     Example = "example",
@@ -26,13 +29,18 @@ export declare function getDefaultValueForType(type: string | null): "" | "''" |
 /**
  * Casts the value of a LiquidNamedArgument to a string representing the type of the value.
  */
-export declare function inferArgumentType(arg: LiquidExpression | LiquidVariable): BasicParamTypes;
+export declare function inferArgumentType(arg: LiquidExpression | LiquidVariable): InferredParamType;
+/**
+ * Checks if a LiquidExpression is a null/nil literal.
+ * null/nil is compatible with any type — it represents "no value".
+ */
+export declare function isNullLiteral(arg: LiquidExpression | LiquidVariable): boolean;
 /**
  * Checks if the provided argument type is compatible with the expected type.
  * Makes certain types more permissive:
  * - Boolean accepts any value, since everything is truthy / falsy in Liquid
  */
-export declare function isTypeCompatible(expectedType: string, actualType: BasicParamTypes): boolean;
+export declare function isTypeCompatible(expectedType: string, actualType: InferredParamType): boolean;
 /**
  * Checks if the provided file path supports the LiquidDoc tag.
  */

package/dist/liquid-doc/utils.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SupportedDocTagTypes = exports.BasicParamTypes = void 0;
+exports.SupportedDocTagTypes = exports.InferredNull = exports.BasicParamTypes = void 0;
 exports.getDefaultValueForType = getDefaultValueForType;
 exports.inferArgumentType = inferArgumentType;
+exports.isNullLiteral = isNullLiteral;
 exports.isTypeCompatible = isTypeCompatible;
 exports.filePathSupportsLiquidDoc = filePathSupportsLiquidDoc;
 exports.getValidParamTypes = getValidParamTypes;
@@ -25,6 +26,8 @@ var BasicParamTypes;
     BasicParamTypes["Boolean"] = "boolean";
     BasicParamTypes["Object"] = "object";
 })(BasicParamTypes || (exports.BasicParamTypes = BasicParamTypes = {}));
+/** Inferred type for null/nil literals — not a valid @param type, only used in type mismatch messages. */
+exports.InferredNull = 'null';
 var SupportedDocTagTypes;
 (function (SupportedDocTagTypes) {
     SupportedDocTagTypes["Param"] = "param";
@@ -67,6 +70,10 @@ function inferArgumentType(arg) {
         case liquid_html_parser_1.NodeTypes.Number:
             return BasicParamTypes.Number;
         case liquid_html_parser_1.NodeTypes.LiquidLiteral:
+            if (arg.value === null)
+                return exports.InferredNull;
+            if (arg.value === '')
+                return BasicParamTypes.String;
             return BasicParamTypes.Boolean;
         case liquid_html_parser_1.NodeTypes.Range:
         case liquid_html_parser_1.NodeTypes.VariableLookup:
@@ -78,6 +85,24 @@ function inferArgumentType(arg) {
             return (0, utils_1.assertNever)(arg);
     }
 }
+/**
+ * Checks if a LiquidExpression is a null/nil literal.
+ * null/nil is compatible with any type — it represents "no value".
+ */
+function isNullLiteral(arg) {
+    if (arg.type === liquid_html_parser_1.NodeTypes.LiquidVariable) {
+        if (arg.filters.length > 0)
+            return false;
+        const expr = arg.expression;
+        if (expr.type === liquid_html_parser_1.NodeTypes.BooleanExpression)
+            return false;
+        return isNullLiteral(expr);
+    }
+    if (arg.type === liquid_html_parser_1.NodeTypes.LiquidLiteral) {
+        return arg.value === null;
+    }
+    return false;
+}
 /**
  * Checks if the provided argument type is compatible with the expected type.
  * Makes certain types more permissive:

package/dist/liquid-doc/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/liquid-doc/utils.ts"],"names":[],"mappings":";;;AA6BA,wDAYC;AAKD,8CAyBC;AAOD,4CAQC;AAKD,8DAEC;AAUD,gDAcC;AAED,wCAcC;AArID,uEAA6F;AAC7F,oCAAuC;AACvC,kCAAoC;AAGpC;;;;;;;GAOG;AACH,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;AACnB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAED,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,2CAAmB,CAAA;IACnB,mDAA2B,CAAA;AAC7B,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,IAAmB;IACxD,QAAQ,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;QAC5B,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,IAAI,CAAC;QACd,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,GAAG,CAAC;QACb,KAAK,eAAe,CAAC,OAAO;YAC1B,OAAO,OAAO,CAAC;QACjB,KAAK,eAAe,CAAC,MAAM,CAAC,CAAC,8CAA8C;QAC3E;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,GAAsC;IACtE,IAAI,GAAG,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAC1C,qFAAqF;QACrF,oEAAoE;QACpE,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,eAAe,CAAC,MAAM,CAAC;QAC1D,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,iBAAiB;YAAE,OAAO,eAAe,CAAC,MAAM,CAAC;QAC7E,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,8BAAS,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,8BAAS,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,8BAAS,CAAC,aAAa;YAC1B,OAAO,eAAe,CAAC,OAAO,CAAC;QACjC,KAAK,8BAAS,CAAC,KAAK,CAAC;QACrB,KAAK,8BAAS,CAAC,cAAc,CAAC;QAC9B,KAAK,8BAAS,CAAC,eAAe,CAAC;QAC/B,KAAK,8BAAS,CAAC,gBAAgB;YAC7B,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC;YACE,yEAAyE;YACzE,OAAO,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,YAAoB,EAAE,UAA2B;IAChF,MAAM,sBAAsB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;IAE1D,IAAI,sBAAsB,KAAK,eAAe,CAAC,OAAO,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,sBAAsB,KAAK,UAAU,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,GAAc;IACtD,OAAO,IAAA,gBAAS,EAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,aAA4B;IAC7D,MAAM,UAAU,GAAoC,IAAI,GAAG,CAAC;QAC1D,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;QACnC,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;QACnC,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC;QACpC;YACE,eAAe,CAAC,MAAM;YACtB,wEAAwE;SACzE;KACF,CAAC,CAAC;IAEH,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,cAAc,CAC5B,eAA4B,EAC5B,KAAa;IAEb,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEzD,IAAI,CAAC,cAAc;QAAE,OAAO,SAAS,CAAC;IAEtC,MAAM,kBAAkB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC;QAAE,OAAO,SAAS,CAAC;IAE/D,OAAO,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/liquid-doc/utils.ts"],"names":[],"mappings":";;;AAkCA,wDAYC;AAKD,8CA2BC;AAMD,sCAWC;AAOD,4CAQC;AAKD,8DAEC;AAUD,gDAcC;AAED,wCAcC;AA7JD,uEAA6F;AAC7F,oCAAuC;AACvC,kCAAoC;AAGpC;;;;;;;GAOG;AACH,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;AACnB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAED,0GAA0G;AAC7F,QAAA,YAAY,GAAG,MAAe,CAAC;AAI5C,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,2CAAmB,CAAA;IACnB,mDAA2B,CAAA;AAC7B,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,IAAmB;IACxD,QAAQ,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;QAC5B,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,IAAI,CAAC;QACd,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,GAAG,CAAC;QACb,KAAK,eAAe,CAAC,OAAO;YAC1B,OAAO,OAAO,CAAC;QACjB,KAAK,eAAe,CAAC,MAAM,CAAC,CAAC,8CAA8C;QAC3E;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,GAAsC;IACtE,IAAI,GAAG,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAC1C,qFAAqF;QACrF,oEAAoE;QACpE,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,eAAe,CAAC,MAAM,CAAC;QAC1D,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,iBAAiB;YAAE,OAAO,eAAe,CAAC,MAAM,CAAC;QAC7E,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,8BAAS,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,8BAAS,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,8BAAS,CAAC,aAAa;YAC1B,IAAI,GAAG,CAAC,KAAK,KAAK,IAAI;gBAAE,OAAO,oBAAY,CAAC;YAC5C,IAAI,GAAG,CAAC,KAAK,KAAK,EAAE;gBAAE,OAAO,eAAe,CAAC,MAAM,CAAC;YACpD,OAAO,eAAe,CAAC,OAAO,CAAC;QACjC,KAAK,8BAAS,CAAC,KAAK,CAAC;QACrB,KAAK,8BAAS,CAAC,cAAc,CAAC;QAC9B,KAAK,8BAAS,CAAC,eAAe,CAAC;QAC/B,KAAK,8BAAS,CAAC,gBAAgB;YAC7B,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC;YACE,yEAAyE;YACzE,OAAO,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,GAAsC;IAClE,IAAI,GAAG,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAC1C,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAC5D,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,8BAAS,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO,GAAG,CAAC,KAAK,KAAK,IAAI,CAAC;IAC5B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,YAAoB,EAAE,UAA6B;IAClF,MAAM,sBAAsB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;IAE1D,IAAI,sBAAsB,KAAK,eAAe,CAAC,OAAO,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,sBAAsB,KAAK,UAAU,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,GAAc;IACtD,OAAO,IAAA,gBAAS,EAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,aAA4B;IAC7D,MAAM,UAAU,GAAoC,IAAI,GAAG,CAAC;QAC1D,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;QACnC,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;QACnC,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC;QACpC;YACE,eAAe,CAAC,MAAM;YACtB,wEAAwE;SACzE;KACF,CAAC,CAAC;IAEH,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,cAAc,CAC5B,eAA4B,EAC5B,KAAa;IAEb,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEzD,IAAI,CAAC,cAAc;QAAE,OAAO,SAAS,CAAC;IAEtC,MAAM,kBAAkB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC;QAAE,OAAO,SAAS,CAAC;IAE/D,OAAO,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;AAC3C,CAAC"}

package/dist/to-source-code.d.ts

@@ -1,5 +1,5 @@
 import { GraphQLDocumentNode, GraphQLSourceCode, JSONNode, JSONSourceCode, LiquidSourceCode, YAMLSourceCode } from './types';
-export declare function toLiquidHTMLAST(source: string): import("@platformos/liquid-html-parser").DocumentNode | Error;
+export declare function toLiquidHTMLAST(source: string): Error | import("@platformos/liquid-html-parser").DocumentNode;
 export declare function toJSONAST(source: string): JSONNode | Error;
 export declare function toYAMLAST(source: string): JSONNode | Error;
 export declare function toGraphQLAST(source: string): GraphQLDocumentNode | Error;