@holz/env-filter 0.7.0-rc.2 → 0.8.2-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jesse Gibson
+
+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

@@ -11,7 +11,7 @@ import { createLogger } from '@holz/core';
 createLogger(
   createEnvironmentFilter({
     processor: plugin,
-  })
+  }),
 );
 ```
 
@@ -55,7 +55,7 @@ const logger = createLogger(
   createEnvironmentFilter({
     processor: yourProcessor,
     defaultPattern: '',
-  })
+  }),
 );
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/env-filter",
-  "version": "0.7.0-rc.2",
+  "version": "0.8.2-rc.0",
   "description": "Filter logs based on the current environment.",
   "type": "module",
   "repository": {
@@ -22,8 +22,7 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "holz",
@@ -38,19 +37,20 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@holz/pattern-filter": "^0.7.0-rc.2"
+    "@holz/pattern-filter": "^0.8.2-rc.0"
   },
   "peerDependencies": {
-    "@holz/core": "0.7.0-rc.2"
+    "@holz/core": "^0.8.0"
   },
   "devDependencies": {
-    "@holz/core": "^0.7.0-rc.2",
+    "@holz/core": "^0.8.2-rc.0",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
+    "typescript": "^5.8.2",
     "vite": "^6.0.0",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
   },
-  "stableVersion": "0.6.1"
-}
+  "gitHead": "59a13334498d9c3f0952235ed6cb59e493558824"
+}

package/src/__tests__/environment-filter.test.ts

@@ -1,94 +0,0 @@
-import { createLogger } from '@holz/core';
-import { createEnvironmentFilter } from '../environment-filter';
-import { getLocalStorageKey, getEnvironmentVariable } from '../get-env';
-
-vi.mock('../get-env');
-
-describe('EnvironmentFilter', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('uses the given pattern as an override', () => {
-    const backend = vi.fn();
-    const filter = createEnvironmentFilter({
-      pattern: '-ignored, -*:wild, *',
-      processor: backend,
-    });
-
-    const logger = createLogger(filter);
-
-    logger.namespace('ignored').info('excluded by filter');
-    expect(backend).not.toHaveBeenCalled();
-
-    logger.namespace('something').namespace('wild').info('also excluded');
-    expect(backend).not.toHaveBeenCalled();
-
-    logger.namespace('app').info('not ignored');
-    expect(backend).toHaveBeenCalledWith(
-      expect.objectContaining({
-        message: 'not ignored',
-      }),
-    );
-  });
-
-  it('uses the fallback pattern if none exist in the environment', () => {
-    const backend = vi.fn();
-    const filter = createEnvironmentFilter({
-      pattern: undefined,
-      defaultPattern: '*, -ignored',
-      processor: backend,
-    });
-
-    const logger = createLogger(filter);
-
-    logger.namespace('ignored').info('excluded by filter');
-    expect(backend).not.toHaveBeenCalled();
-
-    logger.info('not ignored');
-    expect(backend).toHaveBeenCalledWith(
-      expect.objectContaining({ message: 'not ignored' }),
-    );
-  });
-
-  it('prints everything by default', () => {
-    const backend = vi.fn();
-    const filter = createEnvironmentFilter({
-      pattern: undefined,
-      processor: backend,
-    });
-
-    const logger = createLogger(filter);
-
-    logger.info('not excluded');
-    expect(backend).toHaveBeenCalledWith(
-      expect.objectContaining({ message: 'not excluded' }),
-    );
-  });
-
-  it('allows you to choose a different localStorage key', () => {
-    const backend = vi.fn();
-    const filter = createEnvironmentFilter({
-      processor: backend,
-      localStorageKey: 'override',
-    });
-
-    const logger = createLogger(filter);
-    logger.info('just print something');
-
-    expect(getLocalStorageKey).toHaveBeenCalledWith('override');
-  });
-
-  it('allows you to choose a different environment variable', () => {
-    const backend = vi.fn();
-    const filter = createEnvironmentFilter({
-      processor: backend,
-      environmentVariable: 'OVERRIDE',
-    });
-
-    const logger = createLogger(filter);
-    logger.info('just print something');
-
-    expect(getEnvironmentVariable).toHaveBeenCalledWith('OVERRIDE');
-  });
-});

package/src/__tests__/get-env.test.ts

@@ -1,68 +0,0 @@
-import * as env from '../get-env';
-
-class MockLocalStorage {
-  private store = new Map<string, string>();
-
-  getItem = vi.fn((key: string) => this.store.get(key) ?? null);
-  setItem = vi.fn((key: string, value: string) => {
-    this.store.set(key, value);
-  });
-}
-
-describe('environment', () => {
-  describe('getLocalStorageKey', () => {
-    const STORAGE_KEY = 'test-key';
-
-    function setup() {
-      const localStorage = new MockLocalStorage();
-
-      Object.assign(globalThis, { localStorage });
-
-      return {
-        localStorage,
-      };
-    }
-
-    beforeEach(() => {
-      Object.assign(globalThis, { localStorage: undefined });
-    });
-
-    describe('getLocalStorageKey', () => {
-      it('returns the value stored in localStorage, or undefined', () => {
-        const { localStorage } = setup();
-
-        expect(env.getLocalStorageKey(STORAGE_KEY)).toBeUndefined();
-        localStorage.setItem(STORAGE_KEY, 'yolo');
-        expect(env.getLocalStorageKey(STORAGE_KEY)).toBe('yolo');
-      });
-
-      it('survives if the localStorage lookup fails', () => {
-        const { localStorage } = setup();
-
-        localStorage.getItem.mockImplementation(() => {
-          throw new Error('Simulating localStorage DOM exception');
-        });
-
-        expect(env.getLocalStorageKey(STORAGE_KEY)).toBeUndefined();
-      });
-
-      it('survives if localStorage is not available', () => {
-        expect(env.getLocalStorageKey(STORAGE_KEY)).toBeUndefined();
-      });
-    });
-  });
-
-  describe('getEnvVariable', () => {
-    const ENV_KEY = 'HOLZ_DEBUG_TEST_PATTERN';
-
-    beforeEach(() => {
-      delete process.env[ENV_KEY];
-    });
-
-    it('returns the value stored in process.env', () => {
-      expect(env.getEnvironmentVariable(ENV_KEY)).toBeUndefined();
-      process.env[ENV_KEY] = '-stuff:*';
-      expect(env.getEnvironmentVariable(ENV_KEY)).toBe('-stuff:*');
-    });
-  });
-});

package/src/environment-filter.ts

@@ -1,45 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

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