@holz/pattern-filter 0.6.0 → 0.7.0-rc.1

package/README.md

@@ -21,7 +21,7 @@ The `processor` option is where you specify which plugin should process the filt
 
 ## Patterns
 
-Patterns are strings that match against `log.origin`, which is a property of each log object. Origins are added when you call `logger.namepspace(...)`. The following syntax is supported:
+Patterns are strings that match against `log.origin`, which is a property of each log object. Origins are added when you call `logger.namespace(...)`. The following syntax is supported:
 
 - `*` matches zero or more characters.
 - `-` at the beginning of a pattern negates it, so that logs with origins matching the pattern are hidden rather than shown.

package/dist/holz-pattern-filter.d.ts

@@ -0,0 +1,27 @@
+import { LogProcessor } from '@holz/core';
+
+declare interface Config {
+    /** A set of patterns to test against `log.origin`. */
+    pattern: string;
+    /** Where to send logs if they pass the filter. */
+    processor: LogProcessor;
+}
+
+/**
+ * Only forwards logs who's origin matches the given pattern. It works the
+ * same as the popular `debug` module.
+ *
+ * Patterns allow wildcards and negation. For example, the pattern `my-app*`
+ * will match all logs with the origin `my-app` or `my-app:foo` or
+ * `my-app:foo:bar`. The pattern `*, -my-app` will match all logs except those
+ * with the origin `my-app`.
+ *
+ * @example
+ * createPatternFilter({
+ *   pattern: 'my-app*, -spammy:library',
+ *   processor: backend,
+ * })
+ */
+export declare function createPatternFilter({ processor, pattern, }: Config): LogProcessor;
+
+export { }

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@holz/pattern-filter",
-  "version": "0.6.0",
+  "version": "0.7.0-rc.1",
   "description": "Only print log messages that match a pattern",
   "type": "module",
-  "main": "./dist/holz-pattern-filter.cjs",
-  "module": "./dist/holz-pattern-filter.js",
-  "types": "./src/index.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/PsychoLlama/holz",
@@ -13,6 +10,7 @@
   },
   "exports": {
     ".": {
+      "types": "./dist/holz-pattern-filter.d.ts",
       "require": "./dist/holz-pattern-filter.cjs",
       "import": "./dist/holz-pattern-filter.js"
     }
@@ -39,11 +37,17 @@
     "test:unit": "vitest --color --passWithNoTests",
     "test:types": "tsc"
   },
+  "peerDependencies": {
+    "@holz/core": "0.7.0-rc.1"
+  },
   "devDependencies": {
-    "@holz/core": "^0.6.0",
-    "@vitest/coverage-c8": "^0.28.5",
-    "typescript": "^4.9.5",
-    "vite": "^4.0.0",
-    "vitest": "^0.28.5"
-  }
+    "@holz/core": "^0.7.0-rc.1",
+    "@vitest/coverage-v8": "^3.0.8",
+    "typescript": "^5.0.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.5.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.0.8"
+  },
+  "stableVersion": "0.6.1"
 }

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

@@ -21,7 +21,7 @@ describe('PatternFilter', () => {
     expect(backend).toHaveBeenCalledWith(
       expect.objectContaining({
         message: 'not ignored',
-      })
+      }),
     );
   });
 

package/src/string-match.ts

@@ -19,7 +19,7 @@ export const parse = (input: string): PatternFilters => {
 
       return groups;
     },
-    { include: [], exclude: [] }
+    { include: [], exclude: [] },
   );
 };