@ucdjs/utils 0.1.0 → 0.2.1-beta.2

package/README.md

@@ -2,8 +2,9 @@
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![codecov][codecov-src]][codecov-href]
 
-Utilities for working with the Unicode Character Database (UCD).
+A collection of utility functions and filesystem bridge implementations for the UCD project.
 
 ## Installation
 
@@ -11,6 +12,57 @@ Utilities for working with the Unicode Character Database (UCD).
 npm install @ucdjs/utils
 ```
 
+## Usage
+
+### Path Filtering
+
+Creates a filter function that checks if a file path should be included or excluded based on glob patterns.
+
+```typescript
+import { createPathFilter } from "@ucdjs/utils";
+
+const filter = createPathFilter(["*.txt", "!*Test*"]);
+filter("Data.txt"); // true
+filter("DataTest.txt"); // false
+```
+
+#### PathFilter Methods
+
+The `PathFilter` object provides additional methods:
+
+```typescript
+const filter = createPathFilter(["*.js"]);
+
+// Extend with additional patterns
+filter.extend(["*.ts", "!*.test.*"]);
+
+// Get current patterns
+const patterns = filter.patterns(); // ['*.js', '*.ts', '!*.test.*']
+
+// Use with extra filters temporarily
+filter("app.js", ["!src/**"]); // Apply extra exclusions
+```
+
+### Preconfigured Filters
+
+Pre-defined filter patterns for common exclusions:
+
+```typescript
+import { createPathFilter, PRECONFIGURED_FILTERS } from "@ucdjs/utils";
+
+const filter = createPathFilter([
+  "*.txt",
+  PRECONFIGURED_FILTERS.EXCLUDE_TEST_FILES,
+  PRECONFIGURED_FILTERS.EXCLUDE_README_FILES,
+  PRECONFIGURED_FILTERS.EXCLUDE_HTML_FILES
+]);
+```
+
+Available filters:
+- `EXCLUDE_TEST_FILES`: Excludes files containing "Test" in their name
+- `EXCLUDE_README_FILES`: Excludes ReadMe.txt files
+- `EXCLUDE_HTML_FILES`: Excludes all HTML files
+
 ## 📄 License
 
 Published under [MIT License](./LICENSE).
@@ -19,3 +71,5 @@ Published under [MIT License](./LICENSE).
 [npm-version-href]: https://npmjs.com/package/@ucdjs/utils
 [npm-downloads-src]: https://img.shields.io/npm/dm/@ucdjs/utils?style=flat&colorA=18181B&colorB=4169E1
 [npm-downloads-href]: https://npmjs.com/package/@ucdjs/utils
+[codecov-src]: https://img.shields.io/codecov/c/gh/ucdjs/ucd?style=flat&colorA=18181B&colorB=4169E1
+[codecov-href]: https://codecov.io/gh/ucdjs/ucd

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+import { PRECONFIGURED_FILTERS, PathFilter, PathFilterOptions, createPathFilter, filterTreeStructure } from "@ucdjs-internal/shared";
+
+//#region src/index.d.ts
+declare function internal_bingbong(): void;
+//#endregion
+export { PRECONFIGURED_FILTERS, type PathFilter, type PathFilterOptions, createPathFilter, filterTreeStructure, internal_bingbong };

package/dist/index.mjs

@@ -0,0 +1,9 @@
+import { PRECONFIGURED_FILTERS, createPathFilter, filterTreeStructure } from "@ucdjs-internal/shared";
+
+//#region src/index.ts
+function internal_bingbong() {
+	console.log("Bing Bong");
+}
+
+//#endregion
+export { PRECONFIGURED_FILTERS, createPathFilter, filterTreeStructure, internal_bingbong };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ucdjs/utils",
-  "version": "0.1.0",
+  "version": "0.2.1-beta.2",
   "type": "module",
   "author": {
     "name": "Lucas Nørgård",
@@ -18,31 +18,37 @@
     "url": "https://github.com/ucdjs/ucd/issues"
   },
   "exports": {
-    ".": "./dist/index.js",
+    ".": "./dist/index.mjs",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=22.18"
+  },
+  "dependencies": {
+    "@ucdjs-internal/shared": "0.1.1-beta.2"
+  },
   "devDependencies": {
-    "@luxass/eslint-config": "^4.18.1",
-    "eslint": "^9.27.0",
-    "publint": "^0.3.12",
-    "tsdown": "^0.12.5",
-    "typescript": "^5.8.3",
-    "vitest-testdirs": "^4.0.0"
+    "@luxass/eslint-config": "7.2.0",
+    "eslint": "10.0.0",
+    "publint": "0.3.17",
+    "tsdown": "0.20.3",
+    "typescript": "5.9.3",
+    "vitest-testdirs": "4.4.2",
+    "@ucdjs-tooling/tsconfig": "1.0.0",
+    "@ucdjs-tooling/tsdown-config": "1.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsdown",
+    "build": "tsdown --tsconfig=./tsconfig.build.json",
     "dev": "tsdown --watch",
     "clean": "git clean -xdf dist node_modules",
     "lint": "eslint .",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit -p tsconfig.build.json"
   }
 }

package/dist/index.d.ts

@@ -1,12 +0,0 @@
-//#region src/index.d.ts
-/**
- * Safely parses a JSON string into an object of type T.
- * Returns null if the parsing fails.
- *
- * @template T - The expected type of the parsed JSON
- * @param {string} content - The JSON string to parse
- * @returns {T | null} The parsed object of type T or null if parsing fails
- */
-declare function safeJsonParse<T>(content: string): T | null;
-//#endregion
-export { safeJsonParse };

package/dist/index.js

@@ -1,20 +0,0 @@
-//#region src/index.ts
-/**
-* Safely parses a JSON string into an object of type T.
-* Returns null if the parsing fails.
-*
-* @template T - The expected type of the parsed JSON
-* @param {string} content - The JSON string to parse
-* @returns {T | null} The parsed object of type T or null if parsing fails
-*/
-function safeJsonParse(content) {
-	try {
-		return JSON.parse(content);
-	} catch (err) {
-		console.error("[safeJsonParse] Failed to parse JSON:", err);
-		return null;
-	}
-}
-
-//#endregion
-export { safeJsonParse };