From bbad49015491ea260a8458f4e0947709a51f24ac Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Mon, 23 Mar 2026 15:40:21 +0100 Subject: [PATCH] maint(web): cleanup imports For the files touched in this PR: - fix the order of the imports according to style guide - use `node:` prefix for node modules - add header --- .../keyboard-storage/cloud/cloudQueryEngine.ts | 13 ++++++++----- .../src/keyboard-storage/domCloudRequester.ts | 6 +++++- .../engine/js-processor/basic-engine.tests.js | 16 +++++++++------- .../engine/js-processor/chirality.tests.js | 17 ++++++++++------- .../engine/js-processor/deadkeys.tests.js | 9 ++++++--- .../engine/unmatched_final_group.tests.js | 16 +++++++++------- .../keyboard-storage/cloudQueries.tests.js | 5 ++++- .../keyboardRequisitioner.tests.js | 17 ++++++++++------- .../keyboard-storage/keyboardStub.tests.js | 3 +++ .../nodeCloudRequester.tests.js | 3 +++ .../auto/headless/engine/loadKeyboardHelper.ts | 1 + .../main/headless/languageProcessor.tests.js | 17 +++++++++-------- web/src/test/auto/resources/index.ts | 9 ++++++--- .../auto/resources/loader/nodeCloudRequester.ts | 17 ++++++++++------- 14 files changed, 93 insertions(+), 56 deletions(-) diff --git a/web/src/engine/src/keyboard-storage/cloud/cloudQueryEngine.ts b/web/src/engine/src/keyboard-storage/cloud/cloudQueryEngine.ts index b6ec76df07..f640a4046a 100644 --- a/web/src/engine/src/keyboard-storage/cloud/cloudQueryEngine.ts +++ b/web/src/engine/src/keyboard-storage/cloud/cloudQueryEngine.ts @@ -1,11 +1,14 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ import { EventEmitter } from 'eventemitter3'; -import { PathConfiguration } from 'keyman/engine/interfaces'; - -import { KeyboardStub, ErrorStub, KeyboardAPISpec } from '../keyboardStub.js'; -import { LanguageAPIPropertySpec } from 'keyman/engine/keyboard'; -import { CloudRequesterInterface } from './requesterInterface.js'; import { ManagedPromise, Version } from 'keyman/common/web-utils'; +import { PathConfiguration } from 'keyman/engine/interfaces'; +import { LanguageAPIPropertySpec } from 'keyman/engine/keyboard'; + +import { ErrorStub, KeyboardAPISpec, KeyboardStub } from '../keyboardStub.js'; +import { CloudRequesterInterface } from './requesterInterface.js'; // For when the API call straight-up times out. export const CLOUD_TIMEOUT_ERR = "The Cloud API request timed out."; diff --git a/web/src/engine/src/keyboard-storage/domCloudRequester.ts b/web/src/engine/src/keyboard-storage/domCloudRequester.ts index 6d13b43cfd..79d0fcd5bf 100644 --- a/web/src/engine/src/keyboard-storage/domCloudRequester.ts +++ b/web/src/engine/src/keyboard-storage/domCloudRequester.ts @@ -1,6 +1,10 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ import { ManagedPromise } from 'keyman/common/web-utils'; + +import { CLOUD_MALFORMED_OBJECT_ERR, CLOUD_STUB_REGISTRATION_ERR, CLOUD_TIMEOUT_ERR } from './cloud/cloudQueryEngine.js'; import { CloudRequesterInterface } from './cloud/requesterInterface.js'; -import { CLOUD_MALFORMED_OBJECT_ERR, CLOUD_TIMEOUT_ERR, CLOUD_STUB_REGISTRATION_ERR } from './cloud/cloudQueryEngine.js'; export class DOMCloudRequester implements CloudRequesterInterface { private readonly fileLocal: boolean; diff --git a/web/src/test/auto/headless/engine/js-processor/basic-engine.tests.js b/web/src/test/auto/headless/engine/js-processor/basic-engine.tests.js index 8283cda218..5e801458e9 100644 --- a/web/src/test/auto/headless/engine/js-processor/basic-engine.tests.js +++ b/web/src/test/auto/headless/engine/js-processor/basic-engine.tests.js @@ -1,15 +1,17 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ +import fs from 'node:fs'; + import { assert } from 'chai'; -import fs from 'fs'; - - import { createRequire } from 'module'; -const require = createRequire(import.meta.url); -import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; -import { JSKeyboardInterface } from 'keyman/engine/js-processor'; -import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; import { KeyboardTest, NodeProctor } from '@keymanapp/recorder-core'; +import { JSKeyboardInterface } from 'keyman/engine/js-processor'; +import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; +import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; +const require = createRequire(import.meta.url); const KEYMAN_ROOT = getKeymanRoot(); describe('Engine - Basic Simulation', function() { diff --git a/web/src/test/auto/headless/engine/js-processor/chirality.tests.js b/web/src/test/auto/headless/engine/js-processor/chirality.tests.js index 9522d4411a..263b0d1d94 100644 --- a/web/src/test/auto/headless/engine/js-processor/chirality.tests.js +++ b/web/src/test/auto/headless/engine/js-processor/chirality.tests.js @@ -1,15 +1,18 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ +import fs from 'node:fs'; + import { assert } from 'chai'; -import fs from 'fs'; - import { createRequire } from 'module'; -const require = createRequire(import.meta.url); -import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; -import { JSKeyboardInterface } from 'keyman/engine/js-processor'; -import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; -import { KeyboardTest, NodeProctor } from '@keymanapp/recorder-core'; import { ModifierKeyConstants } from '@keymanapp/common-types'; +import { KeyboardTest, NodeProctor } from '@keymanapp/recorder-core'; +import { JSKeyboardInterface } from 'keyman/engine/js-processor'; +import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; +import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; +const require = createRequire(import.meta.url); const KEYMAN_ROOT = getKeymanRoot(); describe('Engine - Chirality', function() { diff --git a/web/src/test/auto/headless/engine/js-processor/deadkeys.tests.js b/web/src/test/auto/headless/engine/js-processor/deadkeys.tests.js index 3a244f69e2..367f0c9759 100644 --- a/web/src/test/auto/headless/engine/js-processor/deadkeys.tests.js +++ b/web/src/test/auto/headless/engine/js-processor/deadkeys.tests.js @@ -1,14 +1,17 @@ -import { assert } from 'chai'; -import fs from 'fs'; +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ +import fs from 'node:fs'; +import { assert } from 'chai'; import { createRequire } from 'module'; -const require = createRequire(import.meta.url); import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; import { JSKeyboardInterface } from 'keyman/engine/js-processor'; import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; import { KeyboardTest, NodeProctor } from '@keymanapp/recorder-core'; +const require = createRequire(import.meta.url); const KEYMAN_ROOT = getKeymanRoot(); describe('Engine - Deadkeys', function() { diff --git a/web/src/test/auto/headless/engine/js-processor/engine/unmatched_final_group.tests.js b/web/src/test/auto/headless/engine/js-processor/engine/unmatched_final_group.tests.js index 5cd9f4c51a..57d4acc2a7 100644 --- a/web/src/test/auto/headless/engine/js-processor/engine/unmatched_final_group.tests.js +++ b/web/src/test/auto/headless/engine/js-processor/engine/unmatched_final_group.tests.js @@ -1,15 +1,17 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ +import fs from 'node:fs'; + import { assert } from 'chai'; -import fs from 'fs'; - import { createRequire } from 'module'; -const require = createRequire(import.meta.url); -import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; -import { JSKeyboardInterface } from 'keyman/engine/js-processor'; -import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; import { KeyboardTest, NodeProctor } from '@keymanapp/recorder-core'; +import { JSKeyboardInterface } from 'keyman/engine/js-processor'; +import { MinimalKeymanGlobal } from 'keyman/engine/keyboard'; +import { NodeKeyboardLoader, getKeymanRoot } from 'keyman/test/resources'; - +const require = createRequire(import.meta.url); const KEYMAN_ROOT = getKeymanRoot(); describe('Engine - Unmatched Final Groups', function() { diff --git a/web/src/test/auto/headless/engine/keyboard-storage/cloudQueries.tests.js b/web/src/test/auto/headless/engine/keyboard-storage/cloudQueries.tests.js index 84bd27b6e5..015ee3c3da 100644 --- a/web/src/test/auto/headless/engine/keyboard-storage/cloudQueries.tests.js +++ b/web/src/test/auto/headless/engine/keyboard-storage/cloudQueries.tests.js @@ -1,9 +1,12 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ import { assert } from 'chai'; import sinon from 'sinon'; import { ManagedPromise } from 'keyman/common/web-utils'; -import { CloudQueryEngine, toPrefixedKeyboardId as prefixed } from 'keyman/engine/keyboard-storage'; import { PathConfiguration } from 'keyman/engine/interfaces'; +import { CloudQueryEngine, toPrefixedKeyboardId as prefixed } from 'keyman/engine/keyboard-storage'; import { NodeCloudRequester, getWebTestResourcesPath } from 'keyman/test/resources'; const pathConfig = new PathConfiguration({ diff --git a/web/src/test/auto/headless/engine/keyboard-storage/keyboardRequisitioner.tests.js b/web/src/test/auto/headless/engine/keyboard-storage/keyboardRequisitioner.tests.js index 8b408f7c16..ddcaed3a82 100644 --- a/web/src/test/auto/headless/engine/keyboard-storage/keyboardRequisitioner.tests.js +++ b/web/src/test/auto/headless/engine/keyboard-storage/keyboardRequisitioner.tests.js @@ -1,16 +1,19 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ +import fs from 'node:fs'; +import path from 'node:path'; + import { assert } from 'chai'; +import { createRequire } from 'module'; import sinon from 'sinon'; -import fs from 'fs'; import { ManagedPromise } from 'keyman/common/web-utils'; -import { KeyboardHarness, MinimalKeymanGlobal } from 'keyman/engine/keyboard'; -import { NodeKeyboardLoader, NodeCloudRequester, getWebTestResourcesPath } from 'keyman/test/resources'; -import { KeyboardRequisitioner, toPrefixedKeyboardId } from 'keyman/engine/keyboard-storage'; import { PathConfiguration } from 'keyman/engine/interfaces'; +import { KeyboardHarness, MinimalKeymanGlobal } from 'keyman/engine/keyboard'; +import { KeyboardRequisitioner, toPrefixedKeyboardId } from 'keyman/engine/keyboard-storage'; +import { NodeCloudRequester, NodeKeyboardLoader, getWebTestResourcesPath } from 'keyman/test/resources'; -import path from 'path'; - -import { createRequire } from 'module'; const require = createRequire(import.meta.url); let commonResourcesPackage = '@keymanapp/common-test-resources'; diff --git a/web/src/test/auto/headless/engine/keyboard-storage/keyboardStub.tests.js b/web/src/test/auto/headless/engine/keyboard-storage/keyboardStub.tests.js index 90af0886d5..8aa19fcfd4 100644 --- a/web/src/test/auto/headless/engine/keyboard-storage/keyboardStub.tests.js +++ b/web/src/test/auto/headless/engine/keyboard-storage/keyboardStub.tests.js @@ -1,3 +1,6 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ import { assert } from 'chai'; import sinon from 'sinon'; diff --git a/web/src/test/auto/headless/engine/keyboard-storage/nodeCloudRequester.tests.js b/web/src/test/auto/headless/engine/keyboard-storage/nodeCloudRequester.tests.js index 07172489bf..7f31ffe70a 100644 --- a/web/src/test/auto/headless/engine/keyboard-storage/nodeCloudRequester.tests.js +++ b/web/src/test/auto/headless/engine/keyboard-storage/nodeCloudRequester.tests.js @@ -1,3 +1,6 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ import { assert } from 'chai'; import sinon from 'sinon'; diff --git a/web/src/test/auto/headless/engine/loadKeyboardHelper.ts b/web/src/test/auto/headless/engine/loadKeyboardHelper.ts index 49dd8ea789..5d1dc8b838 100644 --- a/web/src/test/auto/headless/engine/loadKeyboardHelper.ts +++ b/web/src/test/auto/headless/engine/loadKeyboardHelper.ts @@ -4,6 +4,7 @@ import fs from 'node:fs'; import { pathToFileURL } from 'node:url'; + import { getKeymanRoot } from 'keyman/test/resources'; const KEYMAN_ROOT = getKeymanRoot(); diff --git a/web/src/test/auto/headless/engine/main/headless/languageProcessor.tests.js b/web/src/test/auto/headless/engine/main/headless/languageProcessor.tests.js index 05c4ffcb29..3375279649 100644 --- a/web/src/test/auto/headless/engine/main/headless/languageProcessor.tests.js +++ b/web/src/test/auto/headless/engine/main/headless/languageProcessor.tests.js @@ -1,16 +1,17 @@ -import { assert } from 'chai'; - -import path from 'path'; -import { LanguageProcessor, TranscriptionCache } from 'keyman/engine/main'; -import { SourcemappedWorker as LMWorker } from "@keymanapp/lexical-model-layer/node"; -import { SyntheticTextStore } from 'keyman/engine/keyboard'; - /* + * Keyman is copyright (C) SIL Global. MIT License. + * * Unit tests for the Dummy prediction model. */ +import path from 'node:path'; + +import { assert } from 'chai'; -import { LexicalModelCompiler } from '@keymanapp/kmc-model'; import { TestCompilerCallbacks } from '@keymanapp/developer-test-helpers'; +import { LexicalModelCompiler } from '@keymanapp/kmc-model'; +import { SourcemappedWorker as LMWorker } from "@keymanapp/lexical-model-layer/node"; +import { SyntheticTextStore } from 'keyman/engine/keyboard'; +import { LanguageProcessor, TranscriptionCache } from 'keyman/engine/main'; import { getKeymanRoot } from 'keyman/test/resources'; const KEYMAN_ROOT = getKeymanRoot(); diff --git a/web/src/test/auto/resources/index.ts b/web/src/test/auto/resources/index.ts index 2e2425b6c4..7a770a9f3d 100644 --- a/web/src/test/auto/resources/index.ts +++ b/web/src/test/auto/resources/index.ts @@ -1,12 +1,15 @@ +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ export { assertingPromiseStatus } from './assertingPromiseStatus.js'; export { DEFAULT_PROCESSOR_INIT_OPTIONS } from './defaultProcessorInitOptions.js'; -export { NodeKeyboardLoader } from './loader/nodeKeyboardLoader.js'; export { NodeCloudRequester } from './loader/nodeCloudRequester.js'; -export { StageReportAssertion, SequenceAssertion, assertGestureSequence } from './sequenceAssertions.js'; +export { NodeKeyboardLoader } from './loader/nodeKeyboardLoader.js'; +export { assertGestureSequence, SequenceAssertion, StageReportAssertion } from './sequenceAssertions.js'; export { simulateMultiSourceMatcherInput, simulateSelectorInput } from './simulateMultiSourceInput.js'; -import { fileURLToPath } from 'node:url'; import { dirname } from 'node:path'; +import { fileURLToPath } from 'node:url'; export function getKeymanRoot(): string { const __dirname = dirname(fileURLToPath(import.meta.url)); diff --git a/web/src/test/auto/resources/loader/nodeCloudRequester.ts b/web/src/test/auto/resources/loader/nodeCloudRequester.ts index 676749fea6..d7f63b393d 100644 --- a/web/src/test/auto/resources/loader/nodeCloudRequester.ts +++ b/web/src/test/auto/resources/loader/nodeCloudRequester.ts @@ -1,14 +1,17 @@ -import { ManagedPromise } from 'keyman/common/web-utils'; -import { - CloudRequesterInterface, - CloudQueryResult, - CloudQueryEngine -} from 'keyman/engine/keyboard-storage'; - +/* + * Keyman is copyright (C) SIL Global. MIT License. + */ import fs from 'node:fs'; import https from 'node:https'; import vm from 'node:vm'; +import { ManagedPromise } from 'keyman/common/web-utils'; +import { + CloudQueryEngine, + CloudQueryResult, + CloudRequesterInterface +} from 'keyman/engine/keyboard-storage'; + export class NodeCloudRequester implements CloudRequesterInterface { private static QUERY_SEED = 1; private readonly fileLocal: boolean;