-
Notifications
You must be signed in to change notification settings - Fork 233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Add devtool text optimizer #4189
Closed
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
EthanYuan
force-pushed
the
tool-text-optimizer
branch
from
October 30, 2023 00:47
6c76d10
to
5860cd2
Compare
2 optimize log display
…not be duplicated. In case of duplication, different line numbers will be recorded
EthanYuan
force-pushed
the
tool-text-optimizer
branch
from
November 20, 2023 13:38
5860cd2
to
1e493a8
Compare
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
This PR was closed because it has been stalled for 10 days with no activity. |
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.
What problem does this PR solve?
Problem Summary:
CKB, being an executable program, produces a wide array of output messages during its runtime. These messages include console logs, error notifications, and text displayed within subcommands. These texts are authored by different developers at different stages of the development process, resulting in variations in language style and the possibility of syntax errors.
Optimizing these messages by manually going through the code is very difficult. This is because the code is very large, and these text messages are spread all over it.
Hence, what we require is a tool that can efficiently gather these texts and, after optimization, precisely reintegrate them into the source code.
What is changed and how it works?
We conducted research on solutions based on "regex" and "i18n". For the current PR, we have chosen an approach based on source code analysis using dtolnay/syn. With this approach, we will gain the following advantages:
The extracted text will be saved in a YAML file, and here is an overview:
Check List
Tests
Release note