Make Boolean types more permissive and remove default value for Object

Shopify · Feb 25, 2025 · f63933b · f63933b
1 parent a2686d6
commit f63933b
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 8 deletions.
diff --git a/packages/theme-check-common/src/checks/valid-render-snippet-param-types/index.spec.ts b/packages/theme-check-common/src/checks/valid-render-snippet-param-types/index.spec.ts
@@ -25,11 +25,8 @@ describe('Module: ValidRenderSnippetParamTypes', () => {
       },
       {
         type: 'boolean',
-        validValues: ['true', 'false', 'nil', 'empty', 'product'],
-        invalidValues: [
-          { value: "'hello'", actualType: SupportedParamTypes.String },
-          { value: '123', actualType: SupportedParamTypes.Number },
-        ],
+        validValues: ['true', 'false', 'nil', 'empty', 'product', '123', "'hello'"],
+        invalidValues: [],
       },
       {
         type: 'object',

diff --git a/packages/theme-check-common/src/checks/valid-render-snippet-param-types/index.ts b/packages/theme-check-common/src/checks/valid-render-snippet-param-types/index.ts
@@ -7,6 +7,7 @@ import {
   inferArgumentType,
   getDefaultValueForType,
   SupportedParamTypes,
+  isTypeCompatible,
 } from '../../liquid-doc/utils';
 
 export const ValidRenderSnippetParamTypes: LiquidCheckDefinition = {
@@ -46,7 +47,7 @@ export const ValidRenderSnippetParamTypes: LiquidCheckDefinition = {
             continue;
           }
 
-          if (inferArgumentType(arg) !== paramType) {
+          if (!isTypeCompatible(paramType, inferArgumentType(arg))) {
             typeMismatchParams.push(arg);
           }
         }

diff --git a/packages/theme-check-common/src/liquid-doc/utils.ts b/packages/theme-check-common/src/liquid-doc/utils.ts
@@ -25,8 +25,7 @@ export function getDefaultValueForType(type: string | null) {
       return '0';
     case SupportedParamTypes.Boolean:
       return 'false';
-    case SupportedParamTypes.Object:
-      return 'empty';
+    case SupportedParamTypes.Object: // Objects don't have a sensible default value (maybe `theme`?)
     default:
       return '';
   }
@@ -51,3 +50,18 @@ export function inferArgumentType(arg: LiquidNamedArgument): SupportedParamTypes
       return assertNever(arg.value);
   }
 }
+
+/**
+ * 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 function isTypeCompatible(expectedType: string, actualType: SupportedParamTypes): boolean {
+  const normalizedExpectedType = expectedType.toLowerCase();
+
+  if (normalizedExpectedType === SupportedParamTypes.Boolean) {
+    return true;
+  }
+
+  return normalizedExpectedType === actualType;
+}