Vendoring the composure #1820

buhl · 2021-01-28T22:53:58Z

Description

As per #1818
This still needs a little love.
I had to move up the loading of vendored libs because composure was loaded as the first thing in bash_it.sh
This means I can't use __log_debug when loading vendored libs. A decision has to be made on what we do with this issue.

Also my linting has started to replace spaces with tabs in files. I am not sure if this is an error on my part, if it is, I need some help to fix it. So this PR looks bigger than it had to be.

Once we settle on what to do with the logging I will finish adding files to clean_files and such.

Types of changes

Moved the composure library to the vendor folder

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.

buhl · 2021-01-28T22:56:44Z

hmm, the tests are failing. I had to add the .bash extension locally to make them work. It seems like the CI test would like me to remove them?

buhl · 2021-01-28T23:32:10Z

This bats loading thing got a little messy. I will have to clean-up/rebase the branch before it's ready for a merge.
I don't get why I sometimes need the .bash ext on load in bats files and sometimes don't.
also the check for bad/missing shellcheck header is a little annoying when a file might need a she-bang header 😅
@NoahGorny This is ready for a preliminary review.

cornfeedhobo · 2021-01-28T23:45:54Z

There is a lot that I'd like to change and I think a full review would get messy. I might make a branch, but might resort to a bunch of comments...

Edit: glad you isolated this to it's own PR though 😆

buhl · 2021-01-29T07:18:37Z

@cornfeedhobo

Yeah, I consider the PR a POC for now.
It was a pretty big rewrite so I am ready for many comments/ideas/opinions.
I am in no way married to how this PR turned out. So comments or other branches are welcome 😊
It's also a good idea for some maintainers to try using 'git vendor' before many more things are vendored 😊

NoahGorny · 2021-01-29T14:14:49Z

Hey @buhl , well done!

I think that an easier solution would be to source composure just like we did before, and make lib/composure.bash just load the correct file/symlink. Alternatively, we can just load the init.d/composure script directly at the start, in any case, this will enable us to continue logging and avoid major changes to the way we load components

cornfeedhobo · 2021-01-29T14:24:44Z

Alternatively, we can just load the init.d/composure script directly at the start

This is where I would go with this. I actually want to kill the loop loader and explicitly source libraries, in order, anyways. We don't have so many that the list would be unwieldy, so I've come to see the loop as an unneeded abstraction.

Edit: Also I would just source from vendor and scrap the init.d. If we really wanted to keep the init.d convention, then I think files there should be prefixed with a number to guarantee load order.

buhl · 2021-01-29T16:15:41Z

I like these solutions. I will refactor the load of composure in this PR to just source the file directly from the vendor folder in the top of bash_it.sh this also correspond well with what as discussed here #1818 (comment)
I will make another PR doing the same for preexec to keep things separate. That PR would then also remove the loop.

Another function the files in vendor/init.d had was to give a place where we could and some extra functions/settings around a vendored lib. This functionality we could move to a file in the lib/ folder if needed.

NoahGorny

I left some comments, but this seems like a pretty clean and good change! nice work!

install.sh

bash_it.sh

install.sh

buhl · 2021-01-29T22:26:45Z

I still need to make sure files are added to clean_files.txt and the branch needs a little rebasing - to many pointless commits.
I will do these last steps once everything else is ready for merge.

…3698d git-subtree-dir: vendor/github.com/erichs/composure git-subtree-split: 5c3698df33cf92f9dbe75b807b1d29729989baaa

git-vendor-name: composure git-vendor-dir: vendor/github.com/erichs/composure git-vendor-repository: https://github.com/erichs/composure git-vendor-ref: 1.3.1

buhl · 2021-01-31T14:08:15Z

I have rebased and forced pushed this branch. If the changes can be accepted it's ready for merge

Also by merging this PR #872 can be closed I think.

bash_it.sh

NoahGorny

well done @buhl
I have left some small comments, I will look again after you will address them 😄

bash_it.sh

cornfeedhobo · 2021-02-02T14:06:12Z

@buhl I'm going to make that branch when I have free time today, but you can also look at #1823 to get a sense of what I was meaning about loading in order, explicitly.

Fixed tests Fixed install.sh and bash_it.sh Added gitattributes to the vendor folder Changed documentation

buhl · 2021-02-02T15:34:57Z

I fixed the last two comments and force pushed the branch.

NoahGorny

LGTM, well done @buhl !!

cornfeedhobo

@buhl I think this looks great! @NoahGorny great CR. We should definitely get this work merged and deal with any tinkering in follow up PRs.

