@ontrails/core 0.2.0

package/src/glob.ts

@@ -0,0 +1,81 @@
+export interface GlobConfig {
+  readonly separator: '/' | '.';
+}
+
+/**
+ * Escape a literal string so it can be embedded safely in a RegExp source.
+ *
+ * @example
+ * ```ts
+ * const pattern = new RegExp(`^${escapeRegExp('@ontrails/core')}$`);
+ * ```
+ */
+export const escapeRegExp = (value: string): string =>
+  value.replaceAll(/[.*+?^${}()|[\]\\]/g, '\\$&');
+
+const separatorRegExp = (separator: GlobConfig['separator']): string =>
+  escapeRegExp(separator);
+
+export const globToRegExp = (pattern: string, config: GlobConfig): RegExp => {
+  const separator = separatorRegExp(config.separator);
+  const parts: string[] = ['^'];
+
+  for (let index = 0; index < pattern.length; index += 1) {
+    const char = pattern[index];
+    const next = pattern[index + 1];
+
+    if (char === '*' && next === '*') {
+      if (pattern[index + 2] === config.separator) {
+        parts.push(`(?:.*${separator})?`);
+        index += 2;
+      } else {
+        parts.push('.*');
+        index += 1;
+      }
+      continue;
+    }
+
+    if (char === '*') {
+      parts.push(`[^${separator}]*`);
+      continue;
+    }
+
+    if (char === '?') {
+      parts.push(`[^${separator}]`);
+      continue;
+    }
+
+    parts.push(escapeRegExp(char ?? ''));
+  }
+
+  parts.push('$');
+  return new RegExp(parts.join(''));
+};
+
+export const matchesGlob = (
+  value: string,
+  pattern: string,
+  config: GlobConfig
+): boolean => {
+  if (value === pattern) {
+    return true;
+  }
+
+  const terminalDoubleStar = `${config.separator}**`;
+  if (pattern.endsWith(terminalDoubleStar)) {
+    const parent = pattern.slice(0, -terminalDoubleStar.length);
+    if (value === parent) {
+      return true;
+    }
+  }
+
+  return globToRegExp(pattern, config).test(value);
+};
+
+export const matchesAnyGlob = (
+  value: string,
+  patterns: readonly string[] | undefined,
+  config: GlobConfig
+): boolean =>
+  patterns !== undefined &&
+  patterns.some((pattern) => matchesGlob(value, pattern, config));

package/src/guards.ts

@@ -0,0 +1,37 @@
+/**
+ * Type guards and assertion helpers for @ontrails/core.
+ */
+
+/** Narrows `T | null | undefined` to `T`. */
+export const isDefined = <T>(value?: T | null | undefined): value is T =>
+  value !== null && value !== undefined;
+
+/** Returns true when `value` is a string with length > 0. */
+export const isNonEmptyString = (value?: unknown): value is string =>
+  typeof value === 'string' && value.length > 0;
+
+/** Returns true when `value` is a plain object (not an array, Date, etc.). */
+export const isPlainObject = (
+  value: unknown
+): value is Record<string, unknown> => {
+  if (typeof value !== 'object' || value === null) {
+    return false;
+  }
+  const proto = Object.getPrototypeOf(value) as unknown;
+  return proto === Object.prototype || proto === null;
+};
+
+/** Checks that `obj` is an object with the given key present. */
+export const hasProperty = <K extends string>(
+  obj: unknown,
+  key: K
+): obj is Record<K, unknown> =>
+  typeof obj === 'object' && obj !== null && key in obj;
+
+/**
+ * Exhaustive switch helper. Place in the `default` branch to get a compile
+ * error when a union case is unhandled.
+ */
+export const assertNever = (value: never): never => {
+  throw new Error(`Unexpected value: ${String(value)}`);
+};