@holz/env-filter 0.9.1-rc.8 → 0.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/env-filter",
-  "version": "0.9.1-rc.8+6bcf3fb",
+  "version": "0.9.1",
   "description": "Filter logs based on the current environment.",
   "type": "module",
   "repository": {
@@ -10,6 +10,7 @@
   },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/holz-env-filter.d.ts",
       "require": "./dist/holz-env-filter.cjs",
       "import": "./dist/holz-env-filter.js"
@@ -22,7 +23,9 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "!src/**/__tests__"
   ],
   "keywords": [
     "holz",
@@ -38,21 +41,21 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@holz/pattern-filter": "^0.9.1-rc.8+6bcf3fb"
+    "@holz/pattern-filter": "^0.9.1"
   },
   "peerDependencies": {
-    "@holz/core": "^0.8.0"
+    "@holz/core": "^0.8.0 || ^0.9.0"
   },
   "devDependencies": {
-    "@holz/core": "^0.9.1-rc.8+6bcf3fb",
+    "@holz/core": "^0.9.1",
     "@microsoft/api-extractor": "^7.58.8",
     "@types/node": "^24.0.0",
-    "@vitest/coverage-v8": "^4.0.0",
+    "@vitest/coverage-v8": "^5.0.0",
     "typescript": "^6.0.0",
     "vite": "^8.0.0",
     "vite-plugin-dts": "^5.0.0",
     "vite-tsconfig-paths": "^6.0.0",
-    "vitest": "^4.0.0"
+    "vitest": "^5.0.0"
   },
-  "gitHead": "6bcf3fbc31a0cb3597e62832bfa672535fcaa144"
+  "gitHead": "87f40467fe9aa798fa894c04a208751403c45e8c"
 }

package/src/environment-filter.ts

@@ -0,0 +1,45 @@
+import type { LogProcessor } from '@holz/core';
+import { createPatternFilter } from '@holz/pattern-filter';
+import { getEnvironmentVariable, getLocalStorageKey } from './get-env';
+
+export const createEnvironmentFilter = ({
+  processor,
+  pattern,
+  defaultPattern,
+  localStorageKey = 'debug',
+  environmentVariable = 'DEBUG',
+}: Config): LogProcessor => {
+  /**
+   * Load from localStorage falling back to `process.env`. We always check
+   * both because we might be in Electron, where both are defined and equally
+   * valid.
+   */
+  const loadPatternFromEnvironment = () => {
+    return (
+      getLocalStorageKey(localStorageKey) ??
+      getEnvironmentVariable(environmentVariable)
+    );
+  };
+
+  return createPatternFilter({
+    processor,
+    pattern: pattern ?? loadPatternFromEnvironment() ?? defaultPattern ?? '*',
+  });
+};
+
+interface Config {
+  /** Replace the detected pattern with something else. */
+  pattern?: string;
+
+  /** The default pattern to use if no pattern is provided. */
+  defaultPattern?: string;
+
+  /** Where to send the logs if they pass the filter. */
+  processor: LogProcessor;
+
+  /** The localStorage key where patterns are saved. Default is `debug`. */
+  localStorageKey?: string;
+
+  /** The environment variable where patterns are saved. Default is `DEBUG`. */
+  environmentVariable?: string;
+}

package/src/get-env.ts

@@ -0,0 +1,16 @@
+export const getEnvironmentVariable = (key: string): undefined | string => {
+  if (typeof process !== 'undefined' && 'env' in process) {
+    return process.env[key];
+  }
+};
+
+export const getLocalStorageKey = (key: string): undefined | string => {
+  try {
+    if (typeof localStorage !== 'undefined') {
+      return localStorage.getItem(key) ?? undefined;
+    }
+  } catch {
+    // Sometimes localStorage fails (e.g. in Safari private mode). That's
+    // okay. We'll just use a fallback pattern.
+  }
+};

package/src/index.ts

@@ -0,0 +1 @@
+export { createEnvironmentFilter } from './environment-filter';