@platformos/platformos-check-common 0.0.7 → 0.0.9

package/src/checks/valid-html-translation/index.spec.ts

@@ -1,73 +1,83 @@
 import { ValidHTMLTranslation } from './index';
-import { highlightedOffenses, runJSONCheck } from '../../test';
+import { highlightedOffenses, runYAMLCheck } from '../../test';
 import { expect, describe, it } from 'vitest';
 
 describe('Module: ValidHTMLTranslation', () => {
   it('should not report valid HTML in translations', async () => {
-    const sourceCode = JSON.stringify({
-      hello_html: '<h1>Hello, world</h1>',
-      image_html: "<img src='spongebob.png'>",
-      line_break_html: '<br>',
-      self_closing_svg_html: '<svg />',
-      foo: 'bar',
-    });
+    const sourceCode = [
+      'en:',
+      '  hello_html: "<h1>Hello, world</h1>"',
+      '  image_html: "<img src=\'spongebob.png\'>"',
+      '  line_break_html: "<br>"',
+      '  self_closing_svg_html: "<svg />"',
+      '  foo: bar',
+    ].join('\n');
 
-    const offenses = await runJSONCheck(ValidHTMLTranslation, sourceCode, 'locales/en.json');
+    const offenses = await runYAMLCheck(
+      ValidHTMLTranslation,
+      sourceCode,
+      'app/translations/en.yml',
+    );
     expect(offenses).toHaveLength(0);
   });
 
   it('should report invalid HTML in translations', async () => {
-    const sourceCode = JSON.stringify({
-      hello_html: '<h1>Hello, world',
-    });
+    const sourceCode = 'en:\n  hello_html: "<h1>Hello, world"';
 
-    const offenses = await runJSONCheck(ValidHTMLTranslation, sourceCode, 'locales/en.json');
+    const offenses = await runYAMLCheck(
+      ValidHTMLTranslation,
+      sourceCode,
+      'app/translations/en.yml',
+    );
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).to.equal(
       "LiquidHTMLParsingError: Attempting to end parsing before HtmlElement 'h1' was closed.",
     );
 
-    const highlights = highlightedOffenses({ 'locales/en.json': sourceCode }, offenses);
+    const highlights = highlightedOffenses({ 'app/translations/en.yml': sourceCode }, offenses);
     expect(highlights).toHaveLength(1);
     expect(highlights[0]).to.equal(`"<h1>Hello, world"`);
   });
 
   it('should report nested invalid HTML in translations', async () => {
-    const sourceCode = JSON.stringify({
-      hello: {
-        world: {
-          today: {
-            good: {
-              day_html: '<h1>Hello, world',
-            },
-          },
-        },
-      },
-    });
+    const sourceCode = [
+      'en:',
+      '  hello:',
+      '    world:',
+      '      today:',
+      '        good:',
+      '          day_html: "<h1>Hello, world"',
+    ].join('\n');
 
-    const offenses = await runJSONCheck(ValidHTMLTranslation, sourceCode, 'locales/en.json');
+    const offenses = await runYAMLCheck(
+      ValidHTMLTranslation,
+      sourceCode,
+      'app/translations/en.yml',
+    );
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).to.equal(
       "LiquidHTMLParsingError: Attempting to end parsing before HtmlElement 'h1' was closed.",
     );
 
-    const highlights = highlightedOffenses({ 'locales/en.json': sourceCode }, offenses);
+    const highlights = highlightedOffenses({ 'app/translations/en.yml': sourceCode }, offenses);
     expect(highlights).toHaveLength(1);
     expect(highlights[0]).to.equal(`"<h1>Hello, world"`);
   });
 
   it('should report pluralized key with invalid HTML', async () => {
-    const sourceCode = JSON.stringify({
-      hello_html: { one: '<h1>Hello, world' },
-    });
+    const sourceCode = 'en:\n  hello_html:\n    one: "<h1>Hello, world"';
 
-    const offenses = await runJSONCheck(ValidHTMLTranslation, sourceCode, 'locales/en.json');
+    const offenses = await runYAMLCheck(
+      ValidHTMLTranslation,
+      sourceCode,
+      'app/translations/en.yml',
+    );
     expect(offenses).toHaveLength(1);
     expect(offenses[0].message).to.equal(
       "LiquidHTMLParsingError: Attempting to end parsing before HtmlElement 'h1' was closed.",
     );
 
-    const highlights = highlightedOffenses({ 'locales/en.json': sourceCode }, offenses);
+    const highlights = highlightedOffenses({ 'app/translations/en.yml': sourceCode }, offenses);
     expect(highlights).toHaveLength(1);
     expect(highlights[0]).to.equal(`"<h1>Hello, world"`);
   });

package/src/checks/valid-html-translation/index.ts

@@ -1,25 +1,25 @@
-import { SourceCodeType, JSONCheckDefinition, Severity, Problem, LiteralNode } from '../../types';
+import { SourceCodeType, YAMLCheckDefinition, Severity, Problem, LiteralNode } from '../../types';
 import { toLiquidHtmlAST } from '@platformos/liquid-html-parser';
 
-export const ValidHTMLTranslation: JSONCheckDefinition = {
+export const ValidHTMLTranslation: YAMLCheckDefinition = {
   meta: {
     code: 'ValidHTMLTranslation',
     name: 'Valid HTML Translation',
     docs: {
       description: 'This check exists to prevent invalid HTML inside translations.',
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/valid-html-translation',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/valid-html-translation',
       recommended: true,
     },
-    type: SourceCodeType.JSON,
+    type: SourceCodeType.YAML,
     severity: Severity.WARNING,
     schema: {},
     targets: [],
   },
 
   create(context) {
-    // We ignore non-`locales/` json files.
+    // We ignore yaml files that aren't translation files.
     const relativePath = context.toRelativePath(context.file.uri);
-    if (!relativePath.startsWith('locales/')) return {};
+    if (!relativePath.includes('/translations/')) return {};
 
     return {
       async Literal(node: LiteralNode) {
@@ -32,7 +32,7 @@ export const ValidHTMLTranslation: JSONCheckDefinition = {
         } catch (error) {
           const loc = node.loc;
 
-          const problem: Problem<SourceCodeType.JSON> = {
+          const problem: Problem<SourceCodeType.YAML> = {
             message: `${error}.`,
             startIndex: loc.start.offset,
             endIndex: loc.end.offset,

package/src/checks/valid-json/index.ts

@@ -7,9 +7,9 @@ export const ValidJSON: JSONCheckDefinition = {
     name: 'Enforce valid JSON',
     docs: {
       description:
-        'This check exists to prevent invalid JSON files in themes. Will check against schema if available.',
+        'This check exists to prevent invalid JSON files in apps. Will check against schema if available.',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/json-syntax-error',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/json-syntax-error',
     },
     type: SourceCodeType.JSON,
     severity: Severity.ERROR,

package/src/checks/valid-render-partial-argument-types/index.spec.ts

@@ -41,7 +41,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
 
     for (const test of typeTests) {
       describe(`${test.type} validation`, () => {
-        const makeSnippet = (type: string) => `
+        const makePartial = (type: string) => `
           {% doc %}
             @param {${type}} param - Description
           {% enddoc %}
@@ -57,7 +57,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
               undefined,
               {},
               {
-                'app/views/partials/card.liquid': makeSnippet(test.type),
+                'app/views/partials/card.liquid': makePartial(test.type),
               },
             );
             expect(offenses).toHaveLength(0);
@@ -73,7 +73,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
               undefined,
               {},
               {
-                'app/views/partials/card.liquid': makeSnippet(test.type),
+                'app/views/partials/card.liquid': makePartial(test.type),
               },
             );
             expect(offenses).toHaveLength(1);
@@ -226,7 +226,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
   });
 
   describe('suggestions', () => {
-    const makeSnippet = (type: string) => `
+    const makePartial = (type: string) => `
       {% doc %}
         @param {${type}} param - Description
       {% enddoc %}
@@ -241,7 +241,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -291,7 +291,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -338,7 +338,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -356,7 +356,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -376,7 +376,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -396,7 +396,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -414,7 +414,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('object'),
+          'app/views/partials/card.liquid': makePartial('object'),
         },
       );
 
@@ -431,7 +431,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 
@@ -452,7 +452,7 @@ describe('Module: ValidRenderPartialParamTypes', () => {
         undefined,
         {},
         {
-          'app/views/partials/card.liquid': makeSnippet('string'),
+          'app/views/partials/card.liquid': makePartial('string'),
         },
       );
 

package/src/checks/valid-render-partial-argument-types/index.ts

@@ -19,7 +19,7 @@ export const ValidRenderPartialArgumentTypes: LiquidCheckDefinition = {
       description:
         'This check ensures that arguments passed to partial match the expected types defined in the liquidDoc header if present.',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/valid-render-partial-argument-types',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/valid-render-partial-argument-types',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.WARNING,
@@ -72,10 +72,7 @@ export const ValidRenderPartialArgumentTypes: LiquidCheckDefinition = {
 
         if (!partialName) return;
 
-        const liquidDocParameters = await getLiquidDocParams(
-          context,
-          `app/views/partials/${partialName}.liquid`,
-        );
+        const liquidDocParameters = await getLiquidDocParams(context, partialName);
 
         if (!liquidDocParameters) return;
 

package/src/checks/variable-name/index.ts

@@ -48,7 +48,7 @@ export const VariableName: LiquidCheckDefinition<typeof schema> = {
     name: 'Invalid variable naming format',
     docs: {
       description: 'This check is aimed at using certain variable naming conventions',
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/variable-name',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/variable-name',
       recommended: true,
     },
     type: SourceCodeType.LiquidHtml,

package/src/context-utils.spec.ts

@@ -1,103 +1,75 @@
 import { beforeEach, describe, expect, it } from 'vitest';
-import {
-  makeGetDefaultLocale,
-  makeGetDefaultTranslations,
-  makeGetMetafieldDefinitions,
-} from './context-utils';
+import { makeGetDefaultLocale, makeGetDefaultTranslations } from './context-utils';
 import { MockFileSystem } from './test';
 import { AbstractFileSystem } from '@platformos/platformos-common';
 
 describe('Unit: getDefaultLocale', () => {
-  let fs: AbstractFileSystem;
-  beforeEach(() => {
-    fs = new MockFileSystem(
+  it('should always return en (en.yml is the reference locale file)', async () => {
+    const fs: AbstractFileSystem = new MockFileSystem(
       {
-        'gitRootTheme/locales/en.default.json': JSON.stringify({ beverage: 'coffee' }),
-        'gitRootTheme/locales/fr.json': JSON.stringify({ beverage: 'coffee' }),
-        'gitRootTheme/snippet/foo.liquid': JSON.stringify({ beverage: 'coffee' }),
-        'frenchDefault/locales/fr.default.json': JSON.stringify({ beverage: 'café' }),
-        'frenchDefault/snippet/foo.liquid': JSON.stringify({ beverage: 'coffee' }),
-        '.shopify/metafields.json': JSON.stringify({
-          product: [
-            {
-              key: 'color',
-              name: 'color',
-              namespace: 'custom',
-              description: 'the color of the product',
-              type: {
-                category: 'COLOR',
-                name: 'color',
-              },
-            },
-          ],
-        }),
+        'app/translations/en.yml': 'en:\n  beverage: coffee\n',
+        'app/translations/fr.yml': 'fr:\n  beverage: café\n',
       },
-      'shopify-vfs:/',
+      'platformos-vfs:/',
     );
-  });
 
-  it('should return the correct translations depending on the root', async () => {
-    let getDefaultLocale = makeGetDefaultLocale(fs, 'shopify-vfs:/gitRootTheme');
+    const getDefaultLocale = makeGetDefaultLocale(fs, 'platformos-vfs:/');
     expect(await getDefaultLocale()).to.eql('en');
-
-    getDefaultLocale = makeGetDefaultLocale(fs, 'shopify-vfs:/frenchDefault');
-    expect(await getDefaultLocale()).to.eql('fr');
   });
 
-  describe('Unit: makeGetMetafieldDefinitions', () => {
-    it('should return metafield definitions in correct format', async () => {
-      const getMetafieldDefinitions = makeGetMetafieldDefinitions(fs);
-
-      let definitions = await getMetafieldDefinitions('shopify-vfs:/');
+  it('should return en even when no translation files exist', async () => {
+    const fs: AbstractFileSystem = new MockFileSystem({}, 'platformos-vfs:/');
+    const getDefaultLocale = makeGetDefaultLocale(fs, 'platformos-vfs:/');
+    expect(await getDefaultLocale()).to.eql('en');
+  });
 
-      expect(definitions.product).toHaveLength(1);
-      expect(definitions.product[0]).deep.equals({
-        key: 'color',
-        name: 'color',
-        namespace: 'custom',
-        description: 'the color of the product',
-        type: {
-          category: 'COLOR',
-          name: 'color',
+  describe('Unit: getDefaultTranslationsFactory', () => {
+    it('should return translations from en.yml stripped of the locale prefix', async () => {
+      const fs: AbstractFileSystem = new MockFileSystem(
+        {
+          'app/translations/en.yml': 'en:\n  beverage: coffee\n',
+          'app/translations/fr.yml': 'fr:\n  beverage: café\n',
         },
-      });
+        'platformos-vfs:/',
+      );
+
+      const getDefaultTranslations = makeGetDefaultTranslations(fs, [], 'platformos-vfs:/');
+      expect(await getDefaultTranslations()).to.eql({ beverage: 'coffee' });
     });
 
-    it("should return no metafield definitions if file isn't in correct format", async () => {
-      fs = new MockFileSystem(
+    it('should return empty object when no en.yml exists', async () => {
+      const fs: AbstractFileSystem = new MockFileSystem(
         {
-          '.shopify/metafields.json': JSON.stringify('uhoh'),
+          'app/translations/fr.yml': 'fr:\n  beverage: café\n',
         },
-        'shopify-vfs:/',
+        'platformos-vfs:/',
       );
-      const getMetafieldDefinitions = makeGetMetafieldDefinitions(fs);
 
-      let definitions = await getMetafieldDefinitions('shopify-vfs:/');
-
-      expect(definitions).deep.equals({
-        article: [],
-        blog: [],
-        collection: [],
-        company: [],
-        company_location: [],
-        location: [],
-        market: [],
-        order: [],
-        page: [],
-        product: [],
-        variant: [],
-        shop: [],
-      });
+      const getDefaultTranslations = makeGetDefaultTranslations(fs, [], 'platformos-vfs:/');
+      expect(await getDefaultTranslations()).to.eql({});
     });
-  });
 
-  describe('Unit: getDefaultTranslationsFactory', () => {
-    it('should return the correct translations depending on the root', async () => {
-      let getDefaultTranslations = makeGetDefaultTranslations(fs, [], 'shopify-vfs:/gitRootTheme');
-      expect(await getDefaultTranslations()).to.eql({ beverage: 'coffee' });
+    it('should prefer translations from the in-memory app buffer over the filesystem', async () => {
+      const fs: AbstractFileSystem = new MockFileSystem(
+        {
+          'app/translations/en.yml': 'en:\n  beverage: coffee\n',
+        },
+        'platformos-vfs:/',
+      );
 
-      getDefaultTranslations = makeGetDefaultTranslations(fs, [], 'shopify-vfs:/frenchDefault');
-      expect(await getDefaultTranslations()).to.eql({ beverage: 'café' });
+      // Simulate an open buffer with different content
+      const { toSourceCode } = await import('./to-source-code');
+      const bufferedSourceCode = toSourceCode(
+        'platformos-vfs:/app/translations/en.yml',
+        'en:\n  beverage: tea\n',
+      );
+
+      const getDefaultTranslations = makeGetDefaultTranslations(
+        fs,
+        [bufferedSourceCode],
+        'platformos-vfs:/',
+      );
+      expect(await getDefaultTranslations()).to.eql({ beverage: 'tea' });
     });
   });
 });