refactor(misc): Extract common helper functions into a shared script #37
Conversation
This file contains hidden or 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
- Extracted common functions (e.g., `red_output`, `green_output`, `find_dir`) into a new shared `utils.sh` script to reduce duplication across shell scripts. - Updated existing scripts to source `utils.sh` instead of redefining helper functions. - Removed redundant or commented-out code blocks (e.g., drawio and xvfb checks in `docs_preview.sh`).
github-actions
bot
added
the
refactor
Ahzyuan
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Prep Steps
masterbranch (how?)step 6)Type of changes
Description
Purpose
This PR is to improve the readability and maintainability of all
shellscripts inmiscdir.Changes:
misc/utils.sh: the shared file to store all common helper functions, including colorful output functions, virtual env activation function and path location function.misc/check_meta.sh: add author info and load common helper functions frommisc/utils.shinstead of redefining them.misc/docs_preview.sh: same asmisc/check_meta.sh+ fix Python dependency check logic(rectify the variable name and add empty check for lacking list).misc/lint_format.sh: same asmisc/check_meta.sh+ use colorful outputmisc/packaging.sh: same asmisc/check_meta.shmisc/validate_pr_title.sh: same asmisc/check_meta.sh