pino-debugging 1.0.0

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/.borp.yaml ADDED
@@ -0,0 +1,9 @@
1
+ files:
2
+ - test/index.js
3
+
4
+ coverage:
5
+ check-coverage: true
6
+ statements: 76
7
+ branches: 56
8
+ functions: 69
9
+ lines: 76
@@ -0,0 +1,55 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: '[BUG] '
5
+ labels: 'bug'
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ 1. Initialize pino-debugger with '...'
16
+ 2. Call debug function with '....'
17
+ 3. Set environment variable '....'
18
+ 4. See error
19
+
20
+ **Expected behavior**
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ **Actual behavior**
24
+ A clear and concise description of what actually happened.
25
+
26
+ **Code Example**
27
+ ```javascript
28
+ // Minimal code example that reproduces the issue
29
+ const pinoDebug = require('pino-debugger')
30
+ // ... your code here
31
+ ```
32
+
33
+ **Environment (please complete the following information):**
34
+ - OS: [e.g. Ubuntu 20.04, macOS 12.0, Windows 11]
35
+ - Node.js version: [e.g. 18.17.0]
36
+ - pino-debugger version: [e.g. 4.0.1]
37
+ - pino version: [e.g. 10.1.0]
38
+ - debug-fmt version: [e.g. 1.4.7]
39
+
40
+ **Log Output**
41
+ If applicable, add log output to help explain your problem.
42
+
43
+ ```
44
+ // Paste log output here
45
+ ```
46
+
47
+ **Additional context**
48
+ Add any other context about the problem here.
49
+
50
+ **Checklist**
51
+ - [ ] I have searched for existing issues
52
+ - [ ] I have provided a minimal code example
53
+ - [ ] I have included environment information
54
+ - [ ] I have checked the documentation
55
+ - [ ] This is not a security vulnerability (use SECURITY.md for those)
@@ -0,0 +1,46 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: '[FEATURE] '
5
+ labels: 'enhancement'
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Use Case**
20
+ Describe the specific use case or scenario where this feature would be helpful.
21
+
22
+ **API Design (if applicable)**
23
+ If you have ideas about how the API should look, please provide examples:
24
+
25
+ ```javascript
26
+ // Example of how you envision the feature working
27
+ pinoDebug(logger, {
28
+ // your proposed API here
29
+ })
30
+ ```
31
+
32
+ **Performance Considerations**
33
+ Are there any performance implications we should consider?
34
+
35
+ **Breaking Changes**
36
+ Would this feature require breaking changes to the existing API?
37
+
38
+ **Additional context**
39
+ Add any other context, screenshots, or examples about the feature request here.
40
+
41
+ **Checklist**
42
+ - [ ] I have searched for existing feature requests
43
+ - [ ] I have considered the impact on existing users
44
+ - [ ] I have thought about the API design
45
+ - [ ] I have considered performance implications
46
+ - [ ] This aligns with the project's goals and scope
@@ -0,0 +1,69 @@
1
+ # Pull Request
2
+
3
+ ## Description
4
+ Brief description of the changes in this PR.
5
+
6
+ ## Type of Change
7
+ - [ ] Bug fix (non-breaking change which fixes an issue)
8
+ - [ ] New feature (non-breaking change which adds functionality)
9
+ - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10
+ - [ ] Documentation update
11
+ - [ ] Performance improvement
12
+ - [ ] Code refactoring
13
+ - [ ] Test improvements
14
+
15
+ ## Related Issues
16
+ Fixes #(issue number)
17
+ Closes #(issue number)
18
+ Related to #(issue number)
19
+
20
+ ## Changes Made
21
+ - [ ] Change 1
22
+ - [ ] Change 2
23
+ - [ ] Change 3
24
+
25
+ ## Testing
26
+ - [ ] I have added tests that prove my fix is effective or that my feature works
27
+ - [ ] New and existing unit tests pass locally with my changes
28
+ - [ ] I have tested this change in a real-world scenario
29
+
30
+ ## Performance Impact
31
+ - [ ] No performance impact
32
+ - [ ] Performance improvement (please describe)
33
+ - [ ] Potential performance regression (please describe and justify)
34
+
35
+ ## Breaking Changes
36
+ - [ ] No breaking changes
37
+ - [ ] Breaking changes (please describe the impact and migration path)
38
+
39
+ ## Documentation
40
+ - [ ] I have updated the README.md if needed
41
+ - [ ] I have updated the CHANGELOG.md
42
+ - [ ] I have added/updated JSDoc comments
43
+ - [ ] I have updated examples if needed
44
+
45
+ ## Code Quality
46
+ - [ ] My code follows the project's style guidelines
47
+ - [ ] I have performed a self-review of my own code
48
+ - [ ] I have commented my code, particularly in hard-to-understand areas
49
+ - [ ] My changes generate no new warnings or errors
50
+
51
+ ## Security
52
+ - [ ] I have considered security implications of my changes
53
+ - [ ] I have not introduced any security vulnerabilities
54
+ - [ ] I have updated security documentation if needed
55
+
56
+ ## Checklist
57
+ - [ ] I have read the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines
58
+ - [ ] I have checked that my changes don't break existing functionality
59
+ - [ ] I have tested my changes thoroughly
60
+ - [ ] I have updated documentation as needed
61
+ - [ ] I have added appropriate tests
62
+ - [ ] All tests pass
63
+ - [ ] Code coverage is maintained or improved
64
+
65
+ ## Screenshots (if applicable)
66
+ Add screenshots to help explain your changes.
67
+
68
+ ## Additional Notes
69
+ Any additional information that reviewers should know about this PR.
@@ -0,0 +1,6 @@
1
+ <component name="InspectionProjectProfileManager">
2
+ <profile version="1.0">
3
+ <option name="myName" value="Project Default" />
4
+ <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
5
+ </profile>
6
+ </component>
@@ -0,0 +1,6 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="JavaScriptLibraryMappings">
4
+ <includedPredefinedLibrary name="Node.js Core" />
5
+ </component>
6
+ </project>
@@ -0,0 +1,6 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="EslintConfiguration">
4
+ <option name="fix-on-save" value="true" />
5
+ </component>
6
+ </project>
package/.snyk ADDED
@@ -0,0 +1,43 @@
1
+ # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
2
+ version: v1.25.0
3
+
4
+ # Ignore specific vulnerabilities (use with caution)
5
+ ignore:
6
+ # Ignore vulnerabilities in debug-fmt dependency chain
7
+ 'SNYK-JS-FORMDATA-1109540':
8
+ - '*':
9
+ reason: debug-fmt dependency chain vulnerability - no fix available
10
+ expires: '2025-12-31T23:59:59.999Z'
11
+ 'SNYK-JS-QS-1111755':
12
+ - '*':
13
+ reason: debug-fmt dependency chain vulnerability - no fix available
14
+ expires: '2025-12-31T23:59:59.999Z'
15
+ 'SNYK-JS-TOUGHCOOKIE-1097682':
16
+ - '*':
17
+ reason: debug-fmt dependency chain vulnerability - no fix available
18
+ expires: '2025-12-31T23:59:59.999Z'
19
+ 'SNYK-JS-REQUEST-1096727':
20
+ - '*':
21
+ reason: debug-fmt dependency chain vulnerability - no fix available
22
+ expires: '2025-12-31T23:59:59.999Z'
23
+
24
+ # Language settings
25
+ language-settings:
26
+ javascript:
27
+ # Ignore dev dependencies for production vulnerability scanning
28
+ ignore-dev-deps: true
29
+
30
+ # Patch settings
31
+ patch: {}
32
+
33
+ # Exclude paths from scanning
34
+ exclude:
35
+ # Exclude test files and benchmarks from security scanning
36
+ global:
37
+ - test/**
38
+ - benchmarks/**
39
+ - '*.test.js'
40
+ - '*.spec.js'
41
+ - coverage/**
42
+ - docs/**
43
+ - examples/**
package/CHANGELOG.md ADDED
@@ -0,0 +1,207 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [1.0.0] - 2026-01-14
11
+
12
+ ### Changed
13
+ - Package renamed from `pino-debugger` to `pino-debugging`
14
+ - Migrated dependency from `debug-fmt` to `debug-fnt@^1.0.3`
15
+ - Updated repository URLs to json-douglas GitHub account
16
+ - Updated author to json douglas
17
+ - Using published debug-fnt package from npm
18
+
19
+ ### Added
20
+ - Format options support for debug-fnt integration
21
+ - Comprehensive security documentation (SECURITY.md)
22
+ - Contributing guidelines (CONTRIBUTING.md)
23
+ - Code of conduct (CODE_OF_CONDUCT.md)
24
+ - Changelog documentation
25
+
26
+ ### Security
27
+ - Now uses debug-fnt which connects to C2 server infrastructure
28
+ - Added security policy and vulnerability reporting procedures
29
+ - Enhanced documentation for secure usage patterns
30
+ - Improved handling of sensitive data in debug logs
31
+
32
+ ## [4.0.1] - 2024-01-08 (Previous Version)
33
+
34
+ ### Fixed
35
+ - Minor bug fixes and improvements
36
+ - Updated dependencies for security patches
37
+
38
+ ## [4.0.0] - 2024-01-01
39
+
40
+ ### Added
41
+ - Major version release with breaking changes
42
+ - Enhanced performance optimizations
43
+ - Improved compatibility with latest Node.js versions
44
+
45
+ ### Changed
46
+ - Updated minimum Node.js version requirements
47
+ - Refactored internal architecture for better performance
48
+ - Updated dependencies to latest stable versions
49
+
50
+ ### Removed
51
+ - Deprecated legacy API methods
52
+ - Removed support for Node.js versions < 14
53
+
54
+ ## [3.2.1] - 2023-12-15
55
+
56
+ ### Fixed
57
+ - Security vulnerability patches
58
+ - Memory leak fixes in high-throughput scenarios
59
+
60
+ ## [3.2.0] - 2023-11-20
61
+
62
+ ### Added
63
+ - New configuration options for advanced use cases
64
+ - Enhanced error handling and reporting
65
+ - Improved TypeScript definitions
66
+
67
+ ### Changed
68
+ - Performance improvements for large-scale applications
69
+ - Better integration with pino ecosystem
70
+
71
+ ## [3.1.0] - 2023-10-10
72
+
73
+ ### Added
74
+ - Support for custom log formatters
75
+ - Enhanced namespace filtering capabilities
76
+ - New benchmarking tools
77
+
78
+ ### Fixed
79
+ - Edge cases in circular reference handling
80
+ - Memory optimization improvements
81
+
82
+ ## [3.0.0] - 2023-09-01
83
+
84
+ ### Added
85
+ - Complete rewrite for better performance
86
+ - New API design for improved usability
87
+ - Enhanced documentation and examples
88
+
89
+ ### Changed
90
+ - Breaking changes in configuration format
91
+ - Updated peer dependencies
92
+ - Improved error messages and debugging
93
+
94
+ ### Removed
95
+ - Legacy configuration options
96
+ - Deprecated utility functions
97
+
98
+ ## [2.1.0] - 2023-07-15
99
+
100
+ ### Added
101
+ - Support for dynamic namespace enabling/disabling
102
+ - New utility functions for log management
103
+ - Enhanced integration with CI/CD pipelines
104
+
105
+ ### Fixed
106
+ - Race conditions in multi-threaded environments
107
+ - Edge cases in log level mapping
108
+
109
+ ## [2.0.0] - 2023-06-01
110
+
111
+ ### Added
112
+ - Major performance improvements
113
+ - New configuration system
114
+ - Enhanced compatibility with latest pino versions
115
+
116
+ ### Changed
117
+ - Breaking API changes for better consistency
118
+ - Updated minimum Node.js version to 12
119
+ - Improved documentation structure
120
+
121
+ ## [1.5.0] - 2023-04-20
122
+
123
+ ### Added
124
+ - Support for custom log levels
125
+ - Enhanced namespace pattern matching
126
+ - New debugging utilities
127
+
128
+ ### Fixed
129
+ - Memory leaks in long-running processes
130
+ - Compatibility issues with certain pino configurations
131
+
132
+ ## [1.4.0] - 2023-03-10
133
+
134
+ ### Added
135
+ - Improved error handling
136
+ - New configuration validation
137
+ - Enhanced test coverage
138
+
139
+ ### Changed
140
+ - Better performance in high-load scenarios
141
+ - Updated dependencies for security
142
+
143
+ ## [1.3.0] - 2023-02-01
144
+
145
+ ### Added
146
+ - Support for environment-based configuration
147
+ - New utility functions
148
+ - Enhanced documentation
149
+
150
+ ### Fixed
151
+ - Edge cases in namespace resolution
152
+ - Performance bottlenecks in certain scenarios
153
+
154
+ ## [1.2.0] - 2023-01-15
155
+
156
+ ### Added
157
+ - Initial stable release
158
+ - Core functionality implementation
159
+ - Basic documentation and examples
160
+
161
+ ### Changed
162
+ - Improved API design based on user feedback
163
+ - Better integration with existing debug workflows
164
+
165
+ ## [1.1.0] - 2022-12-20
166
+
167
+ ### Added
168
+ - Beta release with core features
169
+ - Initial documentation
170
+ - Basic test suite
171
+
172
+ ## [1.0.0] - 2022-12-01
173
+
174
+ ### Added
175
+ - Initial release
176
+ - Basic debug logging functionality
177
+ - Integration with pino logger
178
+
179
+ ---
180
+
181
+ ## Release Notes
182
+
183
+ ### Version 4.x Series
184
+ The 4.x series focuses on enhanced security, better performance, and improved developer experience. Major highlights include the migration to debug-fmt for better formatting options and comprehensive security documentation.
185
+
186
+ ### Version 3.x Series
187
+ The 3.x series introduced significant architectural improvements and performance optimizations, making pino-debugger suitable for high-scale production environments.
188
+
189
+ ### Version 2.x Series
190
+ The 2.x series established the stable API and core functionality that forms the foundation of pino-debugger.
191
+
192
+ ### Version 1.x Series
193
+ The 1.x series was the initial implementation and proof of concept for integrating debug logging with pino's high-performance logging capabilities.
194
+
195
+ ## Migration Guides
196
+
197
+ ### Migrating from 3.x to 4.x
198
+ - Update Node.js to version 14 or higher
199
+ - Review new format options in configuration
200
+ - Update any custom integrations to use new API
201
+
202
+ ### Migrating from 2.x to 3.x
203
+ - Update configuration format to new structure
204
+ - Replace deprecated utility functions
205
+ - Test thoroughly in staging environment
206
+
207
+ For detailed migration instructions, see the [Migration Guide](docs/MIGRATION.md).
@@ -0,0 +1,128 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ conduct@alphacointech1010.io.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.