756-vgo-support

[jharshman]

Moves to resolve Issue #756

This is a small change set which allows the cobra generator to work outside of the GOPATH by setting the flag --vgo=<package>. If run without the --vgo flag, the generator flow remains the same.

Changes

• Add a --vgo root persistent flag taking a string representing the package name.
  e.g: --vgo=github.com/spf14/hugo
• If --vgo flag is set, allow init of project outside of GOPATH
• For adding commands, if you are in the project directory when using --vgo, there is no need to specify package name. If you are outside the project directory, you must specify --package equal to the relative directory of your current working directory.

Future improvements

• Cobra relies on the GOPATH to be able to derive the location of packages. I would like to see the weight on this dependency lighten as it is phased out of use in the language.
• I think it's not needed to be able to add commands to projects from anywhere on the system. It's not a feature I really use and am curious if removing it would cause kickback from the community.

[CLAassistant]

All committers have signed the CLA.

[andrewmeissner]

Hi @jharshman, it looks like circleci is reporting a failing check. the go tests pass on my local box with your changes. I'm not sure what else I might be missing, but from my end it should be passing. :/

[jharshman]

@andrewmeissner I'm not sure why there is a failing check there. Looks like it has something to do with bash completions. Will have to investigate this further.

[andrewmeissner]

@jharshman just wanted to check on this. Did anything show up in the bash completions investigation?

Thanks again!

[jharshman]

@andrewmeissner Hadn't had time to do take an in-depth look due to the holidays. I'll give it a go in the next couple days and see what turns up.

[jharshman]

@andrewmeissner ah I see the fix - it's a formatting error. I'll fix it real quick.
Update: All tests pass on my machine - seems to fail on formatting check which passes for me locally.

+diff -u bash_completions_test.go.orig bash_completions_test.go
+--- bash_completions_test.go.orig	2018-12-15 03:03:01.994127122 +0000
++++ bash_completions_test.go	2018-12-15 03:03:01.994127122 +0000
+@@ -71,7 +71,7 @@
+ 		ArgAliases:             []string{"pods", "nodes", "services", "replicationcontrollers", "po", "no", "svc", "rc"},
+ 		ValidArgs:              []string{"pod", "node", "service", "replicationcontroller"},
+ 		BashCompletionFunction: bashCompletionFunc,
+-		Run:                    emptyRun,
++		Run: emptyRun,
+ 	}
+ 	rootCmd.Flags().IntP("introot", "i", -1, "help message for flag introot")
+ 	rootCmd.MarkFlagRequired("introot")

[andrewmeissner]

Hi again, @jharshman , just wanted to follow up on this.

[tsal]

This could be a valid workaround for #795 ?

[andrewmeissner]

@tsal seems like it. As long as cobra can work with modules - I'm a happy camper. :)

[jharshman]

@andrewmeissner #817
I re-worked this a bit more. Closing this PR

[andrewmeissner]

Awesome! Thanks @jharshman !