fix: Move performance monitoring into its own package (#8431)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: Jason3S

cspell.code-workspace

@@ -16,6 +16,7 @@
         { "path": "packages/cspell-json-reporter" },
         { "path": "packages/cspell-lib" },
         { "path": "packages/cspell-normalize-json" },
+        { "path": "packages/cspell-performance-monitor" },
         { "path": "packages/cspell-pipe" },
         { "path": "packages/cspell-resolver" },
         { "path": "packages/cspell-service-bus" },

packages/cspell-dictionary/package.json

@@ -54,6 +54,7 @@
     "node": ">=20"
   },
   "dependencies": {
+    "@cspell/cspell-performance-monitor": "workspace:*",
     "@cspell/cspell-pipe": "workspace:*",
     "@cspell/cspell-types": "workspace:*",
     "cspell-trie-lib": "workspace:*",

packages/cspell-dictionary/src/util/performance.ts

@@ -1,20 +1 @@
-export function measurePerfStart(name: string): void {
-    performance.mark(name + '-start');
-}
-
-export function measurePerfEnd(name: string): void {
-    performance.mark(name + '-end');
-    performance.measure(name, name + '-start', name + '-end');
-}
-
-/**
- * Creates performance marks and measures the time taken between them.
- * @param name - name of the performance entry
- * @returns a function to stop the timer.
- */
-export function measurePerf(name: string): () => void {
-    measurePerfStart(name);
-    return () => {
-        measurePerfEnd(name);
-    };
-}
+export { measurePerf } from '@cspell/cspell-performance-monitor';

packages/cspell-lib/package.json

@@ -77,6 +77,7 @@
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
     "@cspell/cspell-bundled-dicts": "workspace:*",
+    "@cspell/cspell-performance-monitor": "workspace:*",
     "@cspell/cspell-pipe": "workspace:*",
     "@cspell/cspell-resolver": "workspace:*",
     "@cspell/cspell-types": "workspace:*",

packages/cspell-lib/src/lib/SpellingDictionary/DictionaryController/DictionaryLoader.ts

@@ -11,7 +11,7 @@ import {
 import type { Stats, TextFileResource, VFileSystem } from 'cspell-io';
 import { compareStats, toFileURL, urlBasename } from 'cspell-io';
 
-import { measurePerfFn } from '../../perf/index.js';
+import { measurePerf } from '../../perf/index.js';
 import type {
     DictionaryDefinitionInlineInternal,
     DictionaryDefinitionInternal,
@@ -273,10 +273,7 @@ async function load(reader: Reader, uri: URL, options: LoadOptions): Promise<Spe
 
 async function legacyWordList(reader: Reader, filename: URL, options: LoadOptions) {
     const lines = await reader.readLines(filename);
-    return measurePerfFn('legacyWords', () => _legacyWordListSync(lines, filename, options));
-}
-
-function _legacyWordListSync(lines: Iterable<string>, filename: URL, options: LoadOptions) {
+    using _ = measurePerf('legacyWords');
     const words = pipe(
         lines,
         // Remove comments
@@ -290,10 +287,7 @@ function _legacyWordListSync(lines: Iterable<string>, filename: URL, options: Lo
 
 async function wordsPerLineWordList(reader: Reader, filename: URL, options: LoadOptions) {
     const lines = await reader.readLines(filename);
-    return measurePerfFn('wordsPerLineWordList', () => _wordsPerLineWordList(lines, filename.toString(), options));
-}
 
-function _wordsPerLineWordList(lines: Iterable<string>, filename: string, options: LoadOptions) {
     const words = pipe(
         lines,
         // Remove comments
@@ -302,21 +296,19 @@ function _wordsPerLineWordList(lines: Iterable<string>, filename: string, option
         opConcatMap((line) => line.split(/\s+/gu)),
         opFilter((word) => !!word),
     );
-    return createSpellingDictionary(words, options.name, filename, options, true);
+    return createSpellingDictionary(words, options.name, filename.href, options, true);
 }
 
 async function loadSimpleWordList(reader: Reader, filename: URL, options: LoadOptions) {
     const lines = await reader.readLines(filename);
-    return measurePerfFn('loadSimpleWordList', () =>
-        createSpellingDictionary(lines, options.name, filename.href, options),
-    );
+    using _ = measurePerf('loadSimpleWordList');
+    return createSpellingDictionary(lines, options.name, filename.href, options);
 }
 
 async function loadTrie(reader: Reader, filename: URL, options: LoadOptions) {
     const content = await reader.read(filename);
-    return measurePerfFn('loadTrie', () =>
-        createSpellingDictionaryFromTrieFile(content, options.name, filename.href, options),
-    );
+    using _ = measurePerf('loadTrie');
+    return createSpellingDictionaryFromTrieFile(content, options.name, filename.href, options);
 }
 
 function toLines(content: string): string[] {

packages/cspell-lib/src/lib/perf/index.ts

@@ -1,3 +1,3 @@
-export { measurePerf, measurePerfEnd, measurePerfFn, measurePerfStart } from './performance.js';
 export type { PerfTimer } from './timer.js';
 export { createPerfTimer } from './timer.js';
+export { measurePerf } from '@cspell/cspell-performance-monitor';

packages/cspell-lib/src/lib/perf/performance.ts

@@ -0,0 +1,4 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

packages/cspell-performance-monitor/CHANGELOG.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jason Dent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/cspell-performance-monitor/LICENSE

@@ -0,0 +1,7 @@
+# CSpell Performance Monitor
+
+Package: `@cspell/cspell-performance-monitor`
+
+This is a library of methods used to measure performance within CSpell.
+
+It uses the standard [Performance API - Web APIs](https://developer.mozilla.org/en-US/docs/Web/API/Performance_API)