Lint: prepare `lib/utilities` for `shellcheck` by gaelicWizard · Pull Request #1933 · Bash-it/bash-it

gaelicWizard · 2021-09-09T01:50:24Z

Description

This is a partial PR covering only the lib/utilities portion of #1917 in support of #1696.

Motivation and Context

My shellcheck branch (#1917) got a bit large, so I'm splitting it up. Each change is split out in to its own commit, so it should be easy to review that way. There are no intended behavior changes whatsoever; this is almost entirely quoting things, plus a few improvements to functions.

How Has This Been Tested?

The full test suite and shellcheck have run on #1917 and this is part of my main branch.

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 · 2021-09-19T08:30:54Z

@cornfeedhobo another PR if you're looking for something to read 😆

NoahGorny · 2021-09-20T12:02:26Z

I like this, this requires a rebase, but looks great overall. You can also add some tests to utilities.bats when you are at it- that would be amazing ❤️

gaelicWizard · 2021-09-20T18:58:45Z

Rebased to current master and all tests pass, including shfmt. I'm working on a branch with a bunch of BATS improvements but that will be later

NoahGorny

Great work @gaelicWizard!
Looking forward for a bats PR 😄

SC2059

Account for plugins with names that contain periods.

Use fewer subprocesses and newline-delimited not space-delimited.

Use fewer subprocesses and return newline-delimited, not space-delimited.

Use `sort -u` instead of `sort | uniq`

Use fewer subprocesses, return newline-delimited instead of space-delimited, and use `sort -u` instead of `uniq | sort`

1. Executing `'/usr/bin/grep'` does *not* return the path to grep... 2. use `type -p` instead of external binary `which`. 3. Simplify parameter definition. 4. Why was there a space after `%s`?

Alsö, lose a spurious `cat`

My apologies to future `git blame` hunters ♥

Use `${BASH_IT_LOAD_PRIORITY_SEPARATOR}`

NoahGorny · 2021-09-28T12:40:24Z

lib/utilities.bash

+	# filename without path
+	filename="${1##*/}"
+	# filename without path or priority
+	filename="${filename##*${BASH_IT_LOAD_PRIORITY_SEPARATOR?}}"


seems like this generates SC2295 warning, somehow this slipped here @gaelicWizard

Go figure! I've got a few tiny changes to utilities pending, so I'll throw that in there.

* master: (113 commits) skip go tests when go is not available plugins: Add ble.sh plugin clean up pyenv plugin Lint: prepare `lib/utilities` for `shellcheck` (Bash-it#1933) plugin/base: improvements (Bash-it#1930) plugins/percol: `bind` completion/git: `shfmt` && `shellcheck` completion/git: expand search range plugin/percol: `shellcheck` & `shfmt` plugins/percol: use `_command_exists` completion/pip: simplify code flow plugin/less-pretty-cat: remove `|| cat` completion/wpscan: simplify code flow (whitespace) plugins/less-pretty-cat: simplify code flow plugins/less-pretty-cat: use `_command_exists` lib/helpers: cite `_bash-it-find-in-ancestor()` gradle: adopt `_bash_it_find_in_ancestor()` lib/helpers: new function `_bash-it-find-in-ancestor()` completion/laravel: simplify code flow plugin/ruby: add missing parameter error message ...

…autosave-history-plml * 'master' of https://github.com/bash-it/bash-it: (114 commits) ci: Bump go to 1.17 from 1.14 skip go tests when go is not available plugins: Add ble.sh plugin clean up pyenv plugin Lint: prepare `lib/utilities` for `shellcheck` (Bash-it#1933) plugin/base: improvements (Bash-it#1930) plugins/percol: `bind` completion/git: `shfmt` && `shellcheck` completion/git: expand search range plugin/percol: `shellcheck` & `shfmt` plugins/percol: use `_command_exists` completion/pip: simplify code flow plugin/less-pretty-cat: remove `|| cat` completion/wpscan: simplify code flow (whitespace) plugins/less-pretty-cat: simplify code flow plugins/less-pretty-cat: use `_command_exists` lib/helpers: cite `_bash-it-find-in-ancestor()` gradle: adopt `_bash_it_find_in_ancestor()` lib/helpers: new function `_bash-it-find-in-ancestor()` completion/laravel: simplify code flow ...

* lib/utilities: shellcheck SC2059 * lib/utilities: fix `_bash-it-get-component-type-from-path()` Account for plugins with names that contain periods. * lib/utilities: fix `_bash-it-array-dedup()` Use fewer subprocesses and newline-delimited not space-delimited. * lib/utilities: fix `_bash-it-component-list()` Use fewer subprocesses and return newline-delimited, not space-delimited. * lib/utilities: fix `_bash-it-component-list-matching()` Use `sort -u` instead of `sort | uniq` * lib/utilities: fix `_bash-it-component-list-enabled()` Use fewer subprocesses, return newline-delimited instead of space-delimited, and use `sort -u` instead of `uniq | sort` * lib/utilities: fix `_bash-it-component-list-disabled()` Use fewer subprocesses, return newline-delimited instead of space-delimited, and use `sort -u` instead of `uniq | sort` * lib/utilities: fix `_bash-it-grep()` 1. Executing `'/usr/bin/grep'` does *not* return the path to grep... 2. use `type -p` instead of external binary `which`. 3. Simplify parameter definition. 4. Why was there a space after `%s`? * lib/utilities: use `_bash-it-grep` Alsö, lose a spurious `cat` * lib/utilities: lint `_bash-it-component-help` * lib/utilities: lint `_bash-it-component-cache-file()` * lib/utilities: `shfmt` My apologies to future `git blame` hunters ♥ * lib/helpers: fix `_bash-it-get-component-name-from-path()` Use `${BASH_IT_LOAD_PRIORITY_SEPARATOR}`

This was referenced Sep 9, 2021

lib/helpers: lint, cleanup, & improvements #1934

Merged

Lib/search: lint, cleanup, and small fixes #1932

Merged

gaelicWizard force-pushed the utilities branch 2 times, most recently from 8cf2192 to c2d0a0c Compare September 9, 2021 05:50

gaelicWizard mentioned this pull request Sep 9, 2021

shellcheck all core files #1917

Closed

6 tasks

gaelicWizard force-pushed the utilities branch 9 times, most recently from 545932f to fa017bf Compare September 17, 2021 20:00

gaelicWizard force-pushed the utilities branch 2 times, most recently from e61622e to a891206 Compare September 18, 2021 20:24

gaelicWizard marked this pull request as ready for review September 19, 2021 07:03

gaelicWizard changed the title ~~DRAFT: Lint: prepare lib/utilities for shellcheck~~ Lint: prepare lib/utilities for shellcheck Sep 19, 2021

gaelicWizard force-pushed the utilities branch from a891206 to 629ab96 Compare September 19, 2021 07:53

gaelicWizard force-pushed the utilities branch 2 times, most recently from 3f40cb4 to 9bb19f7 Compare September 20, 2021 05:42

gaelicWizard mentioned this pull request Sep 20, 2021

Lib/log: linting and small improvements #1959

Merged

6 tasks

gaelicWizard force-pushed the utilities branch from 9bb19f7 to df1b8e1 Compare September 20, 2021 18:52

NoahGorny approved these changes Sep 20, 2021

View reviewed changes

gaelicWizard force-pushed the utilities branch 2 times, most recently from bc700d4 to 3adb998 Compare September 22, 2021 06:25

lib/utilities: shellcheck

44ddd39

SC2059

gaelicWizard added 12 commits September 23, 2021 13:11

lib/utilities: fix _bash-it-get-component-type-from-path()

fe102ff

Account for plugins with names that contain periods.

lib/utilities: fix _bash-it-array-dedup()

bf96d01

Use fewer subprocesses and newline-delimited not space-delimited.

lib/utilities: fix _bash-it-component-list()

91b4d5a

Use fewer subprocesses and return newline-delimited, not space-delimited.

lib/utilities: fix _bash-it-component-list-matching()

e599a95

Use `sort -u` instead of `sort | uniq`

lib/utilities: fix _bash-it-component-list-enabled()

2391ac7

Use fewer subprocesses, return newline-delimited instead of space-delimited, and use `sort -u` instead of `uniq | sort`

lib/utilities: fix _bash-it-component-list-disabled()

120dee2

Use fewer subprocesses, return newline-delimited instead of space-delimited, and use `sort -u` instead of `uniq | sort`

lib/utilities: fix _bash-it-grep()

22ea7d3

1. Executing `'/usr/bin/grep'` does *not* return the path to grep... 2. use `type -p` instead of external binary `which`. 3. Simplify parameter definition. 4. Why was there a space after `%s`?

lib/utilities: use _bash-it-grep

0a3a019

Alsö, lose a spurious `cat`

lib/utilities: lint _bash-it-component-help

b3fd8aa

lib/utilities: lint _bash-it-component-cache-file()

8cf24f1

lib/utilities: shfmt

5fcd16e

My apologies to future `git blame` hunters ♥

lib/helpers: fix _bash-it-get-component-name-from-path()

1f2d3f4

Use `${BASH_IT_LOAD_PRIORITY_SEPARATOR}`

gaelicWizard force-pushed the utilities branch from 3adb998 to 1f2d3f4 Compare September 23, 2021 20:13

NoahGorny merged commit 3eed0f0 into Bash-it:master Sep 28, 2021

NoahGorny reviewed Sep 28, 2021

View reviewed changes

gaelicWizard deleted the utilities branch September 29, 2021 22:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lint: prepare `lib/utilities` for `shellcheck`#1933

Lint: prepare `lib/utilities` for `shellcheck`#1933
NoahGorny merged 13 commits intoBash-it:masterfrom
gaelicWizard:utilities

gaelicWizard commented Sep 9, 2021 •

edited

Loading

Uh oh!

gaelicWizard commented Sep 19, 2021

Uh oh!

NoahGorny commented Sep 20, 2021

Uh oh!

gaelicWizard commented Sep 20, 2021

Uh oh!

NoahGorny left a comment

Uh oh!

NoahGorny Sep 28, 2021

Uh oh!

gaelicWizard Oct 10, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

gaelicWizard commented Sep 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

gaelicWizard commented Sep 19, 2021

Uh oh!

NoahGorny commented Sep 20, 2021

Uh oh!

gaelicWizard commented Sep 20, 2021

Uh oh!

NoahGorny left a comment

Choose a reason for hiding this comment

Uh oh!

NoahGorny Sep 28, 2021

Choose a reason for hiding this comment

Uh oh!

gaelicWizard Oct 10, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gaelicWizard commented Sep 9, 2021 •

edited

Loading