@platformos/platformos-check-common 0.0.7 → 0.0.8

package/src/test/test-helper.ts

@@ -10,44 +10,39 @@ import {
   Dependencies,
   extractDocDefinition,
   FixApplicator,
-  isBlock,
-  isSection,
   JSONCorrector,
   JSONSourceCode,
   LiquidSourceCode,
   Offense,
   recommended,
-  SectionSchema,
   SourceCodeType,
   StringCorrector,
-  Theme,
-  ThemeBlockSchema,
-  toSchema,
+  App,
   toSourceCode,
+  YAMLSourceCode,
 } from '../index';
 import * as path from '../path';
 import { MockFileSystem } from './MockFileSystem';
-import { MockTheme } from './MockTheme';
+import { MockApp } from './MockApp';
 
 export { JSONCorrector, StringCorrector };
 
 const rootUri = path.normalize('file:/');
 
-export function getTheme(themeDesc: MockTheme): Theme {
+export function getApp(themeDesc: MockApp): App {
   return Object.entries(themeDesc)
     .map(([relativePath, source]) => toSourceCode(toUri(relativePath), source))
-    .filter((x): x is LiquidSourceCode | JSONSourceCode => x !== undefined);
+    .filter((x): x is LiquidSourceCode | JSONSourceCode | YAMLSourceCode => x !== undefined);
 }
 
 export async function check(
-  themeDesc: MockTheme,
+  themeDesc: MockApp,
   checks: CheckDefinition[] = recommended,
   mockDependencies: Partial<Dependencies> = {},
   checkSettings: ChecksSettings = {},
 ): Promise<Offense[]> {
-  const theme = getTheme(themeDesc);
+  const theme = getApp(themeDesc);
   const config: Config = {
-    context: 'theme',
     settings: { ...checkSettings },
     checks,
     rootUri,
@@ -56,40 +51,8 @@ export async function check(
     },
   };
 
-  const sections = new Map(
-    theme
-      .filter((source) => isSection(source.uri))
-      .map((source) => [path.basename(source.uri, '.liquid'), source]),
-  );
-  const blocks = new Map(
-    theme
-      .filter((source) => isBlock(source.uri))
-      .map((source) => [path.basename(source.uri, '.liquid'), source]),
-  );
-
-  /**
-   * Schemas are assumed to be valid in tests, hijack
-   * getBlockSchema/getSectionSchema with overrides when you want to test
-   * something otherwise
-   */
-  const isValidSchema = async () => true;
-
   const defaultMockDependencies: Dependencies = {
-    fs: new MockFileSystem({ '.theme-check.yml': '', ...themeDesc }),
-    async getBlockSchema(name) {
-      const block = blocks.get(name);
-      if (!block) return undefined;
-      return toSchema(config.context, block.uri, block, isValidSchema) as Promise<
-        ThemeBlockSchema | undefined
-      >;
-    },
-    async getSectionSchema(name) {
-      const section = sections.get(name);
-      if (!section) return undefined;
-      return toSchema(config.context, section.uri, section, isValidSchema) as Promise<
-        SectionSchema | undefined
-      >;
-    },
+    fs: new MockFileSystem({ '.platformos-check.yml': '', ...themeDesc }),
     async getDocDefinition(relativePath) {
       const file = theme.find((file) => file.uri.endsWith(relativePath));
       if (!file || !isLiquidHtmlNode(file.ast)) {
@@ -97,54 +60,18 @@ export async function check(
       }
       return extractDocDefinition(file.uri, file.ast);
     },
-    themeDocset: {
+    platformosDocset: {
       async graphQL() {
         return null;
       },
       async filters() {
         return [
           { name: 'item_count_for_variant' },
-          { name: 'link_to_type' },
-          { name: 'link_to_vendor' },
           { name: 'append' },
           { name: 'upcase' },
           { name: 'downcase' },
-          { name: 'color_to_rgb' },
-          {
-            name: 'hex_to_rgba',
-            deprecated: true,
-            deprecation_reason: '`hex_to_rgba` has been replaced by [`color_to_rgb`](/do...',
-          },
-          {
-            name: 'currency_selector',
-            deprecated: true,
-            deprecation_reason: 'Deprecated without a direct replacement because the [cur...',
-          },
-          {
-            name: 'article_img_url',
-            deprecated: true,
-            deprecation_reason: '`article_img_url` has been replaced by [`image_url`](/d...',
-          },
-          {
-            name: 'collection_img_url',
-            deprecated: true,
-            deprecation_reason: '`collection_img_url` has been replaced by [`image_url`](...',
-          },
-          {
-            name: 'img_tag',
-            deprecated: true,
-            deprecation_reason: '`img_tag` has been replaced by [`image_tag`](/docs/api/...',
-          },
-          {
-            name: 'img_url',
-            deprecated: true,
-            deprecation_reason: '`img_url` has been replaced by [`image_url`](/docs/api/...',
-          },
-          {
-            name: 'product_img_url',
-            deprecated: true,
-            deprecation_reason: '`product_img_url` has been replaced by [`image_url`](/d...',
-          },
+          { name: 'parameterize' },
+          { name: 'slugify' },
         ];
       },
       async objects() {
@@ -169,17 +96,9 @@ export async function check(
             },
           },
           {
-            name: 'section',
-            access: {
-              global: false,
-              parents: [],
-              template: [],
-            },
-          },
-          {
-            name: 'block',
+            name: 'context',
             access: {
-              global: false,
+              global: true,
               parents: [],
               template: [],
             },
@@ -192,30 +111,6 @@ export async function check(
               template: [],
             },
           },
-          {
-            name: 'predictive_search',
-            access: {
-              global: false,
-              parents: [],
-              template: [],
-            },
-          },
-          {
-            name: 'recommendations',
-            access: {
-              global: false,
-              parents: [],
-              template: [],
-            },
-          },
-          {
-            name: 'comment',
-            access: {
-              global: false,
-              parents: [],
-              template: [],
-            },
-          },
         ];
       },
       async liquidDrops() {
@@ -224,9 +119,6 @@ export async function check(
       async tags() {
         return [];
       },
-      async systemTranslations() {
-        return { 'shopify.sentence.words_connector': ', ' };
-      },
     },
   };
 
@@ -238,7 +130,7 @@ export async function runLiquidCheck(
   sourceCode: string,
   fileName: string = 'file.liquid',
   mockDependencies: Partial<Dependencies> = {},
-  existingThemeFiles?: MockTheme,
+  existingThemeFiles?: MockApp,
 ): Promise<Offense[]> {
   const offenses = await check(
     { ...existingThemeFiles, [fileName]: sourceCode },
@@ -258,8 +150,18 @@ export async function runJSONCheck(
   return offenses.filter((offense) => offense.uri === path.join(rootUri, fileName));
 }
 
-export async function autofix(themeDesc: MockTheme, offenses: Offense[]) {
-  const theme = getTheme(themeDesc);
+export async function runYAMLCheck(
+  checkDef: CheckDefinition<SourceCodeType.YAML>,
+  sourceCode: string,
+  fileName: string = 'file.yml',
+  mockDependencies: Partial<Dependencies> = {},
+): Promise<Offense[]> {
+  const offenses = await check({ [fileName]: sourceCode }, [checkDef], mockDependencies);
+  return offenses.filter((offense) => offense.uri === path.join(rootUri, fileName));
+}
+
+export async function autofix(themeDesc: MockApp, offenses: Offense[]) {
+  const theme = getApp(themeDesc);
   const fixed = { ...themeDesc };
 
   const stringApplicator: FixApplicator = async (sourceCode, fixes) => {
@@ -272,7 +174,7 @@ export async function autofix(themeDesc: MockTheme, offenses: Offense[]) {
 }
 
 export function applyFix(
-  themeDescOrSource: MockTheme | string,
+  themeDescOrSource: MockApp | string,
   offense: Offense,
 ): string | undefined {
   const source =
@@ -285,7 +187,7 @@ export function applyFix(
 }
 
 export function applySuggestions(
-  themeDescOrSource: MockTheme | string,
+  themeDescOrSource: MockApp | string,
   offense: Offense,
 ): undefined | string[] {
   const source =
@@ -299,7 +201,7 @@ export function applySuggestions(
   });
 }
 
-export function highlightedOffenses(themeOrSource: MockTheme | string, offenses: Offense[]) {
+export function highlightedOffenses(themeOrSource: MockApp | string, offenses: Offense[]) {
   const theme =
     typeof themeOrSource === 'string' ? { 'file.liquid': themeOrSource } : themeOrSource;
   return offenses.map((offense) => {

package/src/to-source-code.ts

@@ -1,6 +1,7 @@
 import { toLiquidHtmlAST } from '@platformos/liquid-html-parser';
 
 import { toJSONNode } from './jsonc/parse';
+import { toYAMLNode } from './yaml/parse';
 import * as path from './path';
 import {
   GraphQLDocumentNode,
@@ -9,6 +10,7 @@ import {
   JSONSourceCode,
   LiquidSourceCode,
   SourceCodeType,
+  YAMLSourceCode,
 } from './types';
 import { asError } from './utils/error';
 
@@ -28,6 +30,14 @@ export function toJSONAST(source: string): JSONNode | Error {
   }
 }
 
+export function toYAMLAST(source: string): JSONNode | Error {
+  try {
+    return toYAMLNode(source);
+  } catch (error) {
+    return asError(error);
+  }
+}
+
 export function toGraphQLAST(source: string): GraphQLDocumentNode | Error {
   try {
     return {
@@ -43,9 +53,10 @@ export function toSourceCode(
   uri: string,
   source: string,
   version?: number,
-): LiquidSourceCode | JSONSourceCode | GraphQLSourceCode {
+): LiquidSourceCode | JSONSourceCode | GraphQLSourceCode | YAMLSourceCode {
   const isLiquid = uri.endsWith('.liquid');
   const isGraphQL = uri.endsWith('.graphql');
+  const isYAML = uri.endsWith('.yml') || uri.endsWith('.yaml');
 
   if (isLiquid) {
     return {
@@ -63,6 +74,14 @@ export function toSourceCode(
       ast: toGraphQLAST(source),
       version,
     };
+  } else if (isYAML) {
+    return {
+      uri: path.normalize(uri),
+      source,
+      type: SourceCodeType.YAML,
+      ast: toYAMLAST(source),
+      version,
+    };
   } else {
     return {
       uri: path.normalize(uri),

package/src/types/{theme-liquid-docs.ts → platformos-liquid-docs.ts}

@@ -1,29 +1,24 @@
-import { Mode, Translations } from '..';
-
 /**
- * Shopify themes docset.
+ * platformOS Liquid docset.
  */
-export interface ThemeDocset {
+export interface PlatformOSDocset {
   /** Whether it was augmented prior to being passed. */
   isAugmented?: boolean;
 
-  /** Returns Liquid filters available on themes. */
+  /** Returns Liquid filters available in platformOS. */
   filters(): Promise<FilterEntry[]>;
 
-  /** Returns objects (or Liquid variables) available on themes. */
+  /** Returns objects (or Liquid variables) available in platformOS. */
   objects(): Promise<ObjectEntry[]>;
 
-  /** Returns objects (excluding global variables, hidden objects, and deprecated objects) available on themes. */
+  /** Returns objects (excluding global variables, hidden objects, and deprecated objects) available in platformOS. */
   liquidDrops(): Promise<ObjectEntry[]>;
 
-  /** Returns Liquid tags available on themes. */
+  /** Returns Liquid tags available in platformOS. */
   tags(): Promise<TagEntry[]>;
 
   /** Returns graphql root query */
   graphQL(): Promise<string | null>;
-
-  /** Returns system translations available on themes. */
-  systemTranslations(): Promise<Translations>;
 }
 
 /** A URI that will uniquely describe the schema */
@@ -45,10 +40,10 @@ export interface SchemaDefinition {
   fileMatch?: string[];
 }
 
-/** Source of JSON schemas for themes. */
+/** Source of JSON schemas for the app. */
 export interface JsonValidationSet {
   /** All relevant SchemaDefinitions. */
-  schemas: (mode: Mode) => Promise<SchemaDefinition[]>;
+  schemas: () => Promise<SchemaDefinition[]>;
 }
 
 export interface DocsetEntry {

package/src/types/schemas/index.ts

@@ -1,5 +1,3 @@
-export { ThemeBlock } from './theme-block';
-export { Section } from './section';
 export { Setting } from './setting';
 export { Preset } from './preset';
 export { Template } from './template';

package/src/types.ts

@@ -15,15 +15,13 @@ import {
   PropertyNode,
   ValueNode,
 } from './jsonc/types';
-import { JsonValidationSet, ThemeDocset } from './types/theme-liquid-docs';
-import { AppBlockSchema, SectionSchema, ThemeBlockSchema } from './types/theme-schemas';
+import { JsonValidationSet, PlatformOSDocset } from './types/platformos-liquid-docs';
 import { DocDefinition } from './liquid-doc/liquidDoc';
 import { GraphQLCorrector } from './fixes/correctors/graphql-corrector';
 
 export * from './jsonc/types';
 export * from './types/schema-prop-factory';
-export * from './types/theme-liquid-docs';
-export * from './types/theme-schemas';
+export * from './types/platformos-liquid-docs';
 
 export const isObjectNode = (node?: ASTNode): node is ObjectNode => node?.type === 'Object';
 export const isArrayNode = (node?: ASTNode): node is ArrayNode => node?.type === 'Array';
@@ -31,9 +29,7 @@ export const isPropertyNode = (node?: ASTNode): node is PropertyNode => node?.ty
 export const isValueNode = (node?: ASTNode): node is ValueNode => node?.type === 'Value';
 export const isLiteralNode = (node?: ASTNode): node is LiteralNode => node?.type === 'Literal';
 
-export const Modes = ['theme', 'app'] as const;
-export type Mode = (typeof Modes)[number];
-export type Theme = SourceCode<SourceCodeType>[];
+export type App = SourceCode<SourceCodeType>[];
 
 export type SourceCode<T = SourceCodeType> = T extends SourceCodeType
   ? {
@@ -53,6 +49,7 @@ export enum SourceCodeType {
   JSON = 'JSON',
   LiquidHtml = 'LiquidHtml',
   GraphQL = 'GraphQL',
+  YAML = 'YAML',
 }
 
 export type LiquidSourceCode = SourceCode<SourceCodeType.LiquidHtml>;
@@ -82,6 +79,13 @@ export type JSONCheckDefinition<S extends Schema = Schema> = CheckDefinition<
 >;
 export type JSONCheck = Check<SourceCodeType.JSON>;
 
+export type YAMLSourceCode = SourceCode<SourceCodeType.YAML>;
+export type YAMLCheckDefinition<S extends Schema = Schema> = CheckDefinition<
+  SourceCodeType.YAML,
+  S
+>;
+export type YAMLCheck = Check<SourceCodeType.YAML>;
+
 export interface PlatformOSFile {
   name: string;
   module_name: string;
@@ -99,6 +103,7 @@ export type AST = {
     [SourceCodeType.JSON]: JSONNode;
     [SourceCodeType.LiquidHtml]: LiquidHtmlNode;
     [SourceCodeType.GraphQL]: GraphQLDocumentNode;
+    [SourceCodeType.YAML]: JSONNode; // YAML shares the JSONNode AST
   }[T];
 };
 
@@ -107,6 +112,7 @@ export type NodeTypes = {
     [SourceCodeType.JSON]: JSONNodeTypes;
     [SourceCodeType.LiquidHtml]: LiquidHtmlNodeTypes;
     [SourceCodeType.GraphQL]: 'Document';
+    [SourceCodeType.YAML]: JSONNodeTypes; // YAML shares JSON node types
   }[T];
 };
 
@@ -136,12 +142,6 @@ export type GraphQLCheckDefinition<S extends Schema = Schema> = CheckDefinition<
 >;
 
 export interface Config {
-  // I know, it's `context` in the config and `Mode` in the code...
-  // We already have something named "Context" internally when you're writing a check.
-  // I don't like "Mode" as a public API in the configs. Context sounds more Shopify-y.
-  // So we have `context: theme` and `context: app` as valid .theme-check.yml configs.
-  // I think it's rather obvious what they mean.
-  context: Mode;
   settings: ChecksSettings;
   checks: CheckDefinition<SourceCodeType, Schema>[];
   rootUri: string; // e.g. file:///path-to-root
@@ -214,8 +214,6 @@ export type CheckDefinition<
          *
          * When values are given, this check will be `enabled: false` in the `all.yml` configuration
          * and `enabled: true` within all yaml configurations with a matching filename.
-         *
-         * Note: theme-app-extension target is deprecated (Shopify-specific)
          */
         targets?: ConfigTarget[];
 
@@ -302,37 +300,6 @@ type CheckLifecycleMethods<T extends SourceCodeType> = {
   onCodePathEnd(file: SourceCode<T> & { ast: AST[T] }): Promise<void>;
 };
 
-export type MetafieldCategory =
-  | 'article'
-  | 'blog'
-  | 'collection'
-  | 'company'
-  | 'company_location'
-  | 'location'
-  | 'market'
-  | 'order'
-  | 'page'
-  | 'product'
-  | 'variant'
-  | 'shop';
-
-export type MetafieldDefinitionMap = {
-  [key in MetafieldCategory]: MetafieldDefinition[];
-};
-
-export type MetafieldDefinition = {
-  key: string;
-  name: string;
-  namespace: string;
-  description: string;
-  type: MetafieldDefinitionType;
-};
-
-type MetafieldDefinitionType = {
-  category: string;
-  name: string;
-};
-
 export type Translations = {
   [k in string]: string | Translations;
 };
@@ -344,17 +311,8 @@ export type Translations = {
  *
  * It could be a specific range that points to a whole file
  * {
- *   source: { uri: 'file:///templates/index.json', range: [167, 190] },
- *   target: 'file:///sections/custom-section.liquid'
- * }
- *
- * It could be a specific range that points to a specific range
- * {
- *   // e.g. `<parent-component></parent-component>`
  *   source: { uri: 'file:///app/views/partials/parent.liquid', range: [167, 190] },
- *
- *   // e.g. window.customElements.define('parent-component', ParentComponent);
- *   target: { uri: 'file:///assets/theme.js', range: [0, undefined] }
+ *   target: 'file:///app/views/partials/child.liquid'
  * }
  */
 export type Reference = {
@@ -362,9 +320,8 @@ export type Reference = {
   target: Location;
 
   type:
-    | 'direct' // explicit dependency, e.g. {% render 'child' %}
-    | 'indirect' // indirect dependency, e.g. "blocks": [{ "type": "@theme" }]
-    | 'preset'; // preset dependency
+    | 'direct' // explicit dependency, e.g. {% render 'partial' %}
+    | 'indirect'; // indirect dependency
 };
 
 export type Range = [start: number, end: number]; // represents a range in the source code
@@ -380,41 +337,16 @@ export interface Dependencies {
   fs: AbstractFileSystem;
 
   /** The typing information */
-  themeDocset?: ThemeDocset;
+  platformosDocset?: PlatformOSDocset;
 
-  /** The blocks/sections JSON schemas */
+  /** The JSON schemas */
   jsonValidationSet?: JsonValidationSet;
 
-  /** Returns the typing information for the theme's metafields */
-  getMetafieldDefinitions?: (rootUri: UriString) => Promise<MetafieldDefinitionMap>;
-
-  /**
-   * Asynchronously get the block schema for 'blocks/${name}.liquid'
-   * May return undefined when the theme isn't preloaded.
-   * See {@link ThemeBlockSchema} for more information
-   */
-  getBlockSchema?: (name: string) => Promise<ThemeBlockSchema | undefined>;
-
-  /**
-   * Asynchronously get the section schema for 'section/${name}.liquid'
-   * May return undefined when the theme isn't preloaded or if there are none.
-   * See {@link SectionSchema} for more information
-   */
-  getSectionSchema?: (name: string) => Promise<SectionSchema | undefined>;
-
-  /**
-   * (In theme app extension mode)
-   * Asynchronously get the block schema for 'blocks/${name}.liquid'
-   * May return undefined when the theme isn't preloaded.
-   * See {@link AppBlockSchema} for more information
-   */
-  getAppBlockSchema?: (name: string) => Promise<AppBlockSchema | undefined>;
-
   /**
    * Asynchronously get the Liquid HTML AST for a file.
-   * May return undefined when the theme isn't preloaded.
+   * May return undefined when the app isn't preloaded.
    *
-   * Used in theme-checks for cross-file checks rather that going through fs.
+   * Used in checks for cross-file checks rather than going through fs.
    */
   getDocDefinition?: (relativePath: string) => Promise<DocDefinition | undefined>;
 
@@ -436,10 +368,7 @@ export interface AugmentedDependencies extends Dependencies {
   fileExists: (uri: UriString) => Promise<boolean>;
   fileSize: (uri: UriString) => Promise<number>;
   getDefaultLocale: () => Promise<string>;
-  getDefaultSchemaLocale: () => Promise<string>;
   getDefaultTranslations(): Promise<Translations>;
-  getDefaultSchemaTranslations(): Promise<Translations>;
-  mode: Mode;
 }
 
 type StaticContextProperties<T extends SourceCodeType> = T extends SourceCodeType
@@ -461,6 +390,7 @@ export type Corrector<T extends SourceCodeType> = T extends SourceCodeType
       [SourceCodeType.JSON]: JSONCorrector;
       [SourceCodeType.LiquidHtml]: StringCorrector;
       [SourceCodeType.GraphQL]: GraphQLCorrector;
+      [SourceCodeType.YAML]: StringCorrector; // no YAML autofix yet; StringCorrector as placeholder
     }[T]
   : never;
 
@@ -613,5 +543,4 @@ export enum Severity {
 export enum ConfigTarget {
   All = 'all',
   Recommended = 'recommended',
-  ThemeAppExtension = 'theme-app-extension',
 }

package/src/utils/index.ts

@@ -5,4 +5,3 @@ export * from './error';
 export * from './types';
 export * from './memo';
 export * from './indexBy';
-export * from './block';