@platformos/platformos-check-common 0.0.7 → 0.0.9

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

@@ -1,400 +1,233 @@
 import { expect, describe, it } from 'vitest';
-import { autofix, check, highlightedOffenses } from '../../test';
+import { check } from '../../test';
 import { MatchingTranslations } from '../../checks/matching-translations/index';
 
-const prettyJSON = (json: any) => JSON.stringify(json, null, 2);
-
 describe('Module: MatchingTranslations', async () => {
   it('should report offenses when the translation file is missing a key', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-          world: 'World',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(1);
-      expect(offenses).to.containOffense("The translation for 'world' is missing");
-    }
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n  world: World\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+
+    expect(offenses).to.be.of.length(1);
+    expect(offenses).to.containOffense("The translation for 'world' is missing");
   });
 
   it('should report offenses when the default translation is missing a key', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-          world: 'Mundo',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(1);
-      expect(offenses).to.containOffense("A default translation for 'world' does not exist");
-      expect(offenses[0]!).to.suggest(
-        theme[`locales/pt-BR${prefix}.json`],
-        'Delete unneeded translation key',
-        {
-          startIndex: 0,
-          endIndex: theme[`locales/pt-BR${prefix}.json`].length,
-          insert: prettyJSON({
-            hello: 'Olá',
-          }),
-        },
-      );
-    }
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n  world: Mundo\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+
+    expect(offenses).to.be.of.length(1);
+    expect(offenses).to.containOffense("A translation for 'world' does not exist in the en locale");
   });
 
   it('should report offenses when nested translation keys do not exist', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!' },
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: {},
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(1);
-      expect(offenses).to.containOffense({
-        message: "The translation for 'hello.world' is missing",
-        uri: `file:///locales/pt-BR${prefix}.json`,
-      });
-
-      const fixed = await autofix(theme, offenses);
-      expect(fixed[`locales/pt-BR${prefix}.json`]).to.eql(
-        prettyJSON({
-          hello: {
-            world: 'TODO',
-          },
-        }),
-      );
-    }
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello:\n    world: Hello, world!\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: {}\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+
+    expect(offenses).to.be.of.length(1);
+    expect(offenses).to.containOffense({
+      message: "The translation for 'hello.world' is missing",
+      uri: `file:///app/translations/pt-BR.yml`,
+    });
   });
 
   it('should report offenses when translation shapes do not match', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!' },
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(2);
-      expect(offenses).to.containOffense({
-        message: "A default translation for 'hello' does not exist",
-        uri: `file:///locales/pt-BR${prefix}.json`,
-      });
-      expect(offenses).to.containOffense({
-        message: "The translation for 'hello.world' is missing",
-        uri: `file:///locales/pt-BR${prefix}.json`,
-      });
-
-      const fixed = await autofix(theme, offenses);
-
-      expect(fixed[`locales/pt-BR${prefix}.json`]).to.eql(
-        prettyJSON({
-          hello: { world: 'TODO' },
-        }),
-      );
-    }
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello:\n    world: Hello, world!\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+
+    expect(offenses).to.be.of.length(2);
+    expect(offenses).to.containOffense({
+      message: "A translation for 'hello' does not exist in the en locale",
+      uri: `file:///app/translations/pt-BR.yml`,
+    });
+    expect(offenses).to.containOffense({
+      message: "The translation for 'hello.world' is missing",
+      uri: `file:///app/translations/pt-BR.yml`,
+    });
   });
 
   it('should report offenses when nested translation keys do not match', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!' },
-        }),
-        [`locales/fr${prefix}.json`]: JSON.stringify({
-          hello: { monde: 'Bonjour, monde' },
-        }),
-        [`locales/es-ES${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!', mundo: { hola: '¡Hola, mundo!' } },
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(3);
-      expect(offenses).to.containOffense({
-        message: "A default translation for 'hello.monde' does not exist",
-        uri: `file:///locales/fr${prefix}.json`,
-      });
-      expect(offenses).to.containOffense({
-        message: "A default translation for 'hello.mundo.hola' does not exist",
-        uri: `file:///locales/es-ES${prefix}.json`,
-      });
-      expect(offenses).to.containOffense({
-        message: "The translation for 'hello.world' is missing",
-        uri: `file:///locales/fr${prefix}.json`,
-      });
-
-      const fixed = await autofix(theme, offenses);
-      expect(fixed[`locales/fr${prefix}.json`]).to.eql(
-        prettyJSON({
-          hello: { monde: 'Bonjour, monde', world: 'TODO' },
-        }),
-      );
-
-      // Default does not exist should be a suggestion and not autofixed.
-      expect(fixed[`locales/es-ES${prefix}.json`]).to.eql(theme[`locales/es-ES${prefix}.json`]);
-    }
-  });
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello:\n    world: Hello, world!\n',
+      'app/translations/fr.yml': 'fr:\n  hello:\n    monde: Bonjour, monde\n',
+      'app/translations/es-ES.yml':
+        'es-ES:\n  hello:\n    world: Hello, world!\n    mundo:\n      hola: "¡Hola, mundo!"\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+
+    expect(offenses).to.be.of.length(3);
+    expect(offenses).to.containOffense({
+      message: "A translation for 'hello.monde' does not exist in the en locale",
+      uri: `file:///app/translations/fr.yml`,
+    });
+    expect(offenses).to.containOffense({
+      message: "A translation for 'hello.mundo.hola' does not exist in the en locale",
+      uri: `file:///app/translations/es-ES.yml`,
+    });
+    expect(offenses).to.containOffense({
+      message: "The translation for 'hello.world' is missing",
+      uri: `file:///app/translations/fr.yml`,
+    });
+  });
+
+  it('should not report offenses when default translations do not exist (no en.yml)', async () => {
+    const app = {
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
 
-  it('should not report offenses when default translations do not exist', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(0);
-    }
+    expect(offenses).to.be.of.length(0);
   });
 
   it('should not report offenses when translations match', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-          world: 'World',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-          world: 'Mundo',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(0);
-    }
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n  world: World\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n  world: Mundo\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+
+    expect(offenses).to.be.of.length(0);
   });
 
   it('should not report offenses when nested translations match', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!' },
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Olá, mundo!' },
-        }),
-        [`locales/fr${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Bonjour, monde' },
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(0);
-    }
-  });
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello:\n    world: Hello, world!\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello:\n    world: Olá, mundo!\n',
+      'app/translations/fr.yml': 'fr:\n  hello:\n    world: Bonjour, monde\n',
+    };
 
-  it('should not report offenses and ignore pluralization', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: {
-            one: 'Hello, you',
-            other: "Hello, y'all",
-          },
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: {
-            zero: 'Estou sozinho :(',
-            few: 'Olá, galerinha :)',
-          },
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(0);
-    }
-  });
+    const offenses = await check(app, [MatchingTranslations]);
 
-  it('should not report offenses and ignore keys provided by Shopify', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-          shopify: {
-            checkout: {
-              general: {
-                page_title: 'Checkout',
-              },
-            },
-          },
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-          shopify: {
-            sentence: {
-              words_connector: 'hello world',
-            },
-          },
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-
-      expect(offenses).to.be.of.length(0);
-    }
+    expect(offenses).to.be.of.length(0);
   });
 
-  it('should not report offenses and ignore "*.schema.json" files', async () => {
-    const theme = {
-      'locales/en.default.json': JSON.stringify({ hello: 'Hello' }),
-      'locales/pt-BR.schema.json': JSON.stringify({}),
+  it('should not report offenses and ignore pluralization', async () => {
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello:\n    one: Hello, you\n    other: "Hello, y\'all"\n',
+      'app/translations/pt-BR.yml':
+        'pt-BR:\n  hello:\n    zero: Estou sozinho :(\n    few: "Olá, galerinha :)"\n',
     };
 
-    const offenses = await check(theme, [MatchingTranslations]);
+    const offenses = await check(app, [MatchingTranslations]);
 
     expect(offenses).to.be.of.length(0);
   });
 
-  it('should highlight the proper element when the translation file is missing a key', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-          world: 'World',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-      const elements = highlightedOffenses(theme, offenses);
-
-      expect(elements).to.deep.eq(['{"hello":"Olá"}']);
-    }
+  it('should not highlight anything if the file is unparseable', async () => {
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello:\n    world: Hello, world!\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: :\n  bad yaml',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(0);
   });
 
-  it('should highlight the proper element when the default translation is missing a key', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: 'Hello',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-          world: 'Mundo',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-      const elements = highlightedOffenses(theme, offenses);
-
-      expect(elements).to.deep.eq(['"world":"Mundo"']);
-    }
+  // --- Multi-file / multi-scope tests ---
+
+  it('should not flag keys from a different translation scope (module vs app)', async () => {
+    // Module translations are auto-prefixed with their module name at runtime, so each
+    // module is its own isolated scope. The app scope should never need keys from
+    // modules/common-styling/public/translations/en.yml.
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n',
+      'modules/common-styling/public/translations/en.yml':
+        'en:\n  password:\n    toggle_visibility: Toggle\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(0);
   });
 
-  it('should highlight the proper element when nested translation keys do not exist', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: {
-            world: 'Hello, world!',
-          },
-          welcome: 'Welcome',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: {},
-          welcome: 'Bem-vinda',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-      const elements = highlightedOffenses(theme, offenses);
-
-      expect(elements).to.deep.eq(['"hello":{}']);
-    }
+  it('should report missing keys in a module non-en file against that module own en translations', async () => {
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n',
+      'modules/common-styling/public/translations/en.yml':
+        'en:\n  password:\n    toggle_visibility: Toggle\n',
+      'modules/common-styling/public/translations/pt-BR.yml': 'pt-BR:\n  other: Outro\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(1);
+    expect(offenses).to.containOffense({
+      message: "The translation for 'password.toggle_visibility' is missing",
+      uri: 'file:///modules/common-styling/public/translations/pt-BR.yml',
+    });
   });
 
-  it('should highlight the proper element when nested translation keys do not exist and there is a sibling node', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: {
-            shopify: 'Shopify!',
-            world: 'Hello, world!',
-          },
-          welcome: 'Welcome',
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: {
-            shopify: 'Shopify!',
-          },
-          welcome: 'Bem-vinda',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-      const elements = highlightedOffenses(theme, offenses);
-
-      expect(elements).to.deep.eq(['"hello":{"shopify":"Shopify!"}']);
-    }
+  it('should skip files inside the en/ locale sub-directory (they are English source files)', async () => {
+    // Files like app/translations/en/validation.yml are English — the check must not
+    // lint them as if they were a "non-English" locale file to compare.
+    const app = {
+      'app/translations/en/validation.yml': 'en:\n  required: Required\n',
+      'app/translations/pt-BR/validation.yml': 'pt-BR:\n  required: Obrigatório\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(0);
   });
 
-  it('should highlight the proper element when translation shapes do not match', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!' },
-        }),
-        [`locales/pt-BR${prefix}.json`]: JSON.stringify({
-          hello: 'Olá',
-        }),
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-      const elements = highlightedOffenses(theme, offenses);
-
-      // We have two elements because we have two offenses:
-      // - A default translation for 'hello' does not exist"
-      // - The translation for 'hello.world' is missing"
-      expect(elements).to.deep.eq(['"hello":"Olá"', '"hello":"Olá"']);
-    }
+  it('should aggregate multiple en/*.yml files within one scope as the reference set', async () => {
+    // Within the app scope, en/auth.yml and en/checkout.yml both contribute to the
+    // reference; pt-BR.yml must cover all of them.
+    const app = {
+      'app/translations/en/auth.yml': 'en:\n  login: Log in\n',
+      'app/translations/en/checkout.yml': 'en:\n  submit: Submit\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  login: Entrar\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(1);
+    expect(offenses).to.containOffense({
+      message: "The translation for 'submit' is missing",
+      uri: 'file:///app/translations/pt-BR.yml',
+    });
   });
 
-  it('should not highlight anything if the file is unparseable', async () => {
-    for (const prefix of ['', '.schema']) {
-      const theme = {
-        [`locales/en.default${prefix}.json`]: JSON.stringify({
-          hello: { world: 'Hello, world!' },
-        }),
-        [`locales/pt-BR${prefix}.json`]: `{"hello": }`,
-      };
-
-      const offenses = await check(theme, [MatchingTranslations]);
-      expect(offenses).to.have.length(0);
-    }
+  it('should aggregate en.yml and en/*.yml together as the scope reference set', async () => {
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n',
+      'app/translations/en/auth.yml': 'en:\n  login: Log in\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(1);
+    expect(offenses).to.containOffense({
+      message: "The translation for 'login' is missing",
+      uri: 'file:///app/translations/pt-BR.yml',
+    });
+  });
+
+  it('should not report a key as missing if it is covered by another file in the same locale scope', async () => {
+    // pt-BR/validation.yml covers 'required' — pt-BR.yml should not be blamed for it
+    const app = {
+      'app/translations/en.yml': 'en:\n  hello: Hello\n',
+      'app/translations/en/validation.yml': 'en:\n  required: Required\n',
+      'app/translations/pt-BR.yml': 'pt-BR:\n  hello: Olá\n',
+      'app/translations/pt-BR/validation.yml': 'pt-BR:\n  required: Obrigatório\n',
+    };
+
+    const offenses = await check(app, [MatchingTranslations]);
+    expect(offenses).to.have.length(0);
   });
 });