NoahGorny reviewed Jan 29, 2021

View reviewed changes

install.sh Outdated Show resolved Hide resolved

install.sh Outdated Show resolved Hide resolved

bash_it.sh Show resolved Hide resolved

NoahGorny reviewed Jan 29, 2021

View reviewed changes

install.sh Show resolved Hide resolved

buhl added 2 commits January 31, 2021 14:56

Squashed 'vendor/github.com/erichs/composure/' content from commit 5c…

90dd69c

…3698d git-subtree-dir: vendor/github.com/erichs/composure git-subtree-split: 5c3698df33cf92f9dbe75b807b1d29729989baaa

Add "composure" from "https://github.com/erichs/composure@1.3.1"

a0b6c49

git-vendor-name: composure git-vendor-dir: vendor/github.com/erichs/composure git-vendor-repository: https://github.com/erichs/composure git-vendor-ref: 1.3.1

buhl force-pushed the composure branch from 76d306b to 89a198a Compare January 31, 2021 14:04

cornfeedhobo reviewed Jan 31, 2021

View reviewed changes

bash_it.sh Show resolved Hide resolved

buhl force-pushed the composure branch from 89a198a to a7e113a Compare January 31, 2021 14:26

buhl requested a review from NoahGorny February 1, 2021 19:14

NoahGorny requested changes Feb 2, 2021

View reviewed changes

bash_it.sh Outdated Show resolved Hide resolved

bash_it.sh Outdated Show resolved Hide resolved

NoahGorny mentioned this pull request Feb 2, 2021

Cleanup and load libraries explicitly #1823

Closed

8 tasks

Getting Bash-it to use the vendored composure

49d7d2e

Fixed tests Fixed install.sh and bash_it.sh Added gitattributes to the vendor folder Changed documentation

buhl force-pushed the composure branch from a7e113a to 49d7d2e Compare February 2, 2021 15:34

buhl requested a review from NoahGorny February 2, 2021 15:44

NoahGorny approved these changes Feb 2, 2021

View reviewed changes

cornfeedhobo approved these changes Feb 3, 2021

View reviewed changes

NoahGorny merged commit ce6487f into Bash-it:master Feb 3, 2021

buhl deleted the composure branch February 3, 2021 09:30

buhl mentioned this pull request Feb 4, 2021

Added composure as a submodule, replaced composure.bash with a symlink #872

Closed

davidpfarrell mentioned this pull request Mar 8, 2021

bash-it help plugins doesn't work #1846

Closed

NoahGorny mentioned this pull request Mar 21, 2021

helpers: Fix broken compoure references after vendor change #1856

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vendoring the composure #1820

Vendoring the composure #1820

buhl commented Jan 28, 2021 •

edited

Loading

buhl commented Jan 28, 2021

buhl commented Jan 28, 2021

cornfeedhobo commented Jan 28, 2021 •

edited

Loading

buhl commented Jan 29, 2021

NoahGorny commented Jan 29, 2021

cornfeedhobo commented Jan 29, 2021 •

edited

Loading

buhl commented Jan 29, 2021

NoahGorny left a comment

buhl commented Jan 29, 2021

buhl commented Jan 31, 2021

NoahGorny left a comment

cornfeedhobo commented Feb 2, 2021

buhl commented Feb 2, 2021

NoahGorny left a comment

cornfeedhobo left a comment

Vendoring the composure #1820

Vendoring the composure #1820

Conversation

buhl commented Jan 28, 2021 • edited Loading

Description

Types of changes

Checklist:

buhl commented Jan 28, 2021

buhl commented Jan 28, 2021

cornfeedhobo commented Jan 28, 2021 • edited Loading

buhl commented Jan 29, 2021

NoahGorny commented Jan 29, 2021

cornfeedhobo commented Jan 29, 2021 • edited Loading

buhl commented Jan 29, 2021

NoahGorny left a comment

Choose a reason for hiding this comment

buhl commented Jan 29, 2021

buhl commented Jan 31, 2021

NoahGorny left a comment

Choose a reason for hiding this comment

cornfeedhobo commented Feb 2, 2021

buhl commented Feb 2, 2021

NoahGorny left a comment

Choose a reason for hiding this comment

cornfeedhobo left a comment

Choose a reason for hiding this comment

buhl commented Jan 28, 2021 •

edited

Loading

cornfeedhobo commented Jan 28, 2021 •

edited

Loading

cornfeedhobo commented Jan 29, 2021 •

edited

Loading