@platformos/platformos-check-common 0.0.8 → 0.0.9

package/dist/types.d.ts

@@ -274,6 +274,14 @@ export interface AugmentedDependencies extends Dependencies {
     fileSize: (uri: UriString) => Promise<number>;
     getDefaultLocale: () => Promise<string>;
     getDefaultTranslations(): Promise<Translations>;
+    /**
+     * Aggregates ALL translation files for `locale` within the given translations
+     * base directory (e.g. `file:///app/translations` or
+     * `file:///modules/common-styling/public/translations`).
+     *
+     * Covers both `{base}/{locale}.yml` and `{base}/{locale}/*.yml`.
+     */
+    getTranslationsForBase(translationBaseUri: string, locale: string): Promise<Translations>;
 }
 type StaticContextProperties<T extends SourceCodeType> = T extends SourceCodeType ? {
     report(problem: Problem<T>): void;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uEAAkG;AAwEzE,oGAxEa,8BAAmB,OAwEb;AAnD5C,gDAA8B;AAC9B,8DAA4C;AAC5C,iEAA+C;AAExC,MAAM,YAAY,GAAG,CAAC,IAAc,EAAsB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC;AAA/E,QAAA,YAAY,gBAAmE;AACrF,MAAM,WAAW,GAAG,CAAC,IAAc,EAAqB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;AAA5E,QAAA,WAAW,eAAiE;AAClF,MAAM,cAAc,GAAG,CAAC,IAAc,EAAwB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,UAAU,CAAC;AAArF,QAAA,cAAc,kBAAuE;AAC3F,MAAM,WAAW,GAAG,CAAC,IAAc,EAAqB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;AAA5E,QAAA,WAAW,eAAiE;AAClF,MAAM,aAAa,GAAG,CAAC,IAAc,EAAuB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC;AAAlF,QAAA,aAAa,iBAAqE;AAkB/F,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,2CAAyB,CAAA;IACzB,qCAAmB,CAAA;IACnB,+BAAa,CAAA;AACf,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAkeD,gEAAgE;AAChE,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,yCAAS,CAAA;IACT,6CAAW,CAAA;IACX,uCAAQ,CAAA;AACV,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,+CAA+C;AAC/C,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,2CAA2B,CAAA;AAC7B,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uEAAkG;AAwEzE,oGAxEa,8BAAmB,OAwEb;AAnD5C,gDAA8B;AAC9B,8DAA4C;AAC5C,iEAA+C;AAExC,MAAM,YAAY,GAAG,CAAC,IAAc,EAAsB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC;AAA/E,QAAA,YAAY,gBAAmE;AACrF,MAAM,WAAW,GAAG,CAAC,IAAc,EAAqB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;AAA5E,QAAA,WAAW,eAAiE;AAClF,MAAM,cAAc,GAAG,CAAC,IAAc,EAAwB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,UAAU,CAAC;AAArF,QAAA,cAAc,kBAAuE;AAC3F,MAAM,WAAW,GAAG,CAAC,IAAc,EAAqB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;AAA5E,QAAA,WAAW,eAAiE;AAClF,MAAM,aAAa,GAAG,CAAC,IAAc,EAAuB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC;AAAlF,QAAA,aAAa,iBAAqE;AAkB/F,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,2CAAyB,CAAA;IACzB,qCAAmB,CAAA;IACnB,+BAAa,CAAA;AACf,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AA0eD,gEAAgE;AAChE,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,yCAAS,CAAA;IACT,6CAAW,CAAA;IACX,uCAAQ,CAAA;AACV,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,+CAA+C;AAC/C,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,2CAA2B,CAAA;AAC7B,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformos/platformos-check-common",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
     "type-check": "tsc --noEmit"
   },
   "dependencies": {
-    "@platformos/liquid-html-parser": "0.0.8",
+    "@platformos/liquid-html-parser": "0.0.9",
     "graphql": "^16.12.0",
     "js-yaml": "^4.1.1",
     "jsonc-parser": "^3.3.1",

package/src/checks/duplicate-render-partial-arguments/index.spec.ts

@@ -10,7 +10,7 @@ describe('Module: DuplicateRenderPartialArguments', () => {
   describe('detection', () => {
     it('should report duplicate arguments in render tags', async () => {
       const sourceCode = `
-        {% render 'snippet', param1: 'value1', param2: 'value2', param1: 'value3' %}
+        {% render 'partial', param1: 'value1', param2: 'value2', param1: 'value3' %}
       `;
 
       const offenses = await runCheck(sourceCode);
@@ -24,7 +24,7 @@ describe('Module: DuplicateRenderPartialArguments', () => {
 
     it('should report multiple duplicate arguments in render tags', async () => {
       const sourceCode = `
-        {% render 'snippet', param1: 'value1', param2: 'value2', param1: 'value3', param2: 'value4', param1: 'value5' %}
+        {% render 'partial', param1: 'value1', param2: 'value2', param1: 'value3', param2: 'value4', param1: 'value5' %}
       `;
 
       const offenses = await runCheck(sourceCode);
@@ -40,7 +40,7 @@ describe('Module: DuplicateRenderPartialArguments', () => {
 
     it('should not report when render tag is using `with/for` alias syntax', async () => {
       const sourceCode = `
-        {% render 'snippet' with 'string' as param1, param1: 'value1' %}
+        {% render 'partial' with 'string' as param1, param1: 'value1' %}
       `;
 
       const offenses = await runCheck(sourceCode);
@@ -52,7 +52,7 @@ describe('Module: DuplicateRenderPartialArguments', () => {
 
   describe('suggestions', () => {
     it('should correctly suggest fixing all duplicate arguments except for the first', async () => {
-      const sourceCode = `{% render 'snippet', param1: 'value1', param2: 'value2', param1: 'value3', param1: 'value4' %}`;
+      const sourceCode = `{% render 'partial', param1: 'value1', param2: 'value2', param1: 'value3', param1: 'value4' %}`;
       const offenses = await runCheck(sourceCode);
 
       expect(offenses).toHaveLength(2);
@@ -60,18 +60,18 @@ describe('Module: DuplicateRenderPartialArguments', () => {
       expect(offenses[1].start.index).toBe(sourceCode.indexOf("param1: 'value4'"));
       const suggestionResult = applySuggestions(sourceCode, offenses[0]);
       expect(suggestionResult).toEqual([
-        `{% render 'snippet', param1: 'value1', param2: 'value2', param1: 'value4' %}`,
+        `{% render 'partial', param1: 'value1', param2: 'value2', param1: 'value4' %}`,
       ]);
     });
 
     it('should suggest removing duplicates when with / for alias is used', async () => {
-      const sourceCode = `{% render 'snippet' with 'string' as param2, param1: 'value1', param2: 'value2' %}`;
+      const sourceCode = `{% render 'partial' with 'string' as param2, param1: 'value1', param2: 'value2' %}`;
       const offenses = await runCheck(sourceCode);
 
       expect(offenses).toHaveLength(1);
       const suggestionResult = applySuggestions(sourceCode, offenses[0]);
       expect(suggestionResult).toEqual([
-        `{% render 'snippet' with 'string' as param2, param1: 'value1' %}`,
+        `{% render 'partial' with 'string' as param2, param1: 'value1' %}`,
       ]);
     });
   });
@@ -79,7 +79,7 @@ describe('Module: DuplicateRenderPartialArguments', () => {
   describe('edge cases', () => {
     it('should not report when there are no duplicate arguments', async () => {
       const sourceCode = `
-        {% render 'snippet', param1: 'value1', param2: 'value2', param3: 'value3' %}
+        {% render 'partial', param1: 'value1', param2: 'value2', param3: 'value3' %}
       `;
 
       const offenses = await runCheck(sourceCode);
@@ -99,8 +99,8 @@ describe('Module: DuplicateRenderPartialArguments', () => {
 
     it('should handle remove duplicate param when there are multiple render tags', async () => {
       const sourceCode = `
-        {% render 'snippet', param1: 'value1', param2: 'value2', param3: 'value3' %}
-        {% render 'snippet', param1: 'value4', param2: 'value5', param1: 'value6' %}
+        {% render 'partial', param1: 'value1', param2: 'value2', param3: 'value3' %}
+        {% render 'partial', param1: 'value4', param2: 'value5', param1: 'value6' %}
        `;
 
       const offenses = await runCheck(sourceCode);
@@ -111,8 +111,8 @@ describe('Module: DuplicateRenderPartialArguments', () => {
       const suggestionResult = applySuggestions(sourceCode, offenses[0]);
       expect(suggestionResult).toEqual([
         `
-        {% render 'snippet', param1: 'value1', param2: 'value2', param3: 'value3' %}
-        {% render 'snippet', param1: 'value4', param2: 'value5' %}
+        {% render 'partial', param1: 'value1', param2: 'value2', param3: 'value3' %}
+        {% render 'partial', param1: 'value4', param2: 'value5' %}
        `,
       ]);
     });

package/src/checks/graphql-variables/index.spec.ts

@@ -0,0 +1,95 @@
+import { expect, describe, it } from 'vitest';
+import { GraphQLVariablesCheck } from '.';
+import { check } from '../../test';
+
+const GRAPHQL_WITH_REQUIRED = `
+  query MyQuery($content: String!) {
+    records(filter: { table: { value: "posts" } }) {
+      results {
+        id
+      }
+    }
+  }
+`;
+
+const GRAPHQL_WITH_OPTIONAL = `
+  query MyQuery($content: String) {
+    records(filter: { table: { value: "posts" } }) {
+      results {
+        id
+      }
+    }
+  }
+`;
+
+describe('Module: GraphQLVariablesCheck', () => {
+  it('reports a missing required parameter', async () => {
+    const files = {
+      'app/views/partials/page.liquid': `{% graphql r = 'create' %}`,
+      'app/graphql/create.graphql': GRAPHQL_WITH_REQUIRED,
+    };
+
+    const offenses = await check(files, [GraphQLVariablesCheck]);
+
+    expect(offenses).to.have.length(1);
+    expect(offenses[0].message).to.equal(
+      'Required parameter content must be passed to GraphQL call',
+    );
+  });
+
+  it('does not report when all required parameters are provided', async () => {
+    const files = {
+      'app/views/partials/page.liquid': `{% graphql r = 'create', content: 'hello' %}`,
+      'app/graphql/create.graphql': GRAPHQL_WITH_REQUIRED,
+    };
+
+    const offenses = await check(files, [GraphQLVariablesCheck]);
+
+    expect(offenses).to.be.empty;
+  });
+
+  it('does not report when the parameter is optional', async () => {
+    const files = {
+      'app/views/partials/page.liquid': `{% graphql r = 'create' %}`,
+      'app/graphql/create.graphql': GRAPHQL_WITH_OPTIONAL,
+    };
+
+    const offenses = await check(files, [GraphQLVariablesCheck]);
+
+    expect(offenses).to.be.empty;
+  });
+
+  it('does not report when args is used (hash splat)', async () => {
+    const files = {
+      'app/views/partials/page.liquid': `{% graphql r = 'create', args: object %}`,
+      'app/graphql/create.graphql': GRAPHQL_WITH_REQUIRED,
+    };
+
+    const offenses = await check(files, [GraphQLVariablesCheck]);
+
+    expect(offenses).to.be.empty;
+  });
+
+  it('does not report unknown parameter when args is used', async () => {
+    const files = {
+      'app/views/partials/page.liquid': `{% graphql r = 'create', args: object, extra: 'x' %}`,
+      'app/graphql/create.graphql': GRAPHQL_WITH_REQUIRED,
+    };
+
+    const offenses = await check(files, [GraphQLVariablesCheck]);
+
+    expect(offenses).to.be.empty;
+  });
+
+  it('reports an unknown parameter when args is not used', async () => {
+    const files = {
+      'app/views/partials/page.liquid': `{% graphql r = 'create', content: 'hello', unknown: 'x' %}`,
+      'app/graphql/create.graphql': GRAPHQL_WITH_REQUIRED,
+    };
+
+    const offenses = await check(files, [GraphQLVariablesCheck]);
+
+    expect(offenses).to.have.length(1);
+    expect(offenses[0].message).to.equal('Unknown parameter unknown passed to GraphQL call');
+  });
+});

package/src/checks/graphql-variables/index.ts

@@ -64,6 +64,10 @@ export const GraphQLVariablesCheck: LiquidCheckDefinition = {
       args: LiquidNamedArgument[],
       position: Position,
     ) => {
+      // `args` is a special parameter that splats a hash as all GraphQL variables
+      // at runtime — we can't know which keys will be provided statically.
+      if (args.some((arg) => arg.name === 'args')) return;
+
       const locatedFile = await locator.locate(
         URI.parse(context.config.rootUri),
         'graphql',

package/src/checks/img-width-and-height/index.ts

@@ -7,7 +7,7 @@ export const ImgWidthAndHeight: LiquidCheckDefinition = {
     name: 'Width and height attributes on image tags',
     docs: {
       description:
-        'This check is aimed at eliminating content layout shift in themes by enforcing the use of the width and height attributes on img tags.',
+        'This check is aimed at eliminating content layout shift by enforcing the use of the width and height attributes on img tags.',
       recommended: true,
       url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/img-width-and-height',
     },

package/src/checks/invalid-hash-assign-target/index.spec.ts

@@ -4,72 +4,72 @@ import { check, MockApp } from '../../test';
 
 describe('Module: InvalidHashAssignTarget', () => {
   it('should report an error when hash_assign is used on a number', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = 10 %}
         {% hash_assign x['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('number');
     expect(offenses[0].message).toContain('hash_assign');
   });
 
   it('should report an error when hash_assign is used on a string', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = 'hello' %}
         {% hash_assign x['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('string');
   });
 
   it('should report an error when hash_assign is used on a boolean', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = true %}
         {% hash_assign x['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('boolean');
   });
 
   it('should report an error when hash_assign is used on an array (range)', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = (1..5) %}
         {% hash_assign x['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('array');
   });
 
   it('should not report an error when hash_assign is used on an object from parse_json', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = '{}' | parse_json %}
         {% hash_assign x['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(0);
   });
 
   it('should not report an error when hash_assign is used on an object from parse_json tag', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% parse_json x %}
           {}
@@ -78,12 +78,12 @@ describe('Module: InvalidHashAssignTarget', () => {
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(0);
   });
 
   it('should not report an error when hash_assign is used on an object from graphql', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% graphql result %}
           query { user { id } }
@@ -92,35 +92,35 @@ describe('Module: InvalidHashAssignTarget', () => {
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(0);
   });
 
   it('should not report an error when hash_assign is used on an untyped variable', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% hash_assign unknown_var['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(0);
   });
 
   it('should not report an error when hash_assign is used on a function return', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% function data = 'lib/get_data' %}
         {% hash_assign data['extra'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(0);
   });
 
   it('should track reassignment and report error on new type', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = '{}' | parse_json %}
         {% hash_assign x['key1'] = 'value1' %}
@@ -129,39 +129,39 @@ describe('Module: InvalidHashAssignTarget', () => {
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('number');
   });
 
   it('should handle increment/decrement as numbers', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% increment counter %}
         {% hash_assign counter['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('number');
   });
 
   it('should handle capture as string', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% capture x %}hello{% endcapture %}
         {% hash_assign x['key'] = 'value' %}
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).toContain('string');
   });
 
   it('should allow multiple hash_assign on same object', async () => {
-    const theme: MockApp = {
+    const app: MockApp = {
       'file.liquid': `
         {% assign x = '{}' | parse_json %}
         {% hash_assign x['key1'] = 'value1' %}
@@ -170,7 +170,7 @@ describe('Module: InvalidHashAssignTarget', () => {
       `,
     };
 
-    const offenses = await check(theme, [InvalidHashAssignTarget]);
+    const offenses = await check(app, [InvalidHashAssignTarget]);
     expect(offenses).toHaveLength(0);
   });
 });

package/src/checks/json-syntax-error/index.ts

@@ -13,7 +13,7 @@ export const JSONSyntaxError: JSONCheckDefinition = {
     code: 'JSONSyntaxError',
     name: 'Enforce valid JSON',
     docs: {
-      description: 'This check exists to prevent invalid JSON files in themes.',
+      description: 'This check exists to prevent invalid JSON files in apps.',
       recommended: true,
       url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/json-syntax-error',
     },

package/src/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.ts

@@ -101,13 +101,13 @@ export function detectInvalidLoopArguments(
 }
 
 function isSupportedTagArgument(
-  tags: TagEntry[],
+  tags: TagEntry[] | undefined,
   tagName: string,
   key: string,
   positional: boolean,
 ) {
   return (
-    tags
+    (tags ?? [])
       .find((tag) => tag.name === tagName)
       ?.parameters?.some(
         (parameter) => parameter.name === key && parameter.positional === positional,