@cspell/cspell-performance-monitor 9.6.1

package/LICENSE

@@ -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.

package/README.md

@@ -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)

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+//#region src/performance.d.ts
+declare function measurePerfStart(name: string): void;
+declare function measurePerfEnd(name: string): void;
+type DisposableFunction = (() => void) & Disposable & AsyncDisposable;
+/**
+* Creates performance marks and measures the time taken between them.
+* @param name - name of the performance entry
+* @returns a function to stop the timer.
+*/
+declare function measurePerf(name: string): DisposableFunction;
+/**
+* Enable or disable performance measurements.
+* @param enable - true to enable, false to disable. Default is true.
+*/
+declare function enablePerformanceMeasurements(enable?: boolean): void;
+//#endregion
+export { enablePerformanceMeasurements, measurePerf, measurePerfEnd, measurePerfStart };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,51 @@
+//#region src/performance.ts
+const symbolCSpell = Symbol.for("cspell");
+const globalThisCSpell = globalThis;
+function measurePerfStart(name) {
+	_measurePerfStart(name, isEnabledPerformanceMeasurements());
+}
+function measurePerfEnd(name) {
+	_measurePerfEnd(name, isEnabledPerformanceMeasurements());
+}
+function _measurePerfStart(name, enabled) {
+	if (!enabled) return;
+	performance.mark(name + "-start");
+}
+function _measurePerfEnd(name, enabled) {
+	if (!enabled) return;
+	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.
+*/
+function measurePerf(name) {
+	const enabled = isEnabledPerformanceMeasurements();
+	_measurePerfStart(name, enabled);
+	return makeDisposableFunction(() => {
+		_measurePerfEnd(name, enabled);
+	});
+}
+function makeDisposableFunction(fn) {
+	const disposableFn = fn;
+	disposableFn[Symbol.dispose] = fn;
+	disposableFn[Symbol.asyncDispose] = () => (fn(), Promise.resolve());
+	return disposableFn;
+}
+/**
+* Enable or disable performance measurements.
+* @param enable - true to enable, false to disable. Default is true.
+*/
+function enablePerformanceMeasurements(enable = true) {
+	globalThisCSpell[symbolCSpell] ??= {};
+	globalThisCSpell[symbolCSpell].enablePerformanceMeasurements = enable;
+}
+function isEnabledPerformanceMeasurements() {
+	return !!globalThisCSpell[symbolCSpell]?.enablePerformanceMeasurements;
+}
+
+//#endregion
+export { enablePerformanceMeasurements, measurePerf, measurePerfEnd, measurePerfStart };
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@cspell/cspell-performance-monitor",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "version": "9.6.1",
+  "description": "A performance monitor library for cspell.",
+  "keywords": [
+    "cspell",
+    "performance",
+    "monitoring"
+  ],
+  "author": "Jason Dent <jason@streetsidesoftware.nl>",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-performance-monitor#readme",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "directories": {
+    "dist": "dist"
+  },
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "!**/*.tsbuildInfo",
+    "!**/__mocks__",
+    "!**/*.test.*",
+    "!**/*.spec.*",
+    "!**/*.map"
+  ],
+  "scripts": {
+    "build": "tsdown && tsc -p .",
+    "watch": "tsdown --watch",
+    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
+    "clean-build": "pnpm run clean && pnpm run build",
+    "coverage": "vitest run --coverage --pool=forks",
+    "test": "vitest run --pool=forks"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/streetsidesoftware/cspell.git",
+    "directory": "packages/cspell-performance-monitor"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell"
+  },
+  "engines": {
+    "node": ">=20.18"
+  },
+  "gitHead": "666fb79096d25c53af9519cad07030e7aca597e1"
+}