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

Jump to bottom

Support arbitrary shellcheck config file paths #5571

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Support arbitrary shellcheck config file paths #5571

merged 1 commit into from
Apr 25, 2024

Conversation

ferrarimarco
Copy link
Collaborator

Proposed changes

  • Support passing an arbitrary path to the shellcheck configuration file with the BASH_CONFIG_FILE_NAME variable. This brings shellcheck in line with other linters that support configuration files.
  • Enable shellcheck external sources using a directive in the configuration file, so users can eventually override it if not needed.
  • Export command configuration variables that subprocesses might need.

Close #5414

Readiness checklist

In order to have this pull request merged, complete the following tasks.

Pull request author tasks

  • I included all the needed documentation for this change.
  • I provided the necessary tests.
  • I squashed all the commits into a single commit.
  • I followed the Conventional Commit v1.0.0 spec.
  • I wrote the necessary upgrade instructions in the upgrade guide.
  • If this pull request is about and existing issue,
    I added the Fix #ISSUE_NUMBER label to the description of the pull request.

Super-linter maintainer tasks

  • Label as breaking if this change breaks compatibility with the previous released version.
  • Label as either: automation, bug, documentation, enhancement, infrastructure.

@ferrarimarco ferrarimarco added enhancement New feature or request O: backlog 🤖 Backlog, stale ignores this label labels Apr 24, 2024
@ferrarimarco ferrarimarco self-assigned this Apr 24, 2024
@ferrarimarco ferrarimarco mentioned this pull request Apr 24, 2024
Closed
1 task
@ferrarimarco
feat: support arbitrary shellcheck config paths
5258904 
- Support passing an arbitrary path to the shellcheck configuration file
  with the BASH_CONFIG_FILE_NAME variable. This brings shellcheck in
  line with other linters that support configuration files.
- Enable shellcheck external sources using a directive in the
  configuration file, so users can eventually override it if not needed.
- Export command configuration variables that subprocesses might need.

Close #5414
@ferrarimarco ferrarimarco added this pull request to the merge queue Apr 25, 2024
Merged via the queue into main with commit c26430f Apr 25, 2024
91 checks passed
@ferrarimarco ferrarimarco deleted the shellcheck-config-file branch April 25, 2024 19:53
@github-actions github-actions bot mentioned this pull request Apr 25, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zkoppert zkoppert zkoppert approved these changes

@Hanse00 Hanse00 Awaiting requested review from Hanse00 Hanse00 is a code owner

Assignees

@ferrarimarco ferrarimarco

Labels
enhancement New feature or request O: backlog 🤖 Backlog, stale ignores this label
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support the --rcfile flag when running Shellcheck
2 participants
@ferrarimarco @zkoppert