Dictionary data tests + write mode

package.json

@@ -18,6 +18,7 @@
         "test-ts-dev": "npx tsc --noEmit --project dev/jsconfig.json",
         "test-ts-test": "npx tsc --noEmit --project test/jsconfig.json",
         "test-code": "vitest run",
+        "test-code-write": "vitest run --config test/data/vitest.write.config.json",
         "test-build": "node ./dev/bin/build.js --dry-run --all",
         "license-report": "license-report --output=html --only=prod --fields=name --fields=installedVersion --fields=licenseType --fields=link --html.cssFile=dev/data/legal-npm.css > ext/legal-npm.html",
         "license-report-markdown": "license-report --output=markdown --only=prod --fields=name --fields=installedVersion --fields=licenseType --fields=link"

test/data/json.json

@@ -22,6 +22,7 @@
         {"path": "test/data/dictionaries/invalid-dictionary6/term_meta_bank_1.json", "ignore": true},
         {"path": "test/data/dictionaries/invalid-dictionary6/index.json", "ignore": true},
         {"path": "test/jsconfig.json", "ignore": true},
+        {"path": "test/data/vitest.write.config.json", "ignore": true},
 
         {
             "path": "dev/data/manifest-variants.json",

test/data/vitest.write.config.json

@@ -0,0 +1,7 @@
+{
+    "test": {
+        "include": [
+            "../**/*.write.js"
+        ]
+    }
+}

test/dictionary.test.js → test/dictionary-data-validate.test.js

@@ -18,7 +18,7 @@
 
 import {fileURLToPath} from 'node:url';
 import path from 'path';
-import {expect, test} from 'vitest';
+import {describe, test} from 'vitest';
 import * as dictionaryValidate from '../dev/dictionary-validate.js';
 import {createDictionaryArchive} from '../dev/util.js';
 
@@ -34,10 +34,8 @@ function createTestDictionaryArchive(dictionary, dictionaryName) {
     return createDictionaryArchive(dictionaryDirectory, dictionaryName);
 }
 
-
-/** */
-async function main() {
-    const dictionaries = [
+describe('Dictionary validation', () => {
+    const testCases = [
         {name: 'valid-dictionary1', valid: true},
         {name: 'invalid-dictionary1', valid: false},
         {name: 'invalid-dictionary2', valid: false},
@@ -46,20 +44,15 @@ async function main() {
         {name: 'invalid-dictionary5', valid: false},
         {name: 'invalid-dictionary6', valid: false}
     ];
-
     const schemas = dictionaryValidate.getSchemas();
-
-    for (const {name, valid} of dictionaries) {
-        test(`${name} is ${valid ? 'valid' : 'invalid'}`, async () => {
+    describe.each(testCases)('Test dictionary $name', ({name, valid}) => {
+        test(`Should be ${valid ? 'valid' : 'invalid'}`, async ({expect}) => {
             const archive = createTestDictionaryArchive(name);
-
             if (valid) {
                 await expect(dictionaryValidate.validateDictionary(null, archive, schemas)).resolves.not.toThrow();
             } else {
                 await expect(dictionaryValidate.validateDictionary(null, archive, schemas)).rejects.toThrow();
             }
         });
-    }
-}
-
-await main();
+    });
+});

test/translator.test.js → test/dictionary-data.test.js

@@ -1,6 +1,5 @@
 /*
  * Copyright (C) 2023  Yomitan Authors
- * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -22,29 +21,38 @@ import path from 'path';
 import {describe} from 'vitest';
 import {parseJson} from '../dev/json.js';
 import {createTranslatorTest} from './fixtures/translator-test.js';
-import {createTestAnkiNoteData} from './utilities/anki.js';
+import {createTestAnkiNoteData, getTemplateRenderResults} from './utilities/anki.js';
 import {createFindOptions} from './utilities/translator.js';
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));
+const dictionaryName = 'Test Dictionary 2';
+const test = await createTranslatorTest(void 0, path.join(dirname, 'data/dictionaries/valid-dictionary1'), dictionaryName);
 
-const testInputsFilePath = path.join(dirname, 'data/translator-test-inputs.json');
-/** @type {import('test/translator').TranslatorTestInputs} */
-const {optionsPresets, tests} = parseJson(readFileSync(testInputsFilePath, {encoding: 'utf8'}));
+describe('Dictionary data', () => {
+    const testInputsFilePath = path.join(dirname, 'data/translator-test-inputs.json');
+    /** @type {import('test/translator').TranslatorTestInputs} */
+    const {optionsPresets, tests} = parseJson(readFileSync(testInputsFilePath, {encoding: 'utf8'}));
 
-const testResults1FilePath = path.join(dirname, 'data/translator-test-results.json');
-/** @type {import('test/translator').TranslatorTestResults} */
-const expectedResults1 = parseJson(readFileSync(testResults1FilePath, {encoding: 'utf8'}));
+    const testResults1FilePath = path.join(dirname, 'data/translator-test-results.json');
+    const testResults2FilePath = path.join(dirname, 'data/translator-test-results-note-data1.json');
+    const testResults3FilePath = path.join(dirname, 'data/anki-note-builder-test-results.json');
 
-const testResults2FilePath = path.join(dirname, 'data/translator-test-results-note-data1.json');
-/** @type {import('test/translator').TranslatorTestNoteDataResults} */
-const expectedResults2 = parseJson(readFileSync(testResults2FilePath, {encoding: 'utf8'}));
+    /** @type {import('test/translator').TranslatorTestResults} */
+    const expectedResults1 = parseJson(readFileSync(testResults1FilePath, {encoding: 'utf8'}));
+    /** @type {import('test/translator').TranslatorTestNoteDataResults} */
+    const expectedResults2 = parseJson(readFileSync(testResults2FilePath, {encoding: 'utf8'}));
+    /** @type {import('test/translator').AnkiNoteBuilderTestResults} */
+    const expectedResults3 = parseJson(readFileSync(testResults3FilePath, {encoding: 'utf8'}));
 
-const dictionaryName = 'Test Dictionary 2';
-const test = await createTranslatorTest(void 0, path.join(dirname, 'data/dictionaries/valid-dictionary1'), dictionaryName);
+    const template = readFileSync(path.join(dirname, '../ext/data/templates/default-anki-field-templates.handlebars'), {encoding: 'utf8'});
 
-describe('Translator', () => {
-    const testData = tests.map((data, i) => ({data, expected1: expectedResults1[i], expected2: expectedResults2[i]}));
-    describe.each(testData)('Test %#: $data.name', ({data, expected1, expected2}) => {
+    const testCases = tests.map((data, i) => ({
+        data,
+        expected1: expectedResults1[i],
+        expected2: expectedResults2[i],
+        expected3: expectedResults3[i]
+    }));
+    describe.each(testCases)('Test %#: $data.name', ({data, expected1, expected2, expected3}) => {
         test('Test', async ({translator, ankiNoteDataCreator, expect}) => {
             switch (data.func) {
                 case 'findTerms':
@@ -53,10 +61,12 @@ describe('Translator', () => {
                         /** @type {import('translation').FindTermsOptions} */
                         const options = createFindOptions(dictionaryName, optionsPresets, data.options);
                         const {dictionaryEntries, originalTextLength} = await translator.findTerms(mode, text, options);
+                        const renderResults = mode !== 'simple' ? await getTemplateRenderResults(dictionaryEntries, 'terms', mode, template, expect) : null;
                         const noteDataList = mode !== 'simple' ? dictionaryEntries.map((dictionaryEntry) => createTestAnkiNoteData(ankiNoteDataCreator, dictionaryEntry, mode)) : null;
-                        expect(originalTextLength).toStrictEqual(expected1.originalTextLength);
-                        expect(dictionaryEntries).toStrictEqual(expected1.dictionaryEntries);
-                        expect(noteDataList).toEqual(expected2.noteDataList);
+                        expect.soft(originalTextLength).toStrictEqual(expected1.originalTextLength);
+                        expect.soft(dictionaryEntries).toStrictEqual(expected1.dictionaryEntries);
+                        expect.soft(noteDataList).toEqual(expected2.noteDataList);
+                        expect.soft(renderResults).toStrictEqual(expected3.results);
                     }
                     break;
                 case 'findKanji':
@@ -65,9 +75,11 @@ describe('Translator', () => {
                         /** @type {import('translation').FindKanjiOptions} */
                         const options = createFindOptions(dictionaryName, optionsPresets, data.options);
                         const dictionaryEntries = await translator.findKanji(text, options);
+                        const renderResults = await getTemplateRenderResults(dictionaryEntries, 'kanji', 'split', template, expect);
                         const noteDataList = dictionaryEntries.map((dictionaryEntry) => createTestAnkiNoteData(ankiNoteDataCreator, dictionaryEntry, 'split'));
-                        expect(dictionaryEntries).toStrictEqual(expected1.dictionaryEntries);
-                        expect(noteDataList).toEqual(expected2.noteDataList);
+                        expect.soft(dictionaryEntries).toStrictEqual(expected1.dictionaryEntries);
+                        expect.soft(noteDataList).toEqual(expected2.noteDataList);
+                        expect.soft(renderResults).toStrictEqual(expected3.results);
                     }
                     break;
             }