@platformos/platformos-check-common 0.0.6 → 0.0.8

package/src/index.ts

@@ -1,13 +1,10 @@
-import { AugmentedThemeDocset } from './AugmentedThemeDocset';
+import { AugmentedPlatformOSDocset } from './AugmentedPlatformOSDocset';
 import { JSONValidator } from './JSONValidator';
 import {
   makeFileExists,
   makeFileSize,
   makeGetDefaultLocale,
-  makeGetDefaultSchemaLocale,
-  makeGetDefaultSchemaTranslations,
   makeGetDefaultTranslations,
-  makeGetMetafieldDefinitions,
 } from './context-utils';
 import { createDisabledChecksModule } from './disabled-checks';
 import { isIgnored } from './ignore';
@@ -35,13 +32,16 @@ import {
   Settings,
   SourceCode,
   SourceCodeType,
-  Theme,
+  App,
   ValidateJSON,
+  YAMLCheck,
+  YAMLSourceCode,
 } from './types';
 import { getPosition } from './utils';
 import { visitJSON, visitLiquid } from './visitors';
 
-export * from './AugmentedThemeDocset';
+export * from './AugmentedPlatformOSDocset';
+export * from './types/platformos-liquid-docs';
 export * from './checks';
 export * from './context-utils';
 export * from './find-root';
@@ -50,7 +50,6 @@ export * from './ignore';
 export * from './json';
 export * from './JSONValidator';
 export * as path from './path';
-export * from './to-schema';
 export * from './to-source-code';
 export * from './types';
 export * from './utils/error';
@@ -60,7 +59,6 @@ export * from './utils/types';
 export * from './utils/object';
 export * from './visitor';
 export * from './liquid-doc/liquidDoc';
