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.

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

Delete .shellcheckrc #1947

Merged
merged 22 commits into from
Sep 18, 2021
Merged

Delete .shellcheckrc #1947

merged 22 commits into from
Sep 18, 2021

Conversation

gaelicWizard
Copy link
Contributor

@gaelicWizard gaelicWizard commented Sep 14, 2021

Description

Turns out that there is a file in the repo root which disabled checks for unbound variables. This fixes #1923.

Motivation and Context

I've done a lot of work finding and fixing these problems...which would have been detected by shellcheck if it hadn't been disabled.

  • SC2034: unused variables are hard for shellcheck to detect because the theme doesn't use what it sets, but the prompt does.
  • SC2155: I've been trying to fix these too, but manually without a linter; usually harmless, but not always.
  • SC2154: this should never have been ignored. This causes silent errors without nounset, and loud errors with nounset

Since my unbound branch was already merged, there's only a couple that are missing SC2154 (from already-linted files). I've alsö disabled SC2034 in the colors lib, since that file is basically entirely that and SC2005.

I've alsö gone through and fixed the CI linter for already-linted themes, plugins, and completions, with the exception of unbound parameters in themes. For the themes, I've just disabled the message to be fixed later.

How Has This Been Tested?

I've run shellcheck myself. All CI tests pass, CI linter passes, CI formatter comes back clean.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code follows the code style of this project.
  • If my change requires a change to the documentation, I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • If I have added a new file, I also added it to clean_files.txt and formatted it using lint_clean_files.sh.
  • I have added tests to cover my changes, and all the new and existing tests pass.

@gaelicWizard
Copy link
Contributor Author

@NoahGorny, can you take a look at this one? I'd like to get this merged before I do anything else.

@gaelicWizard gaelicWizard force-pushed the shellcheckrc branch 10 times, most recently from 2b081e0 to 9c57ed5 Compare September 15, 2021 05:17
@NoahGorny
Copy link
Member

Hi @gaelicWizard- great work!
This seems like a huge diff, but really isn't. I will try to look at this in the upcoming days in order to merge it

@gaelicWizard gaelicWizard force-pushed the shellcheckrc branch 2 times, most recently from 8cf1e89 to ecfbb2d Compare September 15, 2021 17:18
Copy link
Member

@NoahGorny NoahGorny left a comment

Choose a reason for hiding this comment

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

I had only a comment, otherwise lgtm

.github/workflows/ci.yml Show resolved Hide resolved
We assign a large number of variables here and they may or may not be used anywhere else, so disable SC2034 for this file (only).

Alsö disable SC2005 as the functions in this file were written before `printf` was invented and have to do some fancy metascripting to get escape sequences interpreted reliably. I’m not smart enough to fix this to use `printf`, so leave it for now.
Each one of these themes will need it’s own fix for SC2154, possibly upstream.

Due to the way themes are, it's entirely normal to have a *lot* of false positives for SC2034. So much so, that I have to admit that it is probably just not worth linting for SC2034 despite my dislike of blanket ignore rules.
Each one of these themes will need it’s own fix for SC2154, possibly upstream.

Due to the way themes are, it's entirely normal to have a *lot* of false positives for SC2034. So much so, that I have to admit that it is probably just not worth linting for SC2034 despite my dislike of blanket ignore rules.
@NoahGorny NoahGorny merged commit 1c3cbf7 into Bash-it:master Sep 18, 2021
@gaelicWizard gaelicWizard deleted the shellcheckrc branch September 18, 2021 20:16
catull pushed a commit to catull/bash-it that referenced this pull request Oct 21, 2021
* CI: disable Ubuntu 16.04 as it's EOL

https://github.blog/changelog/2021-04-29-github-actions-ubuntu-16-04-lts-virtual-environment-will-be-removed-on-september-20-2021/

* main: lint false positive

* install: lint

* plugins/cmd-returned-notify: don't `export`

* plugins/xterm: lint

* plugins/git: lint

* plugins/goenv: lint

* plugins/alias-completion: lint false positives

* plugins/alias-completion: fix SC2155, SC2154

Declare `locals` at the top of the function

* completion: lint completions using `bash_completion` functions

Match the style of the existing code

* completion/knife: lint false positives

* completion/knife: lint

* completion/sdkman: lint

* completion/composer: lint

* Move `.shellcheckrc` under `themes/`

* lib/theme: fix SC2155, SC2154, SC2034

* lib/colors: don't warn on unused variables

We assign a large number of variables here and they may or may not be used anywhere else, so disable SC2034 for this file (only).

Alsö disable SC2005 as the functions in this file were written before `printf` was invented and have to do some fancy metascripting to get escape sequences interpreted reliably. I’m not smart enough to fix this to use `printf`, so leave it for now.

* themes/agnoster: lint

* themes: disable SC2154 for colors

Each one of these themes will need it’s own fix for SC2154, possibly upstream.

Due to the way themes are, it's entirely normal to have a *lot* of false positives for SC2034. So much so, that I have to admit that it is probably just not worth linting for SC2034 despite my dislike of blanket ignore rules.

* themes: disable SC2154, fix SC2155

Each one of these themes will need it’s own fix for SC2154, possibly upstream.

Due to the way themes are, it's entirely normal to have a *lot* of false positives for SC2034. So much so, that I have to admit that it is probably just not worth linting for SC2034 despite my dislike of blanket ignore rules.

* Delete `.shellcheckrc`

* remove executable bit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

set -u in the tests
2 participants