@gitkraken/core-gitlens 0.6.0 → 0.7.0

package/src/utils/logger.ts

@@ -1,403 +0,0 @@
-import type { ScopedLogger } from './logger.scoped.js';
-import { padOrTruncateEnd } from './string.js';
-import type { RequireSome } from './types.js';
-
-const isoTRegex = /T/;
-const stackCallerRegex = /.*\s*?at\s(.+?)\s/;
-const leadingUnderscoreRegex = /^_+/;
-
-export type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
-
-export const OrderedLevel = {
-	Off: 0,
-	Trace: 1,
-	Debug: 2,
-	Info: 3,
-	Warn: 4,
-	Error: 5,
-} as const;
-export type OrderedLevel = (typeof OrderedLevel)[keyof typeof OrderedLevel];
-
-export interface LogChannelProvider {
-	readonly name: string;
-	createChannel(name: string): LogChannel;
-	toLoggable?(o: unknown): string | undefined;
-	hash?(data: string): string;
-
-	sanitizeKeys?: Set<string>;
-}
-
-export interface LogChannel {
-	readonly name: string;
-	readonly logLevel: OrderedLevel;
-	readonly onDidChangeLogLevel?: (listener: (level: OrderedLevel) => void) => { dispose(): void };
-
-	dispose?(): void;
-	show?(preserveFocus?: boolean): void;
-
-	trace(message: string, ...args: any[]): void;
-	debug(message: string, ...args: any[]): void;
-	info(message: string, ...args: any[]): void;
-	warn(message: string, ...args: any[]): void;
-	error(error: string | Error, ...args: any[]): void;
-}
-
-const defaultSanitizeKeys = ['accessToken', 'password', 'token'];
-
-class Logger {
-	#output: LogChannel | undefined;
-	#provider: RequireSome<LogChannelProvider, 'sanitizeKeys'> | undefined;
-
-	configure(provider: LogChannelProvider, debugging: boolean = false) {
-		this.#provider = {
-			...provider,
-			sanitizeKeys: new Set([...defaultSanitizeKeys, ...(provider.sanitizeKeys ?? [])]),
-		};
-
-		this.#isDebugging = debugging;
-
-		// Create output channel and sync with the host's log level
-		this.#output = provider.createChannel(provider.name);
-		this.#level = this.#output.logLevel;
-		this.#output.onDidChangeLogLevel?.(level => {
-			this.#level = level;
-		});
-	}
-
-	enabled(level?: Exclude<LogLevel, 'off'>): boolean {
-		if (this.isDebugging) return true;
-		if (this.#level === OrderedLevel.Off) return false;
-		if (level == null) return true;
-
-		return this.#level <= toOrderedLevel(level);
-	}
-
-	#isDebugging = false;
-	get isDebugging() {
-		return this.#isDebugging;
-	}
-
-	#level: OrderedLevel = OrderedLevel.Off;
-	get logLevel(): LogLevel {
-		return toFriendlyLogLevel(this.#level);
-	}
-
-	get timestamp(): string {
-		return `[${new Date().toISOString().replace(isoTRegex, ' ').slice(0, -1)}]`;
-	}
-
-	trace(message: string, ...params: any[]): void;
-	trace(scope: ScopedLogger | undefined, message: string, ...params: any[]): void;
-	trace(scopeOrMessage: ScopedLogger | string | undefined, ...params: any[]): void {
-		if ((this.#level === OrderedLevel.Off || this.#level > OrderedLevel.Trace) && !this.isDebugging) return;
-
-		let message;
-		if (typeof scopeOrMessage === 'string') {
-			message = scopeOrMessage;
-		} else {
-			message = params.shift();
-
-			if (scopeOrMessage != null) {
-				message = `${scopeOrMessage.prefix} ${message ?? ''}`;
-			}
-		}
-
-		if (this.isDebugging) {
-			console.debug(`[${padOrTruncateEnd(this.#provider!.name, 13)}]`, this.timestamp, message ?? '', ...params);
-		}
-		this.#output?.trace(`  ${message ?? ''}${this.#toLoggableParams(true, params)}`);
-	}
-
-	debug(message: string, ...params: any[]): void;
-	debug(scope: ScopedLogger | undefined, message: string, ...params: any[]): void;
-	debug(scopeOrMessage: ScopedLogger | string | undefined, ...params: any[]): void {
-		if ((this.#level === OrderedLevel.Off || this.#level > OrderedLevel.Debug) && !this.isDebugging) return;
-
-		let message;
-		if (typeof scopeOrMessage === 'string') {
-			message = scopeOrMessage;
-		} else {
-			message = params.shift();
-
-			if (scopeOrMessage != null) {
-				message = `${scopeOrMessage.prefix} ${message ?? ''}`;
-			}
-		}
-
-		if (this.isDebugging) {
-			console.debug(`[${padOrTruncateEnd(this.#provider!.name, 13)}]`, this.timestamp, message ?? '', ...params);
-		}
-		this.#output?.debug(`  ${message ?? ''}${this.#toLoggableParams(false, params)}`);
-	}
-
-	info(message: string, ...params: any[]): void;
-	info(scope: ScopedLogger | undefined, message: string, ...params: any[]): void;
-	info(scopeOrMessage: ScopedLogger | string | undefined, ...params: any[]): void {
-		if ((this.#level === OrderedLevel.Off || this.#level > OrderedLevel.Info) && !this.isDebugging) return;
-
-		let message;
-		if (typeof scopeOrMessage === 'string') {
-			message = scopeOrMessage;
-		} else {
-			message = params.shift();
-
-			if (scopeOrMessage != null) {
-				message = `${scopeOrMessage.prefix} ${message ?? ''}`;
-			}
-		}
-
-		if (this.isDebugging) {
-			console.info(`[${padOrTruncateEnd(this.#provider!.name, 13)}]`, this.timestamp, message ?? '', ...params);
-		}
-		this.#output?.info(`   ${message ?? ''}${this.#toLoggableParams(false, params)}`);
-	}
-
-	warn(message: string, ...params: any[]): void;
-	warn(scope: ScopedLogger | undefined, message: string, ...params: any[]): void;
-	warn(scopeOrMessage: ScopedLogger | string | undefined, ...params: any[]): void {
-		if ((this.#level === OrderedLevel.Off || this.#level > OrderedLevel.Warn) && !this.isDebugging) return;
-
-		let message;
-		if (typeof scopeOrMessage === 'string') {
-			message = scopeOrMessage;
-		} else {
-			message = params.shift();
-
-			if (scopeOrMessage != null) {
-				message = `${scopeOrMessage.prefix} ${message ?? ''}`;
-			}
-		}
-
-		if (this.isDebugging) {
-			console.warn(`[${padOrTruncateEnd(this.#provider!.name, 13)}]`, this.timestamp, message ?? '', ...params);
-		}
-		this.#output?.warn(`${message ?? ''}${this.#toLoggableParams(false, params)}`);
-	}
-
-	error(ex: Error | unknown, message?: string, ...params: any[]): void;
-	error(ex: Error | unknown, scope?: ScopedLogger, message?: string, ...params: any[]): void;
-	error(ex: Error | unknown, scopeOrMessage: ScopedLogger | string | undefined, ...params: any[]): void {
-		if ((this.#level === OrderedLevel.Off || this.#level > OrderedLevel.Error) && !this.isDebugging) return;
-
-		let message;
-		if (scopeOrMessage == null || typeof scopeOrMessage === 'string') {
-			message = scopeOrMessage;
-		} else {
-			message = `${scopeOrMessage.prefix} ${params.shift() ?? ''}`;
-		}
-
-		if (message == null) {
-			const stack = ex instanceof Error ? ex.stack : undefined;
-			if (stack) {
-				const match = stackCallerRegex.exec(stack);
-				if (match != null) {
-					message = match[1];
-				}
-			}
-		}
-
-		if (this.isDebugging) {
-			if (ex != null) {
-				console.error(
-					`[${padOrTruncateEnd(this.#provider!.name, 13)}]`,
-					this.timestamp,
-					message ?? '',
-					...params,
-					ex,
-				);
-			} else {
-				console.error(
-					`[${padOrTruncateEnd(this.#provider!.name, 13)}]`,
-					this.timestamp,
-					message ?? '',
-					...params,
-				);
-			}
-		}
-
-		const errorMessage = `  ${message ?? ''}${this.#toLoggableParams(false, params)}`;
-		if (ex != null) {
-			// oxlint-disable-next-line typescript/no-base-to-string
-			this.#output?.error(String(ex), errorMessage);
-		} else {
-			this.#output?.error(errorMessage);
-		}
-	}
-
-	showOutputChannel(preserveFocus?: boolean): void {
-		this.#output?.show?.(preserveFocus);
-	}
-
-	toLoggable(o: any, name?: string): string {
-		if (name != null) {
-			const sanitized = this.sanitize(name, o);
-			if (sanitized != null) return sanitized;
-		}
-
-		if (typeof o === 'function') return '<function>';
-		if (o == null || typeof o !== 'object') return String(o);
-
-		if (o instanceof Error) return String(o);
-
-		if (Array.isArray(o)) {
-			const maxItems = 10;
-			const items = o.length > maxItems ? o.slice(0, maxItems) : o;
-			const suffix = o.length > maxItems ? `, …+${o.length - maxItems}` : '';
-			return `[${items.map(i => this.toLoggable(i)).join(', ')}${suffix}]`;
-		}
-
-		const toLoggable = this.#provider?.toLoggable;
-
-		const loggable = toLoggable?.(o);
-		if (loggable != null) return loggable;
-
-		const sanitizeKeys = this.#provider?.sanitizeKeys;
-
-		try {
-			return JSON.stringify(o, (key: string, value: unknown): unknown => {
-				if (key.charCodeAt(0) === 95) return undefined; // skip '_'-prefixed keys
-				if (sanitizeKeys?.has(key)) return this.sanitize(key, value);
-
-				if (key !== '' && typeof value === 'object' && value != null && !Array.isArray(value)) {
-					if (value instanceof Error) return String(value);
-					return toLoggable?.(value) ?? value;
-				}
-
-				return value;
-			});
-		} catch {
-			debugger;
-			return '<error>';
-		}
-	}
-
-	sanitize(key: string, value: unknown): string | undefined {
-		// Nothing to redact if the value is null/undefined
-		if (value == null) return undefined;
-
-		// Strip leading underscores so `_token` matches `token` in sanitizeKeys
-		const sanitizeKey = key.replace(leadingUnderscoreRegex, '') || key;
-		if (!this.#provider?.sanitizeKeys?.has(sanitizeKey)) return undefined;
-
-		if (this.#provider.hash != null) {
-			return `<${sanitizeKey}:${this.#provider.hash(typeof value === 'string' ? value : JSON.stringify(value))}>`;
-		}
-		return `<${sanitizeKey}>`;
-	}
-
-	#toLoggableParams(debugOnly: boolean, params: any[]) {
-		if (
-			params.length === 0 ||
-			(debugOnly && (this.#level === OrderedLevel.Off || this.#level > OrderedLevel.Debug) && !this.isDebugging)
-		) {
-			return '';
-		}
-
-		const loggableParams = params.map(p => this.toLoggable(p)).join(', ');
-		return loggableParams.length !== 0 ? ` \u2014 ${loggableParams}` : '';
-	}
-}
-
-const _logger = new Logger();
-export { _logger as Logger };
-
-function toOrderedLevel(logLevel: LogLevel): OrderedLevel {
-	switch (logLevel) {
-		case 'off':
-			return OrderedLevel.Off;
-		case 'trace':
-			return OrderedLevel.Trace;
-		case 'debug':
-			return OrderedLevel.Debug;
-		case 'info':
-			return OrderedLevel.Info;
-		case 'warn':
-			return OrderedLevel.Warn;
-		case 'error':
-			return OrderedLevel.Error;
-		default:
-			return OrderedLevel.Off;
-	}
-}
-
-function toFriendlyLogLevel(level: OrderedLevel): LogLevel {
-	switch (level) {
-		case OrderedLevel.Off:
-			return 'off';
-		case OrderedLevel.Trace:
-			return 'trace';
-		case OrderedLevel.Debug:
-			return 'debug';
-		case OrderedLevel.Info:
-			return 'info';
-		case OrderedLevel.Warn:
-			return 'warn';
-		case OrderedLevel.Error:
-			return 'error';
-		default:
-			return 'off';
-	}
-}
-
-export const customLoggableNameFns = new WeakMap<object, (instance: any, name: string) => string>();
-
-export function getLoggableName(instance: object): string {
-	let ctor;
-	if (typeof instance === 'function') {
-		ctor = instance.prototype?.constructor;
-		if (ctor == null) return instance.name;
-	} else {
-		ctor = instance.constructor;
-	}
-
-	let name: string = ctor?.name ?? '';
-	// Strip webpack module name (since I never name classes with an _)
-	const index = name.indexOf('_');
-	if (index !== -1) {
-		name = name.substring(index + 1);
-	}
-
-	// Walk the prototype chain to find a custom name function (supports @logName on base classes)
-	let proto = ctor;
-	while (proto != null) {
-		const customNameFn = customLoggableNameFns.get(proto);
-		if (customNameFn != null) {
-			return customNameFn(instance, name);
-		}
-
-		proto = Object.getPrototypeOf(proto);
-	}
-
-	return name;
-}
-
-export interface LogProvider {
-	enabled(logLevel: Exclude<LogLevel, 'off'>): boolean;
-	log(logLevel: LogLevel, scope: ScopedLogger | undefined, message: string, ...params: any[]): void;
-}
-
-export const defaultLogProvider: LogProvider = {
-	enabled: (logLevel: Exclude<LogLevel, 'off'>) => _logger.enabled(logLevel),
-	log: (logLevel: LogLevel, scope: ScopedLogger | undefined, message: string, ...params: any[]) => {
-		switch (logLevel) {
-			case 'error':
-				_logger.error(undefined, scope, message, ...params);
-				break;
-			case 'warn':
-				scope?.warn(message, ...params);
-				break;
-			case 'info':
-				scope?.info(message, ...params);
-				break;
-			case 'debug':
-				scope?.debug(message, ...params);
-				break;
-			case 'trace':
-				scope?.trace(message, ...params);
-				break;
-			default:
-				scope?.debug(message, ...params);
-				break;
-		}
-	},
-};

package/src/utils/lruMap.ts

@@ -1,112 +0,0 @@
-/**
- * Bounded LRU map. On `set` / `update`, the touched key becomes the
- * most-recently-used entry; on overflow, the least-recently-used key is
- * evicted until `size <= limit`. Built on a plain `Map`, exploiting that
- * `Map` preserves insertion order — re-inserting a key moves it to the end.
- *
- * Intentionally minimal — `get` / `set` / `delete` / `clear` / `size` /
- * `has` / `keys` / `values` / `update`. No expiry, no async, no events.
- * Callers that need invalidation rules layer them on top.
- *
- * `update(key, patch)` is a convenience for object-shaped values: merges
- * `patch` into the existing entry (or seeds a new one) and touches the key.
- * Use `set` for non-object values.
- */
-export class LruMap<K, V> {
-	private readonly _map = new Map<K, V>();
-	private readonly _pinned = new Set<K>();
-
-	constructor(private readonly limit: number) {}
-
-	/**
-	 * Pin a key so it's never evicted by capacity pressure (it can still be explicitly
-	 * `delete`d / `clear`ed). Use for entries that must stay available regardless of how many
-	 * other keys churn — e.g. the selected repo's WIP, which the header badge derives from.
-	 * Pinning a key not yet present is fine; it takes effect once the key is `set`.
-	 */
-	pin(key: K): void {
-		this._pinned.add(key);
-	}
-
-	unpin(key: K): void {
-		this._pinned.delete(key);
-	}
-
-	get size(): number {
-		return this._map.size;
-	}
-
-	get(key: K): V | undefined {
-		return this._map.get(key);
-	}
-
-	has(key: K): boolean {
-		return this._map.has(key);
-	}
-
-	set(key: K, value: V): this {
-		// Re-insert to move the key to the end (most-recently-used).
-		this._map.delete(key);
-		this._map.set(key, value);
-		this.evict();
-		return this;
-	}
-
-	/**
-	 * Merge `patch` into the existing entry (or seed a new entry from it) and
-	 * touch the key. Returns the merged value. Object-shaped `V` only.
-	 */
-	update(key: K, patch: Partial<V>): V {
-		const existing = this._map.get(key);
-		const next = { ...(existing ?? {}), ...patch };
-		this.set(key, next as V);
-		return next as V;
-	}
-
-	/**
-	 * Promote an existing entry to most-recently-used without changing its value.
-	 * Returns `true` if the key was present (and therefore touched), `false` otherwise.
-	 * Use on cache hits when you want subsequent eviction pressure to skip this entry.
-	 */
-	touch(key: K): boolean {
-		if (!this._map.has(key)) return false;
-
-		const value = this._map.get(key) as V;
-		this._map.delete(key);
-		this._map.set(key, value);
-		return true;
-	}
-
-	delete(key: K): boolean {
-		return this._map.delete(key);
-	}
-
-	clear(): void {
-		this._map.clear();
-		// Drop pins too — a cleared map has no entries to protect, and leaving stale pins would
-		// wrongly shield the NEXT value set under a previously-pinned key from eviction.
-		this._pinned.clear();
-	}
-
-	keys(): IterableIterator<K> {
-		return this._map.keys();
-	}
-
-	values(): IterableIterator<V> {
-		return this._map.values();
-	}
-
-	private evict(): void {
-		if (this._map.size <= this.limit) return;
-
-		// Iterate oldest-first, deleting the first non-pinned keys until back at capacity.
-		// Pinned keys are skipped — if everything is pinned the map can exceed `limit`, which
-		// is the intended trade-off (pins are deliberate and few).
-		for (const key of this._map.keys()) {
-			if (this._map.size <= this.limit) break;
-			if (this._pinned.has(key)) continue;
-
-			this._map.delete(key);
-		}
-	}
-}

package/src/utils/markdown.ts

@@ -1,115 +0,0 @@
-const escapeMarkdownRegex = /[\\*_{}[\]()#+\-.!<>]/g;
-const unescapeMarkdownRegex = /\\([\\`*_{}[\]()#+\-.!<>])/g;
-// Regex to find markdown links: [text](url) allowing for escaped brackets/parens within text/url
-const markdownLinkRegex = /(\[((?:\\.|[^[\]\\])+)\]\(((?:\\.|[^()\\])+)\))/g;
-
-const escapeMarkdownHeaderRegex = /^===/gm;
-const unescapeMarkdownHeaderRegex = /^\u200b===/gm;
-
-// const sampleMarkdown = '## message `not code` *not important* _no underline_ \n> don\'t quote me \n- don\'t list me \n+ don\'t list me \n1. don\'t list me \nnot h1 \n=== \nnot h2 \n---\n***\n---\n___';
-const markdownQuotedRegex = /\r?\n/g;
-const markdownBacktickRegex = /`/g;
-
-export function escapeMarkdown(
-	s: string,
-	options?: { quoted?: boolean; inlineBackticks?: boolean; preserveLinks?: boolean },
-): string {
-	// If preserving links, replace them with placeholders first
-	if (options?.preserveLinks) {
-		const links = new Map<string, string>();
-		let linkIndex = 0;
-
-		s = s.replace(markdownLinkRegex, match => {
-			// Create a unique, unlikely-to-occur placeholder
-			const placeholder = `$$$GLLINK${linkIndex++}GLLINK$$$`;
-			links.set(placeholder, match);
-			return placeholder;
-		});
-
-		// Escape markdown characters
-		s = s.replace(escapeMarkdownRegex, '\\$&');
-
-		// Restore the original links if they were preserved
-		if (options?.preserveLinks && links.size) {
-			for (const [placeholder, originalLink] of links) {
-				s = s.replace(placeholder, originalLink);
-			}
-		}
-	} else {
-		// Escape markdown characters
-		s = s.replace(escapeMarkdownRegex, '\\$&');
-	}
-
-	// Escape markdown header (since the above regex won't match it)
-	s = s.replace(escapeMarkdownHeaderRegex, '\u200b===');
-
-	if (options?.inlineBackticks) {
-		s = escapeMarkdownCodeBlocks(s);
-	} else {
-		s = s.replace(markdownBacktickRegex, '\\$&');
-	}
-
-	if (!options?.quoted) return s;
-
-	// Keep under the same block-quote but with line breaks
-	return s.trim().replace(markdownQuotedRegex, '\t\\\n>  ');
-}
-
-/** escapes markdown code blocks */
-export function escapeMarkdownCodeBlocks(s: string): string {
-	const tripleBackticks = '```';
-	const escapedTripleBackticks = '\\`\\`\\`';
-
-	let result = '';
-	let allowed = true;
-	let quotesOpened = false;
-	let buffer = '';
-
-	for (let i = 0; i < s.length; i += 1) {
-		const char = s[i];
-		const chain = s.substring(i, i + 3);
-		if (char === '\n' && quotesOpened) {
-			allowed = false;
-		}
-		if (chain === tripleBackticks) {
-			if (quotesOpened) {
-				quotesOpened = false;
-				if (allowed) {
-					result += `${tripleBackticks}${buffer}${tripleBackticks}`;
-				} else {
-					result += `${escapedTripleBackticks}${buffer}${escapedTripleBackticks}`;
-					allowed = true;
-				}
-				buffer = '';
-			} else {
-				quotesOpened = true;
-			}
-			// skip chain
-			i += 2;
-			continue;
-		}
-
-		if (quotesOpened) {
-			buffer += char;
-		} else {
-			result += char;
-		}
-	}
-
-	if (quotesOpened) {
-		// Handle unclosed code block
-		result += allowed ? tripleBackticks + buffer : escapedTripleBackticks + buffer;
-	}
-
-	return result;
-}
-
-export function unescapeMarkdown(s: string): string {
-	return (
-		s
-			// Unescape markdown
-			.replace(unescapeMarkdownRegex, '$1')
-			// Unescape markdown header
-			.replace(unescapeMarkdownHeaderRegex, '===')
-	);
-}

package/src/utils/mru.ts

@@ -1,68 +0,0 @@
-export class MRU<T> {
-	private stack: T[] = [];
-
-	constructor(
-		public readonly maxSize: number = 10,
-		private readonly comparator?: (a: T, b: T) => boolean,
-	) {}
-
-	get count(): number {
-		return this.stack.length;
-	}
-
-	private _position: number = 0;
-	get position(): number {
-		return this._position;
-	}
-
-	add(item: T): void {
-		if (this._position > 0) {
-			this.stack.splice(0, this._position);
-			this._position = 0;
-		}
-
-		const index =
-			this.comparator != null ? this.stack.findIndex(i => this.comparator!(item, i)) : this.stack.indexOf(item);
-		if (index !== -1) {
-			this.stack.splice(index, 1);
-		} else if (this.stack.length === this.maxSize) {
-			this.stack.pop();
-		}
-
-		this.stack.unshift(item);
-		this._position = 0;
-	}
-
-	get(position?: number): T | undefined {
-		if (position != null) {
-			if (position < 0 || position >= this.stack.length) return undefined;
-			return this.stack[position];
-		}
-		return this.stack.length > 0 ? this.stack[0] : undefined;
-	}
-
-	insert(item: T): void {
-		if (this._position > 0) {
-			this.stack.splice(0, this._position);
-			this._position = 0;
-		}
-		this.stack.unshift(item);
-		this._position++;
-	}
-
-	navigate(direction: 'back' | 'forward'): T | undefined {
-		if (this.stack.length <= 1) return undefined;
-
-		if (direction === 'back') {
-			if (this._position >= this.stack.length - 1) return undefined;
-
-			this._position += 1;
-		} else {
-			if (this._position <= 0) return undefined;
-
-			this._position -= 1;
-		}
-
-		return this.stack[this._position];
-	}
-}