-export { getBlockName } from './liquid-doc/arguments';
 export * from './liquid-doc/utils';
 
 const defaultErrorHandler = (_error: Error): void => {
@@ -68,7 +66,7 @@ const defaultErrorHandler = (_error: Error): void => {
 };
 
 export async function check(
-  theme: Theme,
+  app: App,
   config: Config,
   injectedDependencies: Dependencies,
 ): Promise<Offense[]> {
@@ -78,15 +76,10 @@ export async function check(
   const { rootUri } = config;
   const dependencies: AugmentedDependencies = {
     ...injectedDependencies,
-    mode: config.context,
     fileExists: makeFileExists(fs),
     fileSize: makeFileSize(fs),
     getDefaultLocale: makeGetDefaultLocale(fs, rootUri),
-    getDefaultTranslations: makeGetDefaultTranslations(fs, theme, rootUri),
-    getDefaultSchemaLocale: makeGetDefaultSchemaLocale(fs, rootUri),
-    getDefaultSchemaTranslations: makeGetDefaultSchemaTranslations(fs, theme, rootUri),
-    getMetafieldDefinitions:
-      injectedDependencies.getMetafieldDefinitions ?? makeGetMetafieldDefinitions(fs),
+    getDefaultTranslations: makeGetDefaultTranslations(fs, app, rootUri),
   };
 
   const { DisabledChecksVisitor, isDisabled } = createDisabledChecksModule();
@@ -94,14 +87,14 @@ export async function check(
   const validateJSON = jsonValidator?.validate;
 
   // We're memozing those deps here because they shouldn't change within a run.
-  if (dependencies.themeDocset && !dependencies.themeDocset.isAugmented) {
-    dependencies.themeDocset = new AugmentedThemeDocset(dependencies.themeDocset);
+  if (dependencies.platformosDocset && !dependencies.platformosDocset.isAugmented) {
+    dependencies.platformosDocset = new AugmentedPlatformOSDocset(dependencies.platformosDocset);
   }
 
   for (const type of Object.values(SourceCodeType)) {
     switch (type) {
       case SourceCodeType.JSON: {
-        const files = filesOfType(type, theme);
+        const files = filesOfType(type, app);
         const checkDefs = checksOfType(type, config.checks);
         for (const file of files) {
           for (const checkDef of checkDefs) {
@@ -113,7 +106,7 @@ export async function check(
         break;
       }
       case SourceCodeType.GraphQL: {
-        const files = filesOfType(type, theme);
+        const files = filesOfType(type, app);
         const checkDefs = checksOfType(type, config.checks);
         for (const file of files) {
           for (const checkDef of checkDefs) {
@@ -125,7 +118,7 @@ export async function check(
         break;
       }
       case SourceCodeType.LiquidHtml: {
-        const files = filesOfType(type, theme);
+        const files = filesOfType(type, app);
         const checkDefs = [DisabledChecksVisitor, ...checksOfType(type, config.checks)];
         for (const file of files) {
           for (const checkDef of checkDefs) {
@@ -136,6 +129,18 @@ export async function check(
         }
         break;
       }
+      case SourceCodeType.YAML: {
+        const files = filesOfType(type, app);
+        const checkDefs = checksOfType(type, config.checks);
+        for (const file of files) {
+          for (const checkDef of checkDefs) {
+            if (isIgnored(file.uri, config, checkDef)) continue;
+            const check = createCheck(checkDef, file, config, offenses, dependencies, validateJSON);
+            pipelines.push(checkYAMLFile(check, file));
+          }
+        }
+        break;
+      }
     }
   }
 
@@ -210,7 +215,7 @@ function createCheck<S extends SourceCodeType>(
   return check.create(context as any) as Check<S>;
 }
 
-function filesOfType<S extends SourceCodeType>(type: S, sourceCodes: Theme): SourceCode<S>[] {
+function filesOfType<S extends SourceCodeType>(type: S, sourceCodes: App): SourceCode<S>[] {
   return sourceCodes.filter((file): file is SourceCode<S> => file.type === type);
 }
 
@@ -232,3 +237,10 @@ async function checkLiquidFile(check: LiquidCheck, file: LiquidSourceCode): Prom
   if (Object.keys(check).length > 0) await visitLiquid(file.ast, check);
   if (check.onCodePathEnd) await check.onCodePathEnd(file as typeof file & { ast: LiquidHtmlNode });
 }
+
+async function checkYAMLFile(check: YAMLCheck, file: YAMLSourceCode): Promise<void> {
+  if (check.onCodePathStart) await check.onCodePathStart(file);
+  if (file.ast instanceof Error) return;
+  if (Object.keys(check).length > 0) await visitJSON(file.ast, check as any);
+  if (check.onCodePathEnd) await check.onCodePathEnd(file as typeof file & { ast: JSONNode });
+}

package/src/jsonc/parse.ts

@@ -20,7 +20,7 @@ export class JSONCParseErrors extends Error {
 }
 
 /**
- * At some point, we started supporting JSONC. Theme Check 2 was built on top of
+ * At some point, we started supporting JSONC. App Check 2 was built on top of
  * `json-to-ast` which does not support comments.
  *
  * This little adapter here will take a tree we get from `jsonc-parser` and

package/src/liquid-doc/arguments.spec.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import { applyFixToString, createCorrector } from '../fixes';
 import { makeAddArgumentCorrector, makeRemoveArgumentCorrector } from './arguments';
-import { ContentForMarkup, DocumentNode, LiquidTag } from '@platformos/liquid-html-parser';
+import { DocumentNode, LiquidTag, RenderMarkup } from '@platformos/liquid-html-parser';
 import { SourceCodeType, toLiquidHTMLAST } from '..';
 
 describe('Arguments', () => {
@@ -15,53 +15,45 @@ describe('Arguments', () => {
     };
 
     it('should suggest adding missing required arguments when none already exist', () => {
-      const node = makeContentForMarkup(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '' %}`,
-      );
+      const node = makeRenderMarkup(`{% render 'partial', some-arg: '' %}`);
 
       const fixer = createCorrector(SourceCodeType.LiquidHtml, node.source);
 
       makeAddArgumentCorrector(node, requiredParam)(fixer);
 
       expect(applyFixToString(node.source, fixer.fix)).toBe(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '', required_string: '' %}`,
+        `{% render 'partial', some-arg: '', required_string: '' %}`,
       );
     });
 
     it('should suggest adding missing required arguments and correcting trailing comma + whitespace', () => {
-      const node = makeContentForMarkup(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '',    %}`,
-      );
+      const node = makeRenderMarkup(`{% render 'partial', some-arg: '',    %}`);
 
       const fixer = createCorrector(SourceCodeType.LiquidHtml, node.source);
 
       makeAddArgumentCorrector(node, requiredParam)(fixer);
 
       expect(applyFixToString(node.source, fixer.fix)).toBe(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '', required_string: '' %}`,
+        `{% render 'partial', some-arg: '', required_string: '' %}`,
       );
     });
 
     it('should suggest adding missing required arguments and correcting trailing spaces + comma', () => {
-      const node = makeContentForMarkup(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: ''    ,    %}`,
-      );
+      const node = makeRenderMarkup(`{% render 'partial', some-arg: ''    ,    %}`);
 
       const fixer = createCorrector(SourceCodeType.LiquidHtml, node.source);
 
       makeAddArgumentCorrector(node, requiredParam)(fixer);
 
       expect(applyFixToString(node.source, fixer.fix)).toBe(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '', required_string: '' %}`,
+        `{% render 'partial', some-arg: '', required_string: '' %}`,
       );
     });
   });
 
   describe('makeRemoveArgumentCorrector', () => {
     it("should remove the last argument and it's leading comma", () => {
-      const node = makeContentForMarkup(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '' %}`,
-      );
+      const node = makeRenderMarkup(`{% render 'partial', id: 'fake', some-arg: '' %}`);
 
       const argToRemove = node.args.at(-1)!;
 
@@ -69,15 +61,11 @@ describe('Arguments', () => {
 
       makeRemoveArgumentCorrector(node, argToRemove)(fixer);
 
-      expect(applyFixToString(node.source, fixer.fix)).toBe(
-        `{% content_for 'block', type: 'swatches', id: 'fake' %}`,
-      );
+      expect(applyFixToString(node.source, fixer.fix)).toBe(`{% render 'partial', id: 'fake' %}`);
     });
 
     it('should remove an argument in the middle', () => {
-      const node = makeContentForMarkup(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '' %}`,
-      );
+      const node = makeRenderMarkup(`{% render 'partial', id: 'fake', some-arg: '' %}`);
 
       const argToRemove = node.args.at(-2)!;
 
@@ -85,15 +73,11 @@ describe('Arguments', () => {
 
       makeRemoveArgumentCorrector(node, argToRemove)(fixer);
 
-      expect(applyFixToString(node.source, fixer.fix)).toBe(
-        `{% content_for 'block', type: 'swatches', some-arg: '' %}`,
-      );
+      expect(applyFixToString(node.source, fixer.fix)).toBe(`{% render 'partial', some-arg: '' %}`);
     });
 
     it('should remove an argument with trailing comma', () => {
-      const node = makeContentForMarkup(
-        `{% content_for 'block', type: 'swatches', id: 'fake', some-arg: '', %}`,
-      );
+      const node = makeRenderMarkup(`{% render 'partial', id: 'fake', some-arg: '', %}`);
 
       const argToRemove = node.args.at(-1)!;
 
@@ -101,16 +85,12 @@ describe('Arguments', () => {
 
       makeRemoveArgumentCorrector(node, argToRemove)(fixer);
 
-      expect(applyFixToString(node.source, fixer.fix)).toBe(
-        `{% content_for 'block', type: 'swatches', id: 'fake' %}`,
-      );
+      expect(applyFixToString(node.source, fixer.fix)).toBe(`{% render 'partial', id: 'fake' %}`);
     });
   });
 
   it('should remove an argument with trailing space', () => {
-    const node = makeContentForMarkup(
-      `{% content_for 'block', type: 'swatches', id: 'fake'     , some-arg: '' %}`,
-    );
+    const node = makeRenderMarkup(`{% render 'partial', id: 'fake'     , some-arg: '' %}`);
 
     const argToRemove = node.args.at(-2)!;
 
@@ -118,15 +98,11 @@ describe('Arguments', () => {
 
     makeRemoveArgumentCorrector(node, argToRemove)(fixer);
 
-    expect(applyFixToString(node.source, fixer.fix)).toBe(
-      `{% content_for 'block', type: 'swatches', some-arg: '' %}`,
-    );
+    expect(applyFixToString(node.source, fixer.fix)).toBe(`{% render 'partial', some-arg: '' %}`);
   });
 
   it('should remove an argument with leading space', () => {
-    const node = makeContentForMarkup(
-      `{% content_for 'block', type: 'swatches', id: 'fake',    some-arg: '' %}`,
-    );
+    const node = makeRenderMarkup(`{% render 'partial', id: 'fake',    some-arg: '' %}`);
 
     const argToRemove = node.args.at(-1)!;
 
@@ -134,13 +110,11 @@ describe('Arguments', () => {
 
     makeRemoveArgumentCorrector(node, argToRemove)(fixer);
 
-    expect(applyFixToString(node.source, fixer.fix)).toBe(
-      `{% content_for 'block', type: 'swatches', id: 'fake' %}`,
-    );
+    expect(applyFixToString(node.source, fixer.fix)).toBe(`{% render 'partial', id: 'fake' %}`);
   });
 });
 
-function makeContentForMarkup(source: string): ContentForMarkup {
+function makeRenderMarkup(source: string): RenderMarkup {
   const ast = toLiquidHTMLAST(source) as DocumentNode;
-  return (ast.children[0] as LiquidTag).markup as ContentForMarkup;
+  return (ast.children[0] as LiquidTag).markup as RenderMarkup;
 }

package/src/liquid-doc/arguments.ts

@@ -3,7 +3,6 @@
  * errors when LiquidDoc exists
  */
 import {
-  ContentForMarkup,
   RenderMarkup,
   FunctionMarkup,
   LiquidNamedArgument,
@@ -17,20 +16,21 @@ import {
   isTypeCompatible,
 } from './utils';
 import { isLiquidString } from '../checks/utils';
+import { DocumentsLocator } from '@platformos/platformos-common';
+import { URI } from 'vscode-uri';
+import { relative } from '../path';
 
 /**
  * Report error when unknown arguments are provided for `content_for` tag or `render` tag
  */
 export function reportUnknownArguments(
   context: Context<SourceCodeType.LiquidHtml>,
-  node: ContentForMarkup | RenderMarkup | FunctionMarkup,
+  node: RenderMarkup | FunctionMarkup,
   unknownProvidedArgs: LiquidNamedArgument[],
   name: string,
 ) {
   let errorOwnerMessage = '';
-  if (node.type === NodeTypes.ContentForMarkup) {
-    errorOwnerMessage = ` in content_for tag for static block '${name}'`;
-  } else if (node.type === NodeTypes.RenderMarkup) {
+  if (node.type === NodeTypes.RenderMarkup) {
     errorOwnerMessage = ` in render tag for partial '${name}'`;
   } else if (node.type === NodeTypes.FunctionMarkup) {
     errorOwnerMessage = ` in function tag for partial '${name}'`;
@@ -56,14 +56,12 @@ export function reportUnknownArguments(
  */
 export function reportMissingArguments(
   context: Context<SourceCodeType.LiquidHtml>,
-  node: ContentForMarkup | RenderMarkup | FunctionMarkup,
+  node: RenderMarkup | FunctionMarkup,
   missingRequiredArgs: LiquidDocParameter[],
   name: string,
 ) {
   let errorOwnerMessage = '';
-  if (node.type === NodeTypes.ContentForMarkup) {
-    errorOwnerMessage = ` in content_for tag for static block '${name}'`;
-  } else if (node.type === NodeTypes.RenderMarkup) {
+  if (node.type === NodeTypes.RenderMarkup) {
     errorOwnerMessage = ` in render tag for partial '${name}'`;
   } else if (node.type === NodeTypes.FunctionMarkup) {
     errorOwnerMessage = ` in function tag for partial '${name}'`;
@@ -86,14 +84,12 @@ export function reportMissingArguments(
 
 export function reportDuplicateArguments(
   context: Context<SourceCodeType.LiquidHtml>,
-  node: ContentForMarkup | RenderMarkup | FunctionMarkup,
+  node: RenderMarkup | FunctionMarkup,
   duplicateArgs: LiquidNamedArgument[],
   name: string,
 ) {
   let errorOwnerMessage = '';
-  if (node.type === NodeTypes.ContentForMarkup) {
-    errorOwnerMessage = ` in content_for tag for static block '${name}'`;
-  } else if (node.type === NodeTypes.RenderMarkup) {
+  if (node.type === NodeTypes.RenderMarkup) {
     errorOwnerMessage = ` in render tag for partial '${name}'`;
   } else if (node.type === NodeTypes.FunctionMarkup) {
     errorOwnerMessage = ` in function tag for partial '${name}'`;
@@ -208,29 +204,12 @@ export function generateTypeMismatchSuggestions(
   return suggestions;
 }
 
-function isLastArg(
-  node: RenderMarkup | ContentForMarkup | FunctionMarkup,
-  arg: LiquidNamedArgument,
-): boolean {
+function isLastArg(node: RenderMarkup | FunctionMarkup, arg: LiquidNamedArgument): boolean {
   return (
     node.args.length == 1 || arg.position.start == node.args[node.args.length - 1].position.start
   );
 }
 
-export function getBlockName(node: ContentForMarkup) {
-  if (node.contentForType.value !== 'block') {
-    return;
-  }
-
-  const contentForTypeArg = node.args.find((arg) => arg.name == 'type')?.value;
-
-  if (!contentForTypeArg || !isLiquidString(contentForTypeArg)) {
-    return;
-  }
-
-  return contentForTypeArg.value;
-}
-
 export function getPartialName(node: RenderMarkup | FunctionMarkup): string | undefined {
   if (node.type === NodeTypes.RenderMarkup) {
     if (!isLiquidString(node.snippet)) {
@@ -249,19 +228,27 @@ export function getPartialName(node: RenderMarkup | FunctionMarkup): string | un
 
 export async function getLiquidDocParams(
   context: Context<SourceCodeType.LiquidHtml>,
-  relativePath: string,
+  partialName: string,
 ) {
-  const docDefinition = context.getDocDefinition && (await context.getDocDefinition(relativePath));
-
-  if (!docDefinition?.liquidDoc?.parameters) {
-    return;
+  if (!context.getDocDefinition) return;
+
+  // Use DocumentsLocator to find the partial across all platformOS locations,
+  // including app/views/partials/, app/lib/, and module paths.
+  const locator = new DocumentsLocator(context.fs);
+  const fileUri = await locator.locate(URI.parse(context.config.rootUri), 'render', partialName);
+  if (!fileUri) return undefined;
+
+  const relativePath = relative(fileUri, context.config.rootUri);
+  const docDefinition = await context.getDocDefinition(relativePath);
+  if (docDefinition?.liquidDoc?.parameters) {
+    return new Map(docDefinition.liquidDoc.parameters.map((p) => [p.name, p]));
   }
 
-  return new Map(docDefinition.liquidDoc.parameters.map((p) => [p.name, p]));
+  return undefined;
 }
 
 export function makeRemoveArgumentCorrector(
-  node: ContentForMarkup | RenderMarkup | FunctionMarkup,
+  node: RenderMarkup | FunctionMarkup,
   arg: LiquidNamedArgument,
 ) {
   return (fixer: StringCorrector) => {
@@ -287,7 +274,7 @@ export function makeRemoveArgumentCorrector(
 }
 
 export function makeAddArgumentCorrector(
-  node: ContentForMarkup | RenderMarkup | FunctionMarkup,
+  node: RenderMarkup | FunctionMarkup,
   arg: LiquidDocParameter,
 ) {
   return (fixer: StringCorrector) => {

package/src/liquid-doc/liquidDoc.ts

@@ -9,8 +9,7 @@ import {
 
 export type GetDocDefinitionForURI = (
   uri: UriString,
-  category: 'blocks' | 'app/views/partials',
-  name: string,
+  partialName: string,
 ) => Promise<DocDefinition | undefined>;
 
 export type DocDefinition = {

package/src/liquid-doc/utils.ts

@@ -1,7 +1,6 @@
 import { LiquidExpression, NodeTypes } from '@platformos/liquid-html-parser';
 import { assertNever } from '../utils';
-import { isSnippet } from '../to-schema';
-import { isBlock } from '../to-schema';
+import { isPartial } from '../path';
 import { ObjectEntry, UriString } from '../types';
 
 /**
@@ -55,6 +54,8 @@ export function inferArgumentType(arg: LiquidExpression): BasicParamTypes {
       return BasicParamTypes.Boolean;
     case NodeTypes.Range:
     case NodeTypes.VariableLookup:
+    case NodeTypes.JsonHashLiteral:
+    case NodeTypes.JsonArrayLiteral:
       return BasicParamTypes.Object;
     default:
       // This ensures that we have a case for every possible type for arg.value
@@ -81,7 +82,7 @@ export function isTypeCompatible(expectedType: string, actualType: BasicParamTyp
  * Checks if the provided file path supports the LiquidDoc tag.
  */
 export function filePathSupportsLiquidDoc(uri: UriString) {
-  return isSnippet(uri) || isBlock(uri);
+  return isPartial(uri);
 }
 
 /**

package/src/path.ts

@@ -1,5 +1,6 @@
 import { RelativePath, UriString } from './types';
 import { URI, Utils } from 'vscode-uri';
+export { isPartial, isLayout, isPage } from '@platformos/platformos-common';
 
 export { URI, Utils };
 

package/src/test/{MockTheme.ts → MockApp.ts}

@@ -12,6 +12,6 @@
  * }
  */
 
-export type MockTheme = {
+export type MockApp = {
   [relativePath in string]: string;
 };

package/src/test/MockFileSystem.ts

@@ -1,7 +1,7 @@
 import { AbstractFileSystem, FileStat, FileTuple, FileType } from '@platformos/platformos-common';
 import { deepGet } from '../utils';
 import { normalize, relative } from '../path';
-import { MockTheme } from './MockTheme';
+import { MockApp } from './MockApp';
 import * as path from '../path';
 
 interface FileTree {
@@ -11,16 +11,19 @@ interface FileTree {
 export class MockFileSystem implements AbstractFileSystem {
   private rootUri: string;
 
-  constructor(private mockTheme: MockTheme, rootUri = 'file:///') {
+  constructor(
+    private mockApp: MockApp,
+    rootUri = 'file:///',
+  ) {
     this.rootUri = normalize(rootUri);
   }
 
   async readFile(uri: string): Promise<string> {
     const relativePath = this.rootRelative(uri);
-    if (this.mockTheme[relativePath] === undefined) {
+    if (this.mockApp[relativePath] === undefined) {
       throw new Error('File not found');
     } else {
-      return this.mockTheme[relativePath];
+      return this.mockApp[relativePath];
     }
   }
 
@@ -47,7 +50,7 @@ export class MockFileSystem implements AbstractFileSystem {
 
   async stat(uri: string): Promise<FileStat> {
     const relativePath = this.rootRelative(uri);
-    const source = this.mockTheme[relativePath];
+    const source = this.mockApp[relativePath];
     if (source) {
       return {
         type: FileType.File,
@@ -68,7 +71,7 @@ export class MockFileSystem implements AbstractFileSystem {
 
   private get fileTree(): FileTree {
     const result: FileTree = {};
-    for (const [relativePath, source] of Object.entries(this.mockTheme)) {
+    for (const [relativePath, source] of Object.entries(this.mockApp)) {
       const segments = relativePath.split('/');
       let current = result;
       for (let i = 0; i < segments.length - 1; i++) {

package/src/test/index.ts

@@ -1,3 +1,3 @@
 export * from './MockFileSystem';
-export * from './MockTheme';
+export * from './MockApp';
 export * from './test-helper';