[PR #1572] [MERGED] Apply shellcheck to all vscodium shell scripts #1764

New Issue

Closed

opened 2025-09-10 23:54:56 -05:00 by giteasync · 0 comments

giteasync commented 2025-09-10 23:54:56 -05:00

Owner

Copy Link

📋 Pull Request Information

Original PR: https://github.com/VSCodium/vscodium/pull/1572
Author: @zpiatt
Created: 7/21/2023
Status: ✅ Merged
Merged: 7/21/2023
Merged by: @daiyam

Base: master ← Head: shellcheck-applied-01

---

📝 Commits (2)

• 3be84ac apply shellcheck; standardize style
• 512cfc8 make requested changes; update api curl

📊 Changes

14 files changed (+84 additions, -79 deletions)

View changed files

📝 build/build.sh (+7 -3)
📝 build/build_docker.sh (+6 -3)
📝 build/linux/appimage/build.sh (+4 -4)
📝 build/update_api.sh (+11 -8)
📝 build/update_patches.sh (+10 -10)
📝 build/windows/msi/build-updates-disabled.sh (+3 -4)
📝 build/windows/msi/build.sh (+1 -3)
📝 build/windows/rtf/make.sh (+1 -1)
📝 icons/build_icons.sh (+32 -34)
📝 stores/snapcraft/check_version.sh (+4 -4)
📝 stores/winget/check_version.sh (+1 -1)
📝 update_version.sh (+1 -1)
📝 utils.sh (+2 -2)
📝 version.sh (+1 -1)

📄 Description

All shell scripts within the VSCodium repository's now pass shellcheck.

1. Fixed glob used in command name ( https://github.com/VSCodium/vscodium/issues/1570 ).
2. Fixed typo causing logical error piping into true ( https://github.com/VSCodium/vscodium/issues/1570 ).
3. Fixed options specified in getopts but not handled by case statement https://www.shellcheck.net/wiki/SC2213
4. Handled invalid flags ( with implied continue ) in case statements ( https://www.shellcheck.net/wiki/SC2220 ).
5. Read error codes directly (style) ( https://www.shellcheck.net/wiki/SC2181 ).
6. Fixed all instances of reading/writing files in same pipeline (https://www.shellcheck.net/wiki/SC2094).
7. Removed legacy back-ticks ( used $( command ) with spaces) (https://www.shellcheck.net/wiki/SC2006).
8. Removed useless cat (https://www.shellcheck.net/wiki/SC2002).
9. Added -r to read commands (https://www.shellcheck.net/wiki/SC2162).

Special shellcheck considerations:

1. shellcheck recommends many style changes for both readability and consistency ( both subjective ). Where applicable I've ignored these messages to conform with the style preference of the project. One example is: https://www.shellcheck.net/wiki/SC2129
2. shellcheck notes when it is unable to follow variables or files when sourced. When applicable, I ignored this message (https://www.shellcheck.net/wiki/SC1091) with a directive (https://github.com/koalaman/shellcheck/wiki/directive).
3. I believe the shellcheck disable messages are a value add, because they cut down on the noise when searching for actual errors.

Other small changes:

1. I standardized all > /dev/null 2>&1 to simply &> /dev/null. I found it both ways and chose the latter.
2. I standardized newlines in if statements and for loops.
3. I standardized all shebangs with #!/usr/bin/env bash.
4. I standardized all tests with [[ ]].

---

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/VSCodium/vscodium/pull/1572 **Author:** [@zpiatt](https://github.com/zpiatt) **Created:** 7/21/2023 **Status:** ✅ Merged **Merged:** 7/21/2023 **Merged by:** [@daiyam](https://github.com/daiyam) **Base:** `master` ← **Head:** `shellcheck-applied-01` --- ### 📝 Commits (2) - [`3be84ac`](https://github.com/VSCodium/vscodium/commit/3be84acaf426ded89c3119f6b279a5cd7fc1e58b) apply shellcheck; standardize style - [`512cfc8`](https://github.com/VSCodium/vscodium/commit/512cfc8683b884c9cb999766b2da1aabea6bcf4d) make requested changes; update api curl ### 📊 Changes **14 files changed** (+84 additions, -79 deletions) <details> <summary>View changed files</summary> 📝 `build/build.sh` (+7 -3) 📝 `build/build_docker.sh` (+6 -3) 📝 `build/linux/appimage/build.sh` (+4 -4) 📝 `build/update_api.sh` (+11 -8) 📝 `build/update_patches.sh` (+10 -10) 📝 `build/windows/msi/build-updates-disabled.sh` (+3 -4) 📝 `build/windows/msi/build.sh` (+1 -3) 📝 `build/windows/rtf/make.sh` (+1 -1) 📝 `icons/build_icons.sh` (+32 -34) 📝 `stores/snapcraft/check_version.sh` (+4 -4) 📝 `stores/winget/check_version.sh` (+1 -1) 📝 `update_version.sh` (+1 -1) 📝 `utils.sh` (+2 -2) 📝 `version.sh` (+1 -1) </details> ### 📄 Description All shell scripts within the `VSCodium` repository's now pass `shellcheck`. 1. Fixed glob used in command name ( [https://github.com/VSCodium/vscodium/issues/1570](https://github.com/VSCodium/vscodium/issues/1570) ). 2. Fixed typo causing logical error piping into `true` ( [https://github.com/VSCodium/vscodium/issues/1570](https://github.com/VSCodium/vscodium/issues/1570) ). 3. Fixed options specified in `getopts` but not handled by case statement [https://www.shellcheck.net/wiki/SC2213](https://www.shellcheck.net/wiki/SC2213) 4. Handled invalid flags ( with implied continue ) in case statements ( [https://www.shellcheck.net/wiki/SC2220](https://www.shellcheck.net/wiki/SC2220) ). 5. Read error codes directly (style) ( [https://www.shellcheck.net/wiki/SC2181](https://www.shellcheck.net/wiki/SC2181) ). 6. Fixed all instances of reading/writing files in same pipeline ([https://www.shellcheck.net/wiki/SC2094](https://www.shellcheck.net/wiki/SC2094)). 8. Removed legacy back-ticks ( used `$( command )` with spaces) ([https://www.shellcheck.net/wiki/SC2006](https://www.shellcheck.net/wiki/SC2006)). 9. Removed useless `cat` ([https://www.shellcheck.net/wiki/SC2002](https://www.shellcheck.net/wiki/SC2002)). 10. Added `-r` to `read` commands ([https://www.shellcheck.net/wiki/SC2162](https://www.shellcheck.net/wiki/SC2162)). Special `shellcheck` considerations: 1. `shellcheck` recommends many style changes for both readability and consistency ( both subjective ). Where applicable I've ignored these messages to conform with the style preference of the project. One example is: [https://www.shellcheck.net/wiki/SC2129](https://www.shellcheck.net/wiki/SC2129) 2. `shellcheck` notes when it is unable to follow variables or files when sourced. When applicable, I ignored this message ([https://www.shellcheck.net/wiki/SC1091](https://www.shellcheck.net/wiki/SC1091)) with a directive ([https://github.com/koalaman/shellcheck/wiki/directive](https://github.com/koalaman/shellcheck/wiki/directive)). 3. I believe the `shellcheck` disable messages are a value add, because they cut down on the noise when searching for actual errors. Other small changes: 1. I standardized all `> /dev/null 2>&1` to simply `&> /dev/null`. I found it both ways and chose the latter. 2. I standardized newlines in `if` statements and `for` loops. 3. I standardized all shebangs with `#!/usr/bin/env bash`. 4. I standardized all tests with `[[ ]]`. --- _{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

giteasync added the pull-request label 2025-09-10 23:54:56 -05:00

giteasync closed this issue 2025-09-10 23:54:56 -05:00

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

master

insider

1.112.01907

1.110.11631

1.110.11607

1.110.11602

1.110.01571

1.109.51242

1.109.41146

1.109.31074

1.109.21026

1.109.01000

1.108.20787

1.108.10359

1.107.18627

1.107.18605

1.106.37943

1.106.37938

1.106.27818

1.105.17075

1.105.17017

1.105.16999

1.105.16954

1.105.06922

1.105.06808

1.104.36664

1.104.26450

1.104.16282

1.104.06131

1.104.06114

1.103.25610

1.103.15539

1.103.15418

1.103.05312

1.102.35058

1.102.24914

1.102.14746

1.102.04606

1.101.24242

1.101.14098

1.101.03933

1.100.33714

1.100.23258

1.100.13210

1.100.03093

1.99.32846

1.99.32704

1.99.32562

1.99.22418

1.99.12392

1.99.02289

1.99.02283

1.99.02277

1.98.2.25078

1.98.2.25077

1.98.2.25072

1.98.1.25070

1.98.0.25067

1.97.2.25045

1.97.1.25044

1.97.0.25037

1.96.4.25026

1.96.4.25017

1.96.3.25013

1.96.2.24355

1.96.1.24353

1.96.0.24352

1.96.0.24347

1.95.3.24321

1.95.3.24320

1.95.2.24313

1.95.1.24307

1.94.2.24286

1.94.2.24284

1.94.1.24283

1.94.0.24282

1.94.0.24281

1.93.1.24256

1.93.0.24253

1.92.2.24228

1.92.1.24225

1.91.1.24193

1.91.0.24190

1.90.2.24171

1.90.1.24165

1.90.0.24158

1.89.1.24130

1.89.0.24127

1.89.0.24126

1.88.1.24104

1.88.1.24102

1.88.0.24096

1.87.2.24072

1.87.1.24068

1.87.0.24060

1.86.2.24057

1.86.2.24054

1.86.2.24053

1.85.2.24019

1.85.1.23348

1.85.0.23343

1.84.2.23319

1.84.2.23317

1.84.2.23314

1.84.0.23306

1.84.1.23311

1.83.0.23283

1.83.1.23285

1.83.0.23277

1.82.3.23277

1.82.2.23257

1.82.0.23250

1.82.1.23255

1.81.1.23222

1.81.0.23216

1.80.1.23208

1.80.2.23209

1.81.0.23215

1.80.0.23188

1.80.1.23194

1.79.2.23166

1.79.1.23164

1.79.0.23159

1.78.1.23131

1.78.2.23132

1.78.1.23130

1.77.3.23102

1.77.1.23095

1.77.2.23101

1.77.0.23095

1.77.0.23093

1.77.0.23090

1.76.0.23062

1.76.1.23069

1.76.2.23074

1.75.1.23040

1.75.0.23033

1.74.3.23010

1.74.2.23007

1.74.0.22342

1.74.1.22349

1.74.2.22355

1.73.1.22314

1.73.0.22306

1.72.2.22289

1.72.2.22286

1.72.1.22284

1.72.0.22279

1.71.2.22258

1.71.1.22256

1.71.0.22245

1.70.2.22230

1.70.1.22229

1.70.1.22228

1.70.1

1.70.0

1.69.2

1.69.1

1.69.0

1.68.1

1.68.0

1.67.2

1.67.1

1.67.0

1.66.2

1.66.1

1.66.0

1.65.1

1.65.2

1.65.0

1.64.1

1.64.2

1.64.0

1.63.1

1.63.2

1.63.0

1.62.3

1.62.2

1.62.1

1.62.0

1.61.2

1.61.0

1.61.1

1.60.2

1.60.1

1.60.0

1.59.1

1.59.0

1.58.2

1.58.0

1.58.1

1.57.1

1.57.0

1.56.0

1.56.1

1.56.2

1.55.0

1.55.1

1.55.2

1.54.2

1.54.3

1.53.1

1.53.2

1.53.0

1.52.1

1.52.0

1.51.0

1.51.1

1.50.1

1.50.0

1.49.2

1.49.3

1.49.1

1.49.0

1.48.1

1.48.2

1.48.0

1.47.0

1.47.1

1.47.2

1.47.3

1.46.0

1.46.1

1.45.0

1.45.1

1.43.2

1.44.0

1.44.1

1.44.2

1.43.1

1.43.0

1.42.0

1.42.1

1.41.1

1.41.0

1.40.2

1.40.0

1.40.1

1.39.0

1.39.1

1.39.2

1.38.1

1.38.0

1.37.1

1.37.0

1.36.1

1.36.0

1.35.1

1.35.0

1.34.0

1.33.1

1.33.0

1.32.2

1.32.3

1.32.1

1.32.0

1.31.1

1.31.0

1.30.2

1.30.0

1.30.1

1.29.1

1.29.0

1.28.2

1.28.1

1.28.0

1.27.2

1.27.1

1.26.1

1.26.0

Labels

Clear labels

bug

bug

discussion

documentation

downstream

duplicate

enhancement

extension

good first issue

help wanted

invalid

never-stale

pull-request

Mirrored from GitHub Pull Request

question

stale

telemetry

upstream

wontfix

No Label pull-request

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

giteasync

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: VSCodium/vscodium#1764