feat(logger): initOptions.debugOptionsFilter #2197
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
we will review your pr... in the meantime, why not just pass your custom logger: https://www.i18next.com/misc/creating-own-plugins#logger ? |
adrai
reviewed
May 22, 2024
| }); | ||
|
|
||
| describe('init log options filtering', () => { | ||
| it('logs a subset of the options object', () => { |
There was a problem hiding this comment.
-it('logs a subset of the options object', () => {
+it('logs the options object', () => {
adrai
reviewed
May 22, 2024
| @@ -350,6 +350,12 @@ export interface InitOptions<T = object> extends PluginOptions<T> { | |||
| */ | |||
| debug?: boolean; | |||
|
|
|||
| /** | |||
| * Filter function that allows changing the logged option value when `debug` is set to true. | |||
There was a problem hiding this comment.
but only for the log statement while init()... maybe the function name needs to respect this?
|
Having this |
|
Oh very cool! Didn't come across the logger override in my searches 🤦🏻♂️ definitely a better approach here. I'll close this... Thank you for the super quick review 🙏🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our Issue
We're using i18next for a react-native project and we'd like to have
debugset to true in dev mode so that we can catch issues with missing strings/keys in the logs. The problem we found is that theinitializationlog event prints a massive object to the console that, in our case, takes 3-4 full screen heights of scrolling to get through. Since this is terminal output, the object isn't interactive or collapsed like in a browser console, so there's a lot of noise in the output ([Object]).Proposed Solution
Allow for an option (
debugOptionsFilter) that allows for passing a function to filter the options object down to the interesting components for users. If provided, the return value would be what's logged by the logger on initialization.Other Notes
I've added two new test suites since this involves
initand I can't re-init in the existing test suite. I've also added a separate debug suite without the filter to cover the existing behaviour when the filter function is not passed in.Some tests were failing for me locally for dates, and I assume it's a timezone issue.
If this is accepted I can update the doc site repo.
Questions
Checklist
npm run test