Recognize section-scoped translation keys in TranslationKeyExists

.changeset/section-locales-translation-keys.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme-check-common': patch
+---
+
+Stop `TranslationKeyExists` from reporting `sections.<section-name>.<key>` translations that are defined in the section's own schema `locales`.

packages/theme-check-common/src/checks/translation-key-exists/index.spec.ts

@@ -100,6 +100,57 @@ describe('Module: TranslationKeyExists', () => {
     });
   });
 
+  it('should ignore section-scoped keys included in the section schema', async () => {
+    const offenses = await check(
+      {
+        'locales/en.default.json': '{}',
+        'sections/test-section.liquid': `{{ 'sections.test-section.title' | t }}
+{{ 'sections.test-section.description.desktop' | t }}
+{{ 'sections.test-section.does_not_exist' | t }}
+{% schema %}
+  {
+    "locales": {
+      "en": {
+        "title": "Title",
+        "description": {
+          "desktop": "Lorem ipsum"
+        }
+      }
+    }
+  }
+{% endschema %}`,
+      },
+      [TranslationKeyExists],
+    );
+    expect(offenses).to.have.length(1);
+    expect(offenses).to.containOffense({
+      check: TranslationKeyExists.meta.code,
+      message:
+        "'sections.test-section.does_not_exist' does not have a matching entry in 'locales/en.default.json' or 'sections/test-section.liquid'",
+      uri: 'file:///sections/test-section.liquid',
+    });
+  });
+
+  it('should only resolve section-scoped keys in section files', async () => {
+    const offenses = await check(
+      {
+        'locales/en.default.json': '{}',
+        'snippets/test-section.liquid': `{{ 'sections.test-section.title' | t }}
+{% schema %}
+  {
+    "locales": {
+      "en": {
+        "title": "Title"
+      }
+    }
+  }
+{% endschema %}`,
+      },
+      [TranslationKeyExists],
+    );
+    expect(offenses).to.have.length(1);
+  });
+
   it('should not crash if the schema locales does not exist', async () => {
     const offenses = await check(
       {

packages/theme-check-common/src/checks/translation-key-exists/index.ts

@@ -1,4 +1,6 @@
 import { parseJSON } from '../../json';
+import * as path from '../../path';
+import { isSection } from '../../to-schema';
 import { LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
 import { isError } from '../../utils';
 
@@ -73,10 +75,17 @@ export const TranslationKeyExists: LiquidCheckDefinition = {
 
         if (!defaultTranslations && systemTranslationsKeys.length === 0) return;
 
+        const sectionKeyPrefix = isSection(context.file.uri)
+          ? `sections.${path.basename(context.file.uri, '.liquid')}.`
+          : undefined;
+
         nodes.forEach(({ translationKey, startIndex, endIndex }) => {
           if (
             keyExists(translationKey, defaultTranslations) ||
             keyExists(translationKey, schemaLocales) ||
+            (sectionKeyPrefix !== undefined &&
+              translationKey.startsWith(sectionKeyPrefix) &&
+              keyExists(translationKey.slice(sectionKeyPrefix.length), schemaLocales)) ||
             systemTranslationsKeys.includes(translationKey)
           ) {
             return;