Skip to content
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.

Sign up for GitHub

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

scripts/deploy.sh: add handmade linter for translation-related json files to check for tabs and odd spaces #2064

Merged
merged 10 commits into from
Feb 1, 2025
Merged

scripts/deploy.sh: add handmade linter for translation-related json files to check for tabs and odd spaces #2064

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a47c96
scripts/deploy.sh: add handmade linter for translation-related json f…
ia Jan 31, 2025
a482829
scripts/deploy.sh: fix Translation/ location
ia Jan 31, 2025
c2c968a
scripts/deploy.sh: make shellcheck happy
ia Feb 1, 2025
4508722
scripts/deploy.sh: fix condition for checking new release in README
ia Feb 1, 2025
5c69a9b
workflows/push.yml: set docs checks using bash instead of sh
ia Feb 1, 2025
9dd095b
scripts/deploy.sh: improve error output for json checks
ia Feb 1, 2025
3bfcbc0
scripts/deploy.sh: add missing new line separators for error messages…
ia Feb 1, 2025
201e9b9
translation_UZ.json: fix code style discovered by json checks
ia Feb 1, 2025
664ff73
scripts/deploy.sh: add tests for autotests related to main README and…
ia Feb 1, 2025
ac46806
scripts/deploy.sh: simplify grep command to detect odd spaces in json…
ia Feb 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ jobs:

steps:
- name: Install dependencies (apk)
run: apk add --no-cache git
run: apk add --no-cache git bash grep

- uses: actions/checkout@v4
with:
Expand All @@ -227,4 +227,4 @@ jobs:
run: git config --global --add safe.directory /__w/IronOS/IronOS && git config --global safe.directory "$GITHUB_WORKSPACE"

- name: Check and verify documentation
run: /bin/sh ./scripts/deploy.sh docs
run: ./scripts/deploy.sh docs
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ test-md:
@echo ""
@echo "---- Checking documentation... ----"
@echo ""
@/bin/sh ./scripts/deploy.sh docs
@./scripts/deploy.sh docs

# shell style & linter check (github CI version of shellcheck is more recent than alpine one so the latter may not catch some policies)
test-sh:
Expand Down
2 changes: 1 addition & 1 deletion Translations/translation_UZ.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
"menuOptions": {
"DCInCutoff": {
"displayText": "Quvvat\nmanbai",
"description": "Batareya haddan tashqari zaryadsizlanishini oldini olish uchun kuchlanish chegarasini o'rnatish (DC 10V) (S=3.3V har bir yacheyka uchun, quvvat PWR chegarasini o'chirish)"
"description": "Batareya haddan tashqari zaryadsizlanishini oldini olish uchun kuchlanish chegarasini o'rnatish (DC 10V) (S=3.3V har bir yacheyka uchun, quvvat PWR chegarasini o'chirish)"
},
"MinVolCell": {
"displayText": "Minimal\nkuchlanish",
Expand Down
30 changes: 26 additions & 4 deletions scripts/deploy.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ docs_links()
md="README.md"
ver_md="$(grep -c "${ver_git}" "${md}")"
ret=0
if [ "${ver_md}" -ne 0 ]; then
if [ "${ver_md}" -eq 0 ]; then
Copy link
Collaborator Author

@ia ia Feb 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the right way, and it was wrong, but it didn't trigger any errors, because at this point local directory was Translations/ (because I forgot to add cd .., which is now on the line 119 120 below).

UPD: also added a couple of checks hopefully to avoid this in the future.

ret=1
echo "Please, update mention & links in ${md} inside Builds section for release builds with version ${ver_git}."
fi;
Expand All @@ -110,14 +110,36 @@ build_langs()
mk="../source/Makefile"
cd Translations/ || exit 1
langs="$(echo "$(find ./*.json | sed -ne 's,^\./translation_,,; s,\.json$,,; /[A-Z]/p' ; sed -ne 's/^ALL_LANGUAGES=//p;' "${mk}")" | sed 's, ,\n,g; s,\r,,g' | sort | uniq -u)"
ret=0
if [ -n "${langs}" ]; then
ret=1
echo "It seems there is mismatch between supported languages and enabled builds."
echo "Please, check files in Translations/ and ALL_LANGUAGES variable in source/Makefile for:"
echo "${langs}"
return 1
fi;
return "${ret}"
cd ..

echo -ne "\n"
grep -nH $'\11' Translations/translation*.json
ret="${?}"
if [ "${ret}" -eq 0 ]; then
echo -ne "\t^^^^\t^^^^\n"
echo "Please, remove any tabs as indention from json file(s) in Translations/ directory (see the exact files & lines in the list above)."
echo "Use spaces only to indent in the future, please."
echo -ne "\n"
return 1
fi;

grep -nH -e "^ [^ ]" -e "^ [^ ]" -e "^ [^ ]" -e "^ [^ ]" -e "^ [^ ]" -e "^ [^ ]" Translations/translation*.json
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe less efficient computational wise, but at least we don't need to second guess we counted the white spaces in the grep patterns

awk -F '[^ ].*' 'BEGIN{ex=1} length($1) % 2 == 1 {ex=0; printf "%s:%s: %s\n", FILENAME, FNR, $0} END{exit ex}' Translations/translation*.json

Copy link

@yo3fxy yo3fxy Feb 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or variant of your grep command

grep -nEH -e "^ [^ ]" -e "^ {3}[^ ]" -e "^ {5}[^ ]" -e "^ {7}[^ ]" -e "^ [9]{^ ]" -e "^ {11}[^ ]" Translations/translation*.json

edit: more compact version of previous grep alternative

grep -nEH -e "^( {1}| {3}| {5}| {7}| {9}| {11})[^ ]" Translations/translation*.json

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe less efficient computational wise, but at least we don't need to second guess we counted the white spaces in the grep patterns

awk [...]

I use awk myself from time to time for very basic patterns, mostly to filter content based on custom separators. But I try not to stuff too much extra tools here, because most of builds & tests taking place inside Alpine Linux environment, which is very minimal and every extra tool require to be installed as a separate package. So, since we already use grep, I try to utilize it. Hence, that's why I stick to grep here.

Copy link
Collaborator Author

@ia ia Feb 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

edit: more compact version of previous grep alternative

grep -nEH -e "^( {1}| {3}| {5}| {7}| {9}| {11})[^ ]" Translations/translation*.json

Thanks for help! I will add it as soon as possible. I was thinking to implement this in similar way, but for some reason I thought that just leaving spaces will be more easy to understand in the future, but I really like your suggestion.

UPD: Done. I checked briefly on macOS with BSD grep - works as well.

ret="${?}"
if [ "${ret}" -eq 0 ]; then
echo -ne "\t^^^^\t^^^^\n"
echo "Please, remove any odd amount of extra spaces as indention from json file(s) in Translations/ directory (see the exact files & lines in the list above)."
echo "Use even amount of spaces to indent in the future, please (two actual spaces per one indent, not tab)."
echo -ne "\n"
return 1
fi;

return 0
}

# Helper function to check code style using clang-format & grep/sed custom parsers:
Expand Down