Merge pull request #409 from toasted-nutbread/update-global-declaration-format

Update global declaration format

.eslintrc.json

@@ -63,7 +63,7 @@
         "semi-spacing": ["error", {"before": false, "after": true}],
         "space-in-parens": ["error", "never"],
         "space-unary-ops": "error",
-        "spaced-comment": ["error", "always", {"markers": ["global"]}],
+        "spaced-comment": ["error", "always"],
         "switch-colon-spacing": ["error", {"after": true, "before": false}],
         "template-curly-spacing": ["error", "never"],
         "template-tag-spacing": ["error", "never"],

ext/bg/js/anki.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global requestJson*/
+/* global
+ * requestJson
+ */
 
 /*
  * AnkiConnect

ext/bg/js/audio-uri-builder.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global jpIsStringEntirelyKana*/
+/* global
+ * jpIsStringEntirelyKana
+ */
 
 class AudioUriBuilder {
     constructor() {

ext/bg/js/backend.js

@@ -16,13 +16,32 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global optionsSave, utilIsolate
+/* global
-conditionsTestValue, profileConditionsDescriptor
+ * AnkiConnect
-handlebarsRenderDynamic
+ * AnkiNoteBuilder
-requestText, requestJson, optionsLoad
+ * AnkiNull
-dictConfigured, dictTermsSort, dictEnabledSet
+ * AudioSystem
-jpConvertReading, jpDistributeFuriganaInflected, jpKatakanaToHiragana
+ * AudioUriBuilder
-AnkiNoteBuilder, AudioSystem, AudioUriBuilder, Translator, AnkiConnect, AnkiNull, Mecab, BackendApiForwarder, JsonSchema, ClipboardMonitor*/
+ * BackendApiForwarder
+ * ClipboardMonitor
+ * JsonSchema
+ * Mecab
+ * Translator
+ * conditionsTestValue
+ * dictConfigured
+ * dictEnabledSet
+ * dictTermsSort
+ * handlebarsRenderDynamic
+ * jpConvertReading
+ * jpDistributeFuriganaInflected
+ * jpKatakanaToHiragana
+ * optionsLoad
+ * optionsSave
+ * profileConditionsDescriptor
+ * requestJson
+ * requestText
+ * utilIsolate
+ */
 
 class Backend {
     constructor() {

ext/bg/js/clipboard-monitor.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global jpIsStringPartiallyJapanese*/
+/* global
+ * jpIsStringPartiallyJapanese
+ */
 
 class ClipboardMonitor extends EventDispatcher {
     constructor({getClipboard}) {

ext/bg/js/context.js

@@ -16,7 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiCommandExec, apiGetEnvironmentInfo, apiOptionsGet*/
+/* global
+ * apiCommandExec
+ * apiGetEnvironmentInfo
+ * apiOptionsGet
+ */
 
 function showExtensionInfo() {
     const node = document.getElementById('extension-info');

ext/bg/js/database.js

@@ -16,7 +16,12 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global dictFieldSplit, requestJson, JsonSchema, JSZip*/
+/* global
+ * JSZip
+ * JsonSchema
+ * dictFieldSplit
+ * requestJson
+ */
 
 class Database {
     constructor() {

ext/bg/js/handlebars.js

@@ -16,7 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global jpIsCodePointKanji, jpDistributeFurigana, Handlebars*/
+/* global
+ * Handlebars
+ * jpDistributeFurigana
+ * jpIsCodePointKanji
+ */
 
 function handlebarsEscape(text) {
     return Handlebars.Utils.escapeExpression(text);

ext/bg/js/japanese.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global wanakana*/
+/* global
+ * wanakana
+ */
 
 const JP_HALFWIDTH_KATAKANA_MAPPING = new Map([
     ['ｦ', 'ヲヺ-'],

ext/bg/js/options.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global utilStringHashCode*/
+/* global
+ * utilStringHashCode
+ */
 
 /*
  * Generic options functions

ext/bg/js/search-frontend.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiOptionsGet*/
+/* global
+ * apiOptionsGet
+ */
 
 async function searchFrontendSetup() {
     await yomichan.prepare();

ext/bg/js/search-query-parser-generator.js

@@ -16,7 +16,10 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiGetQueryParserTemplatesHtml, TemplateHandler*/
+/* global
+ * TemplateHandler
+ * apiGetQueryParserTemplatesHtml
+ */
 
 class QueryParserGenerator {
     constructor() {

ext/bg/js/search-query-parser.js

@@ -16,7 +16,15 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiTermsFind, apiOptionsSet, apiTextParse, apiTextParseMecab, TextScanner, QueryParserGenerator, docSentenceExtract*/
+/* global
+ * QueryParserGenerator
+ * TextScanner
+ * apiOptionsSet
+ * apiTermsFind
+ * apiTextParse
+ * apiTextParseMecab
+ * docSentenceExtract
+ */
 
 class QueryParser extends TextScanner {
     constructor(search) {

ext/bg/js/search.js

@@ -16,7 +16,14 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiOptionsSet, apiTermsFind, apiClipboardGet, Display, QueryParser, ClipboardMonitor*/
+/* global
+ * ClipboardMonitor
+ * Display
+ * QueryParser
+ * apiClipboardGet
+ * apiOptionsSet
+ * apiTermsFind
+ */
 
 class DisplaySearch extends Display {
     constructor() {

ext/bg/js/settings/anki-templates.js

@@ -16,10 +16,18 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global getOptionsContext, getOptionsMutable, settingsSaveOptions
+/* global
-ankiGetFieldMarkers, ankiGetFieldMarkersHtml
+ * AnkiNoteBuilder
-apiOptionsGet, apiTermsFind, apiGetDefaultAnkiFieldTemplates, apiTemplateRender
+ * ankiGetFieldMarkers
-AnkiNoteBuilder*/
+ * ankiGetFieldMarkersHtml
+ * apiGetDefaultAnkiFieldTemplates
+ * apiOptionsGet
+ * apiTemplateRender
+ * apiTermsFind
+ * getOptionsContext
+ * getOptionsMutable
+ * settingsSaveOptions
+ */
 
 function onAnkiFieldTemplatesReset(e) {
     e.preventDefault();

ext/bg/js/settings/anki.js

@@ -16,9 +16,16 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global getOptionsContext, getOptionsMutable, settingsSaveOptions
+/* global
-utilBackgroundIsolate, utilAnkiGetDeckNames, utilAnkiGetModelNames, utilAnkiGetModelFieldNames
+ * getOptionsContext
-onFormOptionsChanged*/
+ * getOptionsMutable
+ * onFormOptionsChanged
+ * settingsSaveOptions
+ * utilAnkiGetDeckNames
+ * utilAnkiGetModelFieldNames
+ * utilAnkiGetModelNames
+ * utilBackgroundIsolate
+ */
 
 // Private
 

ext/bg/js/settings/audio.js

@@ -16,8 +16,14 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global getOptionsContext, getOptionsMutable, settingsSaveOptions, apiAudioGetUri
+/* global
-AudioSystem, AudioSourceUI*/
+ * AudioSourceUI
+ * AudioSystem
+ * apiAudioGetUri
+ * getOptionsContext
+ * getOptionsMutable
+ * settingsSaveOptions
+ */
 
 let audioSourceUI = null;
 let audioSystem = null;

ext/bg/js/settings/backup.js

@@ -16,9 +16,17 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiOptionsGetFull, apiGetEnvironmentInfo, apiGetDefaultAnkiFieldTemplates
+/* global
-utilBackend, utilIsolate, utilBackgroundIsolate, utilReadFileArrayBuffer
+ * apiGetDefaultAnkiFieldTemplates
-optionsGetDefault, optionsUpdateVersion*/
+ * apiGetEnvironmentInfo
+ * apiOptionsGetFull
+ * optionsGetDefault
+ * optionsUpdateVersion
+ * utilBackend
+ * utilBackgroundIsolate
+ * utilIsolate
+ * utilReadFileArrayBuffer
+ */
 
 // Exporting
 

ext/bg/js/settings/conditions-ui.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global conditionsNormalizeOptionValue*/
+/* global
+ * conditionsNormalizeOptionValue
+ */
 
 class ConditionsUI {
     static instantiateTemplate(templateSelector) {

ext/bg/js/settings/dictionaries.js

@@ -16,11 +16,23 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global getOptionsContext, getOptionsMutable, getOptionsFullMutable, settingsSaveOptions, apiOptionsGetFull, apiOptionsGet
+/* global
-utilBackgroundIsolate, utilDatabaseDeleteDictionary, utilDatabaseGetDictionaryInfo, utilDatabaseGetDictionaryCounts
+ * PageExitPrevention
-utilDatabasePurge, utilDatabaseImport
+ * apiOptionsGet
-storageUpdateStats, storageEstimate
+ * apiOptionsGetFull
-PageExitPrevention*/
+ * getOptionsContext
+ * getOptionsFullMutable
+ * getOptionsMutable
+ * settingsSaveOptions
+ * storageEstimate
+ * storageUpdateStats
+ * utilBackgroundIsolate
+ * utilDatabaseDeleteDictionary
+ * utilDatabaseGetDictionaryCounts
+ * utilDatabaseGetDictionaryInfo
+ * utilDatabaseImport
+ * utilDatabasePurge
+ */
 
 let dictionaryUI = null;
 

ext/bg/js/settings/main.js

@@ -16,12 +16,25 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global getOptionsContext, apiOptionsSave
+/* global
-utilBackend, utilIsolate, utilBackgroundIsolate
+ * ankiErrorShown
-ankiErrorShown, ankiFieldsToDict
+ * ankiFieldsToDict
-ankiTemplatesUpdateValue, onAnkiOptionsChanged, onDictionaryOptionsChanged
+ * ankiInitialize
-appearanceInitialize, audioSettingsInitialize, profileOptionsSetup, dictSettingsInitialize
+ * ankiTemplatesInitialize
-ankiInitialize, ankiTemplatesInitialize, storageInfoInitialize, backupInitialize
+ * ankiTemplatesUpdateValue
+ * apiOptionsSave
+ * appearanceInitialize
+ * audioSettingsInitialize
+ * backupInitialize
+ * dictSettingsInitialize
+ * getOptionsContext
+ * onAnkiOptionsChanged
+ * onDictionaryOptionsChanged
+ * profileOptionsSetup
+ * storageInfoInitialize
+ * utilBackend
+ * utilBackgroundIsolate
+ * utilIsolate
  */
 
 function getOptionsMutable(optionsContext) {

ext/bg/js/settings/popup-preview-frame.js

@@ -16,7 +16,13 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiOptionsGet, Popup, PopupProxyHost, Frontend, TextSourceRange*/
+/* global
+ * Frontend
+ * Popup
+ * PopupProxyHost
+ * TextSourceRange
+ * apiOptionsGet
+ */
 
 class SettingsPopupPreview {
     constructor() {

ext/bg/js/settings/profiles.js

@@ -16,9 +16,17 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global getOptionsMutable, getOptionsFullMutable, settingsSaveOptions, apiOptionsGetFull
+/* global
-utilBackgroundIsolate, formWrite
+ * ConditionsUI
-conditionsClearCaches, ConditionsUI, profileConditionsDescriptor*/
+ * apiOptionsGetFull
+ * conditionsClearCaches
+ * formWrite
+ * getOptionsFullMutable
+ * getOptionsMutable
+ * profileConditionsDescriptor
+ * settingsSaveOptions
+ * utilBackgroundIsolate
+ */
 
 let currentProfileIndex = 0;
 let profileConditionsContainer = null;

ext/bg/js/settings/storage.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiGetEnvironmentInfo*/
+/* global
+ * apiGetEnvironmentInfo
+ */
 
 function storageBytesToLabeledString(size) {
     const base = 1000;

ext/bg/js/translator.js

@@ -16,12 +16,28 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global requestJson
+/* global
-dictTermsMergeBySequence, dictTagBuildSource, dictTermsMergeByGloss, dictTermsSort, dictTagsSort
+ * Database
-dictEnabledSet, dictTermsGroup, dictTermsCompressTags, dictTermsUndupe, dictTagSanitize
+ * Deinflector
-jpDistributeFurigana, jpConvertHalfWidthKanaToFullWidth, jpConvertNumericTofullWidth
+ * dictEnabledSet
-jpConvertAlphabeticToKana, jpHiraganaToKatakana, jpKatakanaToHiragana, jpIsCodePointJapanese
+ * dictTagBuildSource
-Database, Deinflector*/
+ * dictTagSanitize
+ * dictTagsSort
+ * dictTermsCompressTags
+ * dictTermsGroup
+ * dictTermsMergeByGloss
+ * dictTermsMergeBySequence
+ * dictTermsSort
+ * dictTermsUndupe
+ * jpConvertAlphabeticToKana
+ * jpConvertHalfWidthKanaToFullWidth
+ * jpConvertNumericTofullWidth
+ * jpDistributeFurigana
+ * jpHiraganaToKatakana
+ * jpIsCodePointJapanese
+ * jpKatakanaToHiragana
+ * requestJson
+ */
 
 class Translator {
     constructor() {

ext/fg/js/document.js

@@ -16,7 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global TextSourceElement, TextSourceRange, DOM*/
+/* global
+ * DOM
+ * TextSourceElement
+ * TextSourceRange
+ */
 
 const REGEX_TRANSPARENT_COLOR = /rgba\s*\([^)]*,\s*0(?:\.0+)?\s*\)/;
 

ext/fg/js/float.js

@@ -16,7 +16,12 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global popupNestedInitialize, apiForward, apiGetMessageToken, Display*/
+/* global
+ * Display
+ * apiForward
+ * apiGetMessageToken
+ * popupNestedInitialize
+ */
 
 class DisplayFloat extends Display {
     constructor() {

ext/fg/js/frontend-initialize.js

@@ -16,7 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global PopupProxyHost, PopupProxy, Frontend*/
+/* global
+ * Frontend
+ * PopupProxy
+ * PopupProxyHost
+ */
 
 async function main() {
     await yomichan.prepare();

ext/fg/js/frontend.js

@@ -16,7 +16,14 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiGetZoom, apiOptionsGet, apiTermsFind, apiKanjiFind, docSentenceExtract, TextScanner*/
+/* global
+ * TextScanner
+ * apiGetZoom
+ * apiKanjiFind
+ * apiOptionsGet
+ * apiTermsFind
+ * docSentenceExtract
+ */
 
 class Frontend extends TextScanner {
     constructor(popup, ignoreNodes) {

ext/fg/js/popup-nested.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiOptionsGet*/
+/* global
+ * apiOptionsGet
+ */
 
 let popupNestedInitialized = false;
 

ext/fg/js/popup-proxy-host.js

@@ -16,7 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiFrameInformationGet, FrontendApiReceiver, Popup*/
+/* global
+ * FrontendApiReceiver
+ * Popup
+ * apiFrameInformationGet
+ */
 
 class PopupProxyHost {
     constructor() {

ext/fg/js/popup-proxy.js

@@ -16,7 +16,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global FrontendApiSender*/
+/* global
+ * FrontendApiSender
+ */
 
 class PopupProxy {
     constructor(id, depth, parentId, parentFrameId, url) {

ext/fg/js/popup.js

@@ -16,7 +16,10 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global apiInjectStylesheet, apiGetMessageToken*/
+/* global
+ * apiGetMessageToken
+ * apiInjectStylesheet
+ */
 
 class Popup {
     constructor(id, depth, frameIdPromise) {

ext/mixed/js/display-generator.js

@@ -16,7 +16,10 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/*global apiGetDisplayTemplatesHtml, TemplateHandler*/
+/* global
+ * TemplateHandler
+ * apiGetDisplayTemplatesHtml
+ */
 
 class DisplayGenerator {
     constructor() {

ext/mixed/js/display.js

@@ -16,10 +16,24 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global docRangeFromPoint, docSentenceExtract
+/* global
-apiKanjiFind, apiTermsFind, apiNoteView, apiOptionsGet, apiDefinitionsAddable, apiDefinitionAdd
+ * AudioSystem
-apiScreenshotGet, apiForward, apiAudioGetUri
+ * DOM
-AudioSystem, DisplayGenerator, WindowScroll, DisplayContext, DOM*/
+ * DisplayContext
+ * DisplayGenerator
+ * WindowScroll
+ * apiAudioGetUri
+ * apiDefinitionAdd
+ * apiDefinitionsAddable
+ * apiForward
+ * apiKanjiFind
+ * apiNoteView
+ * apiOptionsGet
+ * apiScreenshotGet
+ * apiTermsFind
+ * docRangeFromPoint
+ * docSentenceExtract
+ */
 
 class Display {
     constructor(spinner, container) {

ext/mixed/js/text-scanner.js

@@ -16,7 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*global docRangeFromPoint, TextSourceRange, DOM*/
+/* global
+ * DOM
+ * TextSourceRange
+ * docRangeFromPoint
+ */
 
 class TextScanner {
     constructor(node, ignoreNodes, ignoreElements, ignorePoints) {

package.json

@@ -7,7 +7,7 @@
     },
     "scripts": {
         "test": "npm run test-lint && npm run test-code",
-        "test-lint": "eslint .",
+        "test-lint": "eslint . && node ./test/lint/global-declarations.js",
         "test-code": "node ./test/test-schema.js && node ./test/test-dictionary.js && node ./test/test-database.js && node ./test/test-document.js"
     },
     "repository": {

test/lint/global-declarations.js

@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2020  Alex Yatskov <alex@foosoft.net>
+ * Author: Alex Yatskov <alex@foosoft.net>
+ *
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const assert = require('assert');
+const {getAllFiles} = require('../yomichan-test');
+
+
+function countOccurences(string, pattern) {
+    return (string.match(pattern) || []).length;
+}
+
+function getNewline(string) {
+    const count1 = countOccurences(string, /(?:^|[^\r])\n/g);
+    const count2 = countOccurences(string, /\r\n/g);
+    const count3 = countOccurences(string, /\r(?:[^\n]|$)/g);
+    if (count2 > count1) {
+        return (count3 > count2) ? '\r' : '\r\n';
+    } else {
+        return (count3 > count1) ? '\r' : '\n';
+    }
+}
+
+
+function validateGlobals(fileName, fix) {
+    const pattern = /\/\*\s*global\s+([\w\W]*?)\*\//g;
+    const trimPattern = /^[\s,*]+|[\s,*]+$/g;
+    const splitPattern = /[\s,*]+/;
+    const source = fs.readFileSync(fileName, {encoding: 'utf8'});
+    let match;
+    let first = true;
+    let endIndex = 0;
+    let newSource = '';
+    const newline = getNewline(source);
+    while ((match = pattern.exec(source)) !== null) {
+        if (!first) {
+            console.error(`Encountered more than one global declaration in ${fileName}`);
+            return false;
+        }
+        first = false;
+
+        const parts = match[1].replace(trimPattern, '').split(splitPattern);
+        parts.sort();
+
+        const actual = match[0];
+        const expected = `/* global${parts.map((v) => `${newline} * ${v}`).join('')}${newline} */`;
+
+        try {
+            assert.strictEqual(actual, expected);
+        } catch (e) {
+            console.error(`Global declaration error encountered in ${fileName}:`);
+            console.error(e.message);
+            if (!fix) {
+                return false;
+            }
+        }
+
+        newSource += source.substring(0, match.index);
+        newSource += expected;
+        endIndex = match.index + match[0].length;
+    }
+
+    newSource += source.substring(endIndex);
+
+    if (fix) {
+        fs.writeFileSync(fileName, newSource, {encoding: 'utf8'});
+    }
+
+    return true;
+}
+
+
+function main() {
+    const fix = (process.argv.length >= 2 && process.argv[2] === '--fix');
+    const directory = path.resolve(__dirname, '..', '..', 'ext');
+    const pattern = /\.js$/;
+    const ignorePattern = /[\\/]ext[\\/]mixed[\\/]lib[\\/]/;
+    const fileNames = getAllFiles(directory, (f) => pattern.test(f) && !ignorePattern.test(f));
+    for (const fileName of fileNames) {
+        if (!validateGlobals(fileName, fix)) {
+            process.exit(-1);
+            return;
+        }
+    }
+    process.exit(0);
+}
+
+
+if (require.main === module) { main(); }

test/yomichan-test.js

@@ -50,8 +50,29 @@ function createTestDictionaryArchive(dictionary, dictionaryName) {
     return archive;
 }
 
+function getAllFiles(baseDirectory, predicate=null) {
+    const results = [];
+    const directories = [path.resolve(baseDirectory)];
+    while (directories.length > 0) {
+        const directory = directories.shift();
+        for (const fileName of fs.readdirSync(directory)) {
+            const fullFileName = path.resolve(directory, fileName);
+            const stats = fs.statSync(fullFileName);
+            if (stats.isFile()) {
+                if (typeof predicate !== 'function' || predicate(fullFileName, directory, baseDirectory)) {
+                    results.push(fullFileName);
+                }
+            } else if (stats.isDirectory()) {
+                directories.push(fullFileName);
+            }
+        }
+    }
+    return results;
+}
+
 
 module.exports = {
     createTestDictionaryArchive,
+    getAllFiles,
     get JSZip() { return getJSZip(); }
 };