Merge pull request #546 from flixlix/test-18n-keys-equal

Test 18n keys equal

.github/workflows/code-test.yaml

@@ -0,0 +1,35 @@
+name: Code Test
+on:
+  push:
+    branches:
+      - '*'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Cache pnpm modules
+        id: cache-modules
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.pnpm-store
+            **/node_modules
+          key: ${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml', 'rollup.config.js') }}
+          restore-keys: |
+            ${{ runner.os }}-
+
+      - name: Setup pnpm
+        uses: pnpm/[email protected]
+        with:
+          version: latest
+          run_install: false
+
+      - name: Install Packages
+        if: steps.cache-modules.outputs.cache-hit != 'true'
+        run: pnpm install --no-frozen-lockfile
+
+      - name: Test
+        run: pnpm test

__tests__/i18n.test.ts

@@ -0,0 +1,89 @@
+import { describe, expect, test } from "@jest/globals";
+
+import en from "../src/localize/languages/en.json";
+
+import cs from "../src/localize/languages/cs.json";
+import de from "../src/localize/languages/de.json";
+import dk from "../src/localize/languages/dk.json";
+import es from "../src/localize/languages/es.json";
+import fi from "../src/localize/languages/fi.json";
+import fr from "../src/localize/languages/fr.json";
+import it from "../src/localize/languages/it.json";
+import nl from "../src/localize/languages/nl.json";
+import pl from "../src/localize/languages/pl.json";
+import ptBR from "../src/localize/languages/pt-BR.json";
+import pt from "../src/localize/languages/pt-PT.json";
+import ru from "../src/localize/languages/ru.json";
+import sk from "../src/localize/languages/sk.json";
+
+function getAllKeys(obj: { [key: string]: any }): string[] {
+  let keys: string[] = [];
+
+  for (const key in obj) {
+    if (obj.hasOwnProperty(key)) {
+      keys.push(key);
+      if (typeof obj[key] === "object") {
+        const nestedKeys = getAllKeys(obj[key]);
+        keys = keys.concat(nestedKeys.map((nestedKey) => `${key}.${nestedKey}`));
+      }
+    }
+  }
+
+  return keys;
+}
+
+describe("Language files", () => {
+  const enKeys = getAllKeys(en);
+  test("cs.json should have the same properties as en.json", () => {
+    const csKeys = getAllKeys(cs);
+    expect(csKeys).toEqual(enKeys);
+  });
+  test("de.json should have the same properties as en.json", () => {
+    const deKeys = getAllKeys(de);
+    expect(deKeys).toEqual(enKeys);
+  });
+  test("dk.json should have the same properties as en.json", () => {
+    const dkKeys = getAllKeys(dk);
+    expect(dkKeys).toEqual(enKeys);
+  });
+  test("es.json should have the same properties as en.json", () => {
+    const esKeys = getAllKeys(es);
+    expect(esKeys).toEqual(enKeys);
+  });
+  test("fi.json should have the same properties as en.json", () => {
+    const fiKeys = getAllKeys(fi);
+    expect(fiKeys).toEqual(enKeys);
+  });
+  test("fr.json should have the same properties as en.json", () => {
+    const frKeys = getAllKeys(fr);
+    expect(frKeys).toEqual(enKeys);
+  });
+  test("it.json should have the same properties as en.json", () => {
+    const itKeys = getAllKeys(it);
+    expect(itKeys).toEqual(enKeys);
+  });
+  test("nl.json should have the same properties as en.json", () => {
+    const nlKeys = getAllKeys(nl);
+    expect(nlKeys).toEqual(enKeys);
+  });
+  test("pl.json should have the same properties as en.json", () => {
+    const plKeys = getAllKeys(pl);
+    expect(plKeys).toEqual(enKeys);
+  });
+  test("pt-BR.json should have the same properties as en.json", () => {
+    const ptBRKeys = getAllKeys(ptBR);
+    expect(ptBRKeys).toEqual(enKeys);
+  });
+  test("pt-PT.json should have the same properties as en.json", () => {
+    const ptKeys = getAllKeys(pt);
+    expect(ptKeys).toEqual(enKeys);
+  });
+  test("ru.json should have the same properties as en.json", () => {
+    const ruKeys = getAllKeys(ru);
+    expect(ruKeys).toEqual(enKeys);
+  });
+  test("sk.json should have the same properties as en.json", () => {
+    const skKeys = getAllKeys(sk);
+    expect(skKeys).toEqual(enKeys);
+  });
+});

babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+};

jest.config.ts

@@ -0,0 +1,199 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from "jest";
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/_q/7p9yj5qd2d39p_yfjc5kmb8c0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package.json

@@ -29,7 +29,8 @@
     "typecheck": "tsc --noEmit",
     "format:write": "prettier --write \"**/*.{ts,tsx,mdx}\" --cache",
     "format:check": "prettier --check \"**/*.{ts,tsx,mdx}\" --cache",
-    "precommit": "pnpm typecheck && pnpm format:write"
+    "test": "jest",
+    "precommit": "pnpm typecheck && pnpm format:write && pnpm test"
   },
   "dependencies": {
     "@material/mwc-ripple": "^0.19.1",
@@ -45,10 +46,12 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "prettier": "2.8.8",
     "@babel/core": "^7.17.9",
     "@babel/eslint-parser": "^7.17.0",
     "@babel/eslint-plugin": "^7.17.7",
+    "@babel/preset-env": "^7.24.4",
+    "@babel/preset-typescript": "^7.24.1",
+    "@jest/globals": "^29.7.0",
     "@open-wc/eslint-config": "^7.0.0",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^21.1.0",
@@ -65,11 +68,14 @@
     "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-wc": "^1.3.2",
+    "jest": "^29.7.0",
+    "prettier": "2.8.8",
     "rollup": "^2.70.2",
     "rollup-plugin-minify-html-literals": "^1.2.6",
     "rollup-plugin-serve": "^1.1.0",
     "semantic-release": "^20.1.0",
     "semantic-release-replace-plugin": "^1.2.7",
+    "ts-node": "^10.9.2",
     "typescript": "^4.9.5"
   }
 }