feat: handle scoped only libs #179
Open
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
|
Hi again! Did you had any time to check this ? |
3 tasks
aymeric-duchein
force-pushed
the
feat-handle-scoped-only-libs
branch
from
32a4fb0
to
0f6b75d
Compare
shaharkazaz
reviewed
Apr 13, 2024
| 'Global keys found with scopedOnly flag active\n' | ||
| ); | ||
| if (config.emitErrorOnExtraKeys) { | ||
| process.exit(2); |
| process.exit(2); | ||
| } | ||
| } | ||
| delete (scopeToKeys as Partial<ScopeMap>).__global; |
There was a problem hiding this comment.
Why do we need to delete the key?
Comment on lines
+32
to
+44
| if (config.scopedOnly) { | ||
| if (Object.keys(result.scopeToKeys.__global).length) { | ||
| logger.log( | ||
| '\n\x1b[31m%s\x1b[0m', | ||
| '⚠️', | ||
| 'Global keys found with scopedOnly flag active\n' | ||
| ); | ||
| if (config.emitErrorOnExtraKeys) { | ||
| process.exit(2); | ||
| } | ||
| } | ||
| delete (result.scopeToKeys as Partial<ScopeMap>).__global; | ||
| } |
There was a problem hiding this comment.
Duplicate code from the builder
| const globalFiles = langs.map((lang) => ({ | ||
| path: `${output}/${lang}.${fileFormat}`, | ||
| })); | ||
| for (const { path } of globalFiles) { |
There was a problem hiding this comment.
Generally speaking, shouldn't we just skip creation if there aren't any keys there? instead of introducing a new config? or maybe introduce "createEmptyFiles" or something, WDYT?
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: 178
Issue Number: 132
As stated in the first linked issue, when using libraries that only need scoped translation you end up with unused files generated because of the "__global" scope.
What is the new behavior?
Using a new scopedOnly option in the config file, we can now tell the builder and finder, to only check for the files in the scopePathMap and ignore everything in the __global scope. If you have the emitErrorOnExtraKeys option enabled you''l get an error if the key builder detects global keys, only a warning otherwise.
With this options, you should now be able to have only one translation file per library per lang and, if you want to, have this file at the root path (rootTranslationsPath option)
Also updated the marker typing according to the second issue.
Does this PR introduce a breaking change?
Other information
I'll add tests and documentation if you feel the PR is acceptable 😄