@platformos/platformos-check-common 0.0.6 → 0.0.8

package/src/checks/matching-translations/index.ts

@@ -1,7 +1,7 @@
 import {
-  JSONCheckDefinition,
+  YAMLCheckDefinition,
   JSONNode,
-  JSONSourceCode,
+  YAMLSourceCode,
   Severity,
   SourceCodeType,
   PropertyNode,
@@ -9,16 +9,16 @@ import {
 
 const PLURALIZATION_KEYS = new Set(['zero', 'one', 'two', 'few', 'many', 'other']);
 
-export const MatchingTranslations: JSONCheckDefinition = {
+export const MatchingTranslations: YAMLCheckDefinition = {
   meta: {
     code: 'MatchingTranslations',
     name: 'Translation files should have the same keys',
     docs: {
       description: 'TODO',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/matching-translations',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/matching-translations',
     },
-    type: SourceCodeType.JSON,
+    type: SourceCodeType.YAML,
     severity: Severity.ERROR,
     schema: {},
     targets: [],
@@ -29,18 +29,17 @@ export const MatchingTranslations: JSONCheckDefinition = {
     const defaultTranslations = new Set<string>();
     const missingTranslations = new Set<string>();
     const nodesByPath = new Map<string, PropertyNode>();
-    const file = context.file;
+    const file = context.file as YAMLSourceCode;
     const fileUri = file.uri;
     const relativePath = context.toRelativePath(fileUri);
     const ast = file.ast;
-    const isLocaleFile = relativePath.startsWith('locales/');
-    const isDefaultTranslationsFile =
-      fileUri.endsWith('.default.json') || fileUri.endsWith('.default.schema.json');
-    const isSchemaTranslationFile = fileUri.endsWith('.schema.json');
-
-    if (!isLocaleFile || isDefaultTranslationsFile || ast instanceof Error) {
-      // No need to lint a file that isn't a translation file, we return an
-      // empty object as the check for those.
+    const isTranslationFile = relativePath.includes('/translations/');
+    // In platformOS, en.yml is the reference locale; skip running the check on it
+    const basename = fileUri.split('/').pop() ?? '';
+    const isDefaultTranslationsFile = basename.replace(/\.ya?ml$/, '') === 'en';
+
+    if (!isTranslationFile || isDefaultTranslationsFile || ast instanceof Error) {
+      // No need to lint a file that isn't a non-default translation file
       return {};
     }
 
@@ -48,7 +47,6 @@ export const MatchingTranslations: JSONCheckDefinition = {
     const hasDefaultTranslations = () => defaultTranslations.size > 0;
     const isTerminalNode = ({ type }: JSONNode) => type === 'Literal';
     const isPluralizationNode = (node: PropertyNode) => PLURALIZATION_KEYS.has(node.key.value);
-    const isShopifyPath = (path: string) => path.startsWith('shopify.');
 
     const hasDefaultTranslation = (translationPath: string) =>
       defaultTranslations.has(translationPath) ?? false;
@@ -71,10 +69,15 @@ export const MatchingTranslations: JSONCheckDefinition = {
       }, []);
     };
 
+    // Strip the locale prefix (first Property in the ancestors chain).
+    // YAML files wrap content under a locale key: { en: { hello: 'Hello' } }
+    // We want paths like 'hello', not 'en.hello'.
     const objectPath = (nodes: JSONNode[]) => {
-      return nodes
-        .filter((node): node is PropertyNode => node.type === 'Property')
-        .reduce((acc: string[], val) => acc.concat(val.key.value), [])
+      const props = nodes.filter((n): n is PropertyNode => n.type === 'Property');
+      if (props.length <= 1) return ''; // locale key itself, or empty
+      return props
+        .slice(1)
+        .map((p) => p.key.value)
         .join('.');
     };
 
@@ -110,10 +113,7 @@ export const MatchingTranslations: JSONCheckDefinition = {
 
     return {
       async onCodePathStart() {
-        const getDefaultTranslations = isSchemaTranslationFile
-          ? context.getDefaultSchemaTranslations
-          : context.getDefaultTranslations;
-        const defaultTranslationPaths = await getDefaultTranslations().then(jsonPaths);
+        const defaultTranslationPaths = await context.getDefaultTranslations().then(jsonPaths);
         defaultTranslationPaths.forEach(Set.prototype.add, defaultTranslations);
 
         // At the `onCodePathStart`, we assume that all translations are missing,
@@ -124,12 +124,13 @@ export const MatchingTranslations: JSONCheckDefinition = {
       async Property(node, ancestors) {
         const path = objectPath(ancestors.concat(node));
 
+        if (!path) return; // skip the root locale key (e.g. 'pt-BR')
+
         nodesByPath.set(path, node);
 
         if (!hasDefaultTranslations()) return;
         if (isPluralizationNode(node)) return;
         if (!isTerminalNode(node.value)) return;
-        if (isShopifyPath(path)) return;
 
         if (hasDefaultTranslation(path)) {
           // As `path` is present, we remove it from the
@@ -142,14 +143,6 @@ export const MatchingTranslations: JSONCheckDefinition = {
           message: `A default translation for '${path}' does not exist`,
           startIndex: node.loc!.start.offset,
           endIndex: node.loc!.end.offset,
-          suggest: [
-            {
-              message: 'Delete unneeded translation key',
-              fix(corrector) {
-                corrector.remove(path);
-              },
-            },
-          ],
         });
       },
 
@@ -158,15 +151,11 @@ export const MatchingTranslations: JSONCheckDefinition = {
           const closest = closestTranslationKey(path);
 
           if (isPluralizationPath(path)) return;
-          if (isShopifyPath(path)) return;
 
           context.report({
             message: `The translation for '${path}' is missing`,
             startIndex: closest.loc!.start.offset,
             endIndex: closest.loc!.end.offset,
-            fix(corrector) {
-              corrector.add(path, 'TODO');
-            },
           });
         });
       },

package/src/checks/metadata-params/index.ts

@@ -3,7 +3,6 @@ import yaml from 'js-yaml';
 import { DocumentsLocator, DocumentType } from '@platformos/platformos-common';
 import { URI } from 'vscode-uri';
 import { LiquidNamedArgument, Position } from '@platformos/liquid-html-parser';
-import { getLiquidDocParams } from '../../liquid-doc/arguments';
 import { relative } from '../../path';
 
 type Metadata = {
@@ -64,12 +63,11 @@ export const MetadataParamsCheck: LiquidCheckDefinition = {
       }
       let params = extractMetadataParams(await context.fs.readFile(locatedFile));
       if (!params) {
-        const liquidDocParameters = await getLiquidDocParams(
-          context,
-          relative(locatedFile, context.config.rootUri),
-        );
-
-        if (!liquidDocParameters) return;
+        if (!context.getDocDefinition) return;
+        const relativePath = relative(locatedFile, context.config.rootUri);
+        const docDef = await context.getDocDefinition(relativePath);
+        if (!docDef?.liquidDoc?.parameters) return;
+        const liquidDocParameters = new Map(docDef.liquidDoc.parameters.map((p) => [p.name, p]));
 
         params = Array.from(liquidDocParameters.values())
           .filter((p) => p.required)

package/src/checks/missing-asset/index.ts

@@ -11,7 +11,7 @@ export const MissingAsset: LiquidCheckDefinition = {
     docs: {
       description: 'Reports missing asset files',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/missing-asset',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/missing-asset',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.ERROR,

package/src/checks/{missing-template → missing-partial}/index.spec.ts

@@ -1,9 +1,9 @@
 import { expect, describe, it } from 'vitest';
-import { MissingTemplate } from '.';
+import { MissingPartial } from '.';
 import { check } from '../../test';
 
-describe('Module: MissingTemplate', () => {
-  it('should report missing template errors', async () => {
+describe('Module: MissingPartial', () => {
+  it('should report missing partial errors', async () => {
     const testCases = [
       {
         testCase: 'should report the missing partial to be rendered with "render"',
@@ -12,7 +12,7 @@ describe('Module: MissingTemplate', () => {
         {% render myvariable %}
       `,
         expected: {
-          check: 'MissingTemplate',
+          check: 'MissingPartial',
           end: {
             character: 27,
             index: 28,
@@ -49,11 +49,11 @@ describe('Module: MissingTemplate', () => {
       },
     ];
     for (const { testCase, file, expected, filesWith } of testCases) {
-      const offenses = await check(filesWith(file), [MissingTemplate]);
+      const offenses = await check(filesWith(file), [MissingPartial]);
 
       expect(offenses).to.have.length(1);
       expect(offenses, testCase).to.containOffense({
-        check: MissingTemplate.meta.code,
+        check: MissingPartial.meta.code,
         ...expected,
       });
     }

package/src/checks/{missing-template → missing-partial}/index.ts

@@ -1,19 +1,5 @@
-import {
-  LiquidTag,
-  LiquidTagNamed,
-  NamedTags,
-  NodeTypes,
-  Position,
-} from '@platformos/liquid-html-parser';
-import { minimatch } from 'minimatch';
-import {
-  LiquidCheckDefinition,
-  RelativePath,
-  SchemaProp,
-  Severity,
-  SourceCodeType,
-} from '../../types';
-import { doesFileExist } from '../../utils/file-utils';
+import { NodeTypes } from '@platformos/liquid-html-parser';
+import { LiquidCheckDefinition, SchemaProp, Severity, SourceCodeType } from '../../types';
 import { DocumentsLocator } from '@platformos/platformos-common';
 import { URI } from 'vscode-uri';
 
@@ -21,14 +7,14 @@ const schema = {
   ignoreMissing: SchemaProp.array(SchemaProp.string(), []),
 };
 
-export const MissingTemplate: LiquidCheckDefinition<typeof schema> = {
+export const MissingPartial: LiquidCheckDefinition<typeof schema> = {
   meta: {
-    code: 'MissingTemplate',
-    name: 'Avoid rendering missing templates',
+    code: 'MissingPartial',
+    name: 'Avoid rendering missing partials',
     docs: {
       description: 'Reports missing partial liquid file',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/missing-template',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/missing-partial',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.ERROR,

package/src/checks/orphaned-partial/index.ts

@@ -1,4 +1,4 @@
-import { isPartial } from '../../to-schema';
+import { isPartial } from '../../path';
 import { LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
 
 export const OrphanedPartial: LiquidCheckDefinition = {
@@ -6,9 +6,9 @@ export const OrphanedPartial: LiquidCheckDefinition = {
     code: 'OrphanedPartial',
     name: 'Prevent orphaned partials',
     docs: {
-      description: 'This check exists to prevent orphaned partials in themes.',
+      description: 'This check exists to prevent orphaned partials in platformOS apps.',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/orphaned-partial',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/orphaned-partial',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.WARNING,

package/src/checks/parser-blocking-script/index.spec.ts

@@ -3,26 +3,6 @@ import { ParserBlockingScript } from '.';
 import { applySuggestions, check as reportOffenses } from '../../test';
 
 describe('Module: ParserBlockingScript', () => {
-  it('should report the correct offense for the Liquid filter', async () => {
-    const file = "{{ 'asset' | script_tag }}";
-    const startIndex = file.indexOf('script_tag');
-    const endIndex = startIndex + 'script_tag'.length;
-
-    const offenses = await reportOffenses(
-      {
-        'code.liquid': file,
-      },
-      [ParserBlockingScript],
-    );
-
-    expect(offenses).to.have.length(1);
-    const { check, message, start, end } = offenses[0];
-    expect(check).to.equal(ParserBlockingScript.meta.code);
-    expect(message).to.contain('Use a <script> tag with async');
-    expect(start.index).to.equal(startIndex);
-    expect(end.index).to.equal(endIndex);
-  });
-
   it('should report the correct offense when using the script tag', async () => {
     const file = `
         <script src="https://foo.bar/baz.js"></script>
@@ -45,104 +25,6 @@ describe('Module: ParserBlockingScript', () => {
     expect(end.index).to.equal(endIndex);
   });
 
-  describe('Case: LiquidFilter corrections', () => {
-    it('should suggest to replace a LiquidVariableOutput with a script tag that has the expression as URL', async () => {
-      const file = "{{ 'asset' | script_tag }}";
-      const offenses = await reportOffenses(
-        {
-          'code.liquid': file,
-        },
-        [ParserBlockingScript],
-      );
-
-      expect(offenses).to.have.length(1);
-      const offense = offenses[0]!;
-      expect(offense).to.suggest(file, `Use an HTML script tag with the defer attribute instead`, {
-        startIndex: 0,
-        endIndex: file.length,
-        insert: `<script src="{{ 'asset' }}" defer></script>`,
-      });
-      expect(offense).to.suggest(file, `Use an HTML script tag with the async attribute instead`, {
-        startIndex: 0,
-        endIndex: file.length,
-        insert: `<script src="{{ 'asset' }}" async></script>`,
-      });
-
-      const suggestions = applySuggestions(file, offense);
-      expect(suggestions).to.include(`<script src="{{ 'asset' }}" defer></script>`);
-      expect(suggestions).to.include(`<script src="{{ 'asset' }}" async></script>`);
-    });
-
-    it('should suggest to replace a LiquidVariableOutput with a script tag that has the expression and previous filters as URL', async () => {
-      const file = "{{ 'asset' | asset_url | script_tag }}";
-      const offenses = await reportOffenses(
-        {
-          'code.liquid': file,
-        },
-        [ParserBlockingScript],
-      );
-
-      expect(offenses).to.have.length(1);
-      const offense = offenses[0];
-      expect(offense).to.suggest(file, `Use an HTML script tag with the defer attribute instead`, {
-        startIndex: 0,
-        endIndex: file.length,
-        insert: `<script src="{{ 'asset' | asset_url }}" defer></script>`,
-      });
-      expect(offense).to.suggest(file, `Use an HTML script tag with the async attribute instead`, {
-        startIndex: 0,
-        endIndex: file.length,
-        insert: `<script src="{{ 'asset' | asset_url }}" async></script>`,
-      });
-
-      const suggestions = applySuggestions(file, offense);
-      expect(suggestions).to.include(`<script src="{{ 'asset' | asset_url }}" defer></script>`);
-      expect(suggestions).to.include(`<script src="{{ 'asset' | asset_url }}" async></script>`);
-    });
-
-    it('should not suggest anything if the script_tag appears in an echo tag', async () => {
-      const file = "{% echo 'asset' | asset_url | script_tag %}";
-      const offenses = await reportOffenses(
-        {
-          'code.liquid': file,
-        },
-        [ParserBlockingScript],
-      );
-
-      expect(offenses).to.have.length(1);
-      const { suggest } = offenses[0];
-      expect(suggest).not.to.exist;
-    });
-
-    it('should not suggest anything if the script_tag appears in an assign tag', async () => {
-      const file = "{% assign script = 'asset' | asset_url | script_tag %}";
-      const offenses = await reportOffenses(
-        {
-          'code.liquid': file,
-        },
-        [ParserBlockingScript],
-      );
-
-      expect(offenses).to.have.length(1);
-      const { suggest } = offenses[0];
-      expect(suggest).not.to.exist;
-    });
-
-    it('should not suggest anything if the script_tag appears in a liquid tag', async () => {
-      const file = "{% liquid\necho 'asset' | asset_url | script_tag %}";
-      const offenses = await reportOffenses(
-        {
-          'code.liquid': file,
-        },
-        [ParserBlockingScript],
-      );
-
-      expect(offenses).to.have.length(1);
-      const { suggest } = offenses[0];
-      expect(suggest).not.to.exist;
-    });
-  });
-
   describe('Case: script tag suggestion', () => {
     it('should suggest adding both attributes at the end', async () => {
       const file = `<script src="a.js"></script>`;

package/src/checks/parser-blocking-script/index.ts

@@ -1,8 +1,6 @@
-import { NodeTypes } from '@platformos/liquid-html-parser';
 import { LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
-import { last } from '../../utils';
 import { hasAttributeValueOf, isAttr, isHtmlAttribute, isValuedHtmlAttribute } from '../utils';
-import { liquidFilterSuggestion, scriptTagSuggestion } from './suggestions';
+import { scriptTagSuggestion } from './suggestions';
 
 export const ParserBlockingScript: LiquidCheckDefinition = {
   meta: {
@@ -10,9 +8,9 @@ export const ParserBlockingScript: LiquidCheckDefinition = {
     aliases: ['ParserBlockingScriptTag'],
     name: 'Avoid parser blocking scripts',
     docs: {
-      description: 'They are bad ok?',
+      description: 'Parser-blocking scripts delay page rendering by blocking the HTML parser.',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/parser-blocking-javascript',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/parser-blocking-script',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.ERROR,
@@ -22,34 +20,6 @@ export const ParserBlockingScript: LiquidCheckDefinition = {
 
   create(context) {
     return {
-      // {{ 'asset' | asset_url | script_tag }}
-      LiquidFilter: async (node, ancestors) => {
-        if (node.name !== 'script_tag') return;
-
-        const filterString = node.source.slice(node.position.start, node.position.end);
-        const offset = filterString.indexOf('script_tag');
-        const parentNode = last(ancestors);
-        const grandParentNode = last(ancestors, -1);
-
-        context.report({
-          message:
-            'The script_tag filter is parser-blocking. Use a <script> tag with async or defer for better performance',
-          startIndex: node.position.start + offset,
-          endIndex: node.position.end,
-          suggest:
-            grandParentNode &&
-            grandParentNode.type === NodeTypes.LiquidVariableOutput &&
-            parentNode &&
-            parentNode.type === NodeTypes.LiquidVariable &&
-            last(parentNode.filters) === node
-              ? [
-                  liquidFilterSuggestion('defer', node, parentNode, grandParentNode),
-                  liquidFilterSuggestion('async', node, parentNode, grandParentNode),
-                ]
-              : undefined,
-        });
-      },
-
       // <script src="...">
       HtmlRawNode: async (node) => {
         if (node.name !== 'script') {

package/src/checks/parser-blocking-script/suggestions.ts

@@ -1,36 +1,9 @@
-import {
-  HtmlRawNode,
-  LiquidFilter,
-  LiquidVariable,
-  LiquidVariableOutput,
-} from '@platformos/liquid-html-parser';
+import { HtmlRawNode } from '@platformos/liquid-html-parser';
 import { LiquidHtmlSuggestion } from '../../types';
-import { last } from '../../utils';
 
 const suggestionMessage = (attr: 'defer' | 'async') =>
   `Use an HTML script tag with the ${attr} attribute instead`;
 
-export const liquidFilterSuggestion = (
-  attr: 'defer' | 'async',
-  node: LiquidFilter,
-  parentNode: LiquidVariable,
-  grandParentNode: LiquidVariableOutput,
-): LiquidHtmlSuggestion => ({
-  message: suggestionMessage(attr),
-  fix(corrector) {
-    const expression = node.source.slice(
-      parentNode.expression.position.start,
-      last(parentNode.filters, -1)?.position.end ?? node.position.start,
-    );
-    const url = `{{ ${expression} }}`;
-    corrector.replace(
-      grandParentNode.position.start,
-      grandParentNode.position.end,
-      `<script src="${url}" ${attr}></script>`,
-    );
-  },
-});
-
 export const scriptTagSuggestion = (
   attr: 'defer' | 'async',
   node: HtmlRawNode,

package/src/checks/translation-key-exists/index.ts

@@ -25,7 +25,7 @@ export const TranslationKeyExists: LiquidCheckDefinition = {
     docs: {
       description: 'Reports missing translation keys',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/translation-key-exists',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/translation-key-exists',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.ERROR,

package/src/checks/unclosed-html-element/index.ts

@@ -41,7 +41,7 @@ export const UnclosedHTMLElement: LiquidCheckDefinition = {
     docs: {
       description: 'Warns you of unbalanced HTML tags in branching code',
       recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unclosed-html-element',
+      url: 'https://documentation.platformos.com/developer-guide/platformos-check/checks/unclosed-html-element',
     },
     type: SourceCodeType.LiquidHtml,
     severity: Severity.WARNING,
@@ -272,6 +272,10 @@ function getConditionIdentifierForMarkup(condition: string | LiquidConditionalEx
         condition.relation,
         getConditionIdentifierForMarkup(condition.right),
       ].join(' ');
+    case NodeTypes.JsonHashLiteral:
+      return '{}';
+    case NodeTypes.JsonArrayLiteral:
+      return '[]';
     default: {
       return assertNever(condition);
     }