Skip to content

feat(redact): add excludePaths to exempt fields from pattern scanning#93

Merged
webcoderspeed merged 4 commits into
mainfrom
fix/redaction-and-core-bugs
Jul 24, 2026
Merged

feat(redact): add excludePaths to exempt fields from pattern scanning#93
webcoderspeed merged 4 commits into
mainfrom
fix/redaction-and-core-bugs

Conversation

@webcoderspeed

Copy link
Copy Markdown
Collaborator

Lets callers whitelist fields (e.g. vendor reference ids) whose values coincidentally match aggressive value patterns like phone numbers.

Pull Request

📋 Description

What does this PR do?

Why is this change needed?

Related Issues

  • Fixes #
  • Related to #

🔄 Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🧹 Code cleanup/refactoring
  • ⚡ Performance improvement
  • 🧪 Test improvements
  • 🔧 Build/CI improvements

🧪 Testing

Test Coverage

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this change manually

Test Details

# Commands used for testing
npm test
npm run test:coverage
npm run lint

Manual Testing

📖 Documentation

  • Code comments updated
  • README.md updated
  • API documentation updated
  • Examples updated
  • CHANGELOG.md updated (for significant changes)

🔍 Code Quality

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings or errors
  • I have run the linter and fixed any issues

📦 Dependencies

  • No new dependencies added
  • New dependencies are justified and documented
  • Dependencies are pinned to specific versions
  • Security implications have been considered

🚀 Performance

  • No performance impact
  • Performance impact is minimal and justified
  • Performance improvements included
  • Benchmarks provided (if applicable)

🔒 Security

  • No security implications
  • Security implications have been considered and addressed
  • No sensitive data exposed
  • Input validation added where necessary

📱 Compatibility

  • Node.js versions:
  • Operating Systems:
  • Breaking changes documented
  • Migration guide provided (if needed)

🎃 Hacktoberfest

  • This is a Hacktoberfest contribution
  • I have read and followed the contribution guidelines
  • This PR provides meaningful value (not spam)
  • I understand the project's goals and scope

📸 Screenshots/Examples

Before

After

Code Example

// Example of how to use the new feature
import { Logixia } from 'logixia';

const logger = new Logixia({
  // example configuration
});

// example usage

🔗 Additional Context

Deployment Notes

Rollback Plan

Future Considerations

✅ Reviewer Checklist

  • Code quality meets project standards
  • Tests are comprehensive and pass
  • Documentation is updated and clear
  • Breaking changes are properly documented
  • Security implications reviewed
  • Performance impact acceptable
  • Ready for merge

📝 Notes for Reviewers

🙏 Acknowledgments


Thank you for contributing to Logixia! 🚀

Lets callers whitelist fields (e.g. vendor reference ids) whose values
coincidentally match aggressive value patterns like phone numbers.
@github-actions

Copy link
Copy Markdown

size-limit report 📦

Path Size
ESM (gzipped) 15.05 KB (+0.01% 🔺)
CJS (gzipped) 15.13 KB (+0.01% 🔺)

Sanjeev Sharma and others added 3 commits July 24, 2026 11:12
CI runs `npm install` against a gitignored lockfile, so it resolved the
newest matching sonarjs and surfaced rules absent from the pinned 4.0.3.
Pin the plugin to exact 4.2.0 and resolve the new recommended rules:

- disable sonarjs/no-redundant-optional — it is purely syntactic and
  conflicts with exactOptionalPropertyTypes, where `?: T | undefined`
  is not redundant (dropping it breaks tsc across transports/builder)
- rename stale slow-regex disable comments to super-linear-regex
- parameterize duplicate test blocks, replace generic assertions with
  toBeInstanceOf/toHaveLength, add assertions to next()/done() tests,
  and drop a duplicate test title
Resolve conflict in plugin.comprehensive.test.ts by keeping the branch's
assertion-bearing version of the async onInit test (main had the trivial
`const rejected = false` form that fails sonarjs/no-trivial-assertions).

Also apply toHaveLength to a generic length assertion in the newly merged
basic-search-engine test so the tree satisfies sonarjs 4.2.0.
@webcoderspeed
webcoderspeed merged commit 62d1142 into main Jul 24, 2026
@webcoderspeed
webcoderspeed deleted the fix/redaction-and-core-bugs branch July 24, 2026 07:04
@github-actions

Copy link
Copy Markdown

🎉 This issue has been resolved in version 1.12.0.
Install it: npm install logixia@1.12.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant