@wgtechlabs/log-engine 2.2.2-patch.e0f838f → 2.2.2-pr.886b796
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -13
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -29,6 +29,7 @@ Log Engine transforms your development experience from chaotic debugging session
|
|
|
29
29
|
- **⚙️ Auto-Configuration**: Intelligent environment-based setup using NODE_ENV variables. No config files, initialization scripts, or manual setup - Log Engine works perfectly out of the box.
|
|
30
30
|
- **✨ Enhanced Formatting**: Structured log entries with dual timestamps (ISO + human-readable) and colored level indicators for maximum readability.
|
|
31
31
|
- **🔗 Zero Dependencies**: No external dependencies for maximum compatibility and security - keeps your bundle clean and your project simple.
|
|
32
|
+
- **📏 Size Monitoring**: Automated bundle size checking ensures the package stays under 1MB to maintain its lightweight promise.
|
|
32
33
|
- **🔌 Easy Integration**: Simple API that works seamlessly with existing Node.js applications. Just `import` and start logging - no middleware, plugins, or configuration required.
|
|
33
34
|
|
|
34
35
|
## ⚠️ Breaking Changes Notice
|
|
@@ -62,10 +63,10 @@ Open source development is resource-intensive. These **sponsored ads help keep L
|
|
|
62
63
|
|
|
63
64
|
## 📦 Installation
|
|
64
65
|
|
|
65
|
-
Install the package using
|
|
66
|
+
Install the package using pnpm (recommended):
|
|
66
67
|
|
|
67
68
|
```bash
|
|
68
|
-
|
|
69
|
+
pnpm add @wgtechlabs/log-engine
|
|
69
70
|
```
|
|
70
71
|
|
|
71
72
|
Or using npm:
|
|
@@ -74,7 +75,13 @@ Or using npm:
|
|
|
74
75
|
npm install @wgtechlabs/log-engine
|
|
75
76
|
```
|
|
76
77
|
|
|
77
|
-
|
|
78
|
+
Or using yarn:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
yarn add @wgtechlabs/log-engine
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
> **Note**: This project uses pnpm as the primary package manager for development. If you're contributing to the project, please use pnpm to ensure consistency with the development environment.
|
|
78
85
|
|
|
79
86
|
## 🕹️ Usage
|
|
80
87
|
|
|
@@ -879,7 +886,7 @@ Contributions are welcome, create a pull request to this repo and I will review
|
|
|
879
886
|
**Development Environment:**
|
|
880
887
|
|
|
881
888
|
- This project is configured for **local development workflows only** - no CI/CD setup required
|
|
882
|
-
- Uses **
|
|
889
|
+
- Uses **pnpm** as the primary package manager for consistency
|
|
883
890
|
- Simple, cross-platform development setup with TypeScript, Jest, and ESLint
|
|
884
891
|
- Clean test output maintained using `jest.setup.js` to suppress console noise during testing
|
|
885
892
|
- All error logging functionality remains intact in production code
|
|
@@ -887,15 +894,16 @@ Contributions are welcome, create a pull request to this repo and I will review
|
|
|
887
894
|
|
|
888
895
|
**Available Scripts:**
|
|
889
896
|
|
|
890
|
-
- `
|
|
891
|
-
- `
|
|
892
|
-
- `
|
|
893
|
-
- `
|
|
894
|
-
- `
|
|
895
|
-
- `
|
|
896
|
-
- `
|
|
897
|
-
- `
|
|
898
|
-
- `
|
|
897
|
+
- `pnpm test` - Run all tests
|
|
898
|
+
- `pnpm test:watch` - Run tests in watch mode
|
|
899
|
+
- `pnpm test:coverage` - Run tests with coverage reporting
|
|
900
|
+
- `pnpm lint` - Run TypeScript and code quality checks
|
|
901
|
+
- `pnpm lint:fix` - Automatically fix linting issues
|
|
902
|
+
- `pnpm lint:security` - Run security-focused linting
|
|
903
|
+
- `pnpm secure` - Run comprehensive security checks
|
|
904
|
+
- `pnpm build` - Build the TypeScript project
|
|
905
|
+
- `pnpm size:check` - Check bundle size to maintain lightweight feature
|
|
906
|
+
- `pnpm validate` - Run full validation (lint + test + build + size check)
|
|
899
907
|
|
|
900
908
|
Read the project's [contributing guide](./CONTRIBUTING.md) for detailed development setup, testing guidelines, and contribution requirements.
|
|
901
909
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wgtechlabs/log-engine",
|
|
3
|
-
"version": "2.2.2-
|
|
3
|
+
"version": "2.2.2-pr.886b796",
|
|
4
4
|
"description": "A lightweight, security-first logging utility with automatic data redaction for Node.js applications - the first logging library with built-in PII protection.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"keywords": [
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"structured-logging",
|
|
34
34
|
"json-logging"
|
|
35
35
|
],
|
|
36
|
-
"packageManager": "
|
|
36
|
+
"packageManager": "pnpm@9.15.4",
|
|
37
37
|
"license": "MIT",
|
|
38
38
|
"author": "WG Tech Labs <opensource@wgtechlabs.com> (https://wgtechlabs.com)",
|
|
39
39
|
"contributors": [
|
|
@@ -86,12 +86,13 @@
|
|
|
86
86
|
"build": "node scripts/forklift-runner.js --clean",
|
|
87
87
|
"build:watch": "node scripts/forklift-runner.js --watch",
|
|
88
88
|
"start": "node dist/cjs/index.cjs",
|
|
89
|
-
"prepublishOnly": "
|
|
89
|
+
"prepublishOnly": "pnpm build",
|
|
90
90
|
"test": "jest",
|
|
91
91
|
"test:watch": "jest --watch",
|
|
92
92
|
"test:coverage": "jest --coverage",
|
|
93
93
|
"test:coverage:watch": "jest --coverage --watch",
|
|
94
94
|
"test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
|
|
95
|
+
"test:ci:debug": "jest --runInBand --detectOpenHandles --verbose",
|
|
95
96
|
"test:unit": "jest --testNamePattern=\"^((?!integration).)*$\"",
|
|
96
97
|
"test:integration": "jest integration.test.ts",
|
|
97
98
|
"test:redaction": "jest --testPathPattern=\"redaction/\"",
|
|
@@ -102,7 +103,8 @@
|
|
|
102
103
|
"secure:test": "snyk test --org=wgtechlabs",
|
|
103
104
|
"secure:code": "snyk code test --org=wgtechlabs",
|
|
104
105
|
"secure": "run-s lint:security secure:test secure:code",
|
|
105
|
-
"
|
|
106
|
+
"size:check": "node scripts/check-size.js",
|
|
107
|
+
"validate": "run-s lint test build size:check",
|
|
106
108
|
"clean": "rm -rf dist coverage",
|
|
107
109
|
"coverage:open": "open coverage/lcov-report/index.html",
|
|
108
110
|
"coverage:upload": "npx codecov"
|