forked from Masterminds/glide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glide.go
690 lines (641 loc) · 22.5 KB
/
glide.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
// Glide is a command line utility that manages Go project dependencies and
// your GOPATH.
//
// Dependencies are managed via a glide.yaml in the root of a project. The yaml
//
// Params:
// - filename (string): The name of the glide YAML file. Default is glide.yaml.
// - project (string): The name of the project. Default is 'main'.
// file lets you specify projects, versions (tags, branches, or references),
// and even alias one location in as other one. Aliasing is useful when supporting
// forks without needing to rewrite the imports in a codebase.
//
// A glide.yaml file looks like:
//
// package: github.com/Masterminds/glide
// imports:
// - package: github.com/Masterminds/cookoo
// vcs: git
// ref: 1.1.0
// subpackages: **
// - package: github.com/kylelemons/go-gypsy
// subpackages: yaml
//
// Glide puts dependencies in a vendor directory. Go utilities require this to
// be in your GOPATH. Glide makes this easy. Use the `glide in` command to enter
// a shell (your default) with the GOPATH set to the projects vendor directory.
// To leave this shell simply exit it.
//
// If your .bashrc, .zshrc, or other startup shell sets your GOPATH you many need
// to optionally set it using something like:
//
// if [ "" = "${GOPATH}" ]; then
// export GOPATH="/some/dir"
// fi
//
// For more information use the `glide help` command or see https://github.com/Masterminds/glide
package main
import (
"path/filepath"
"github.com/Masterminds/glide/action"
"github.com/Masterminds/glide/msg"
gpath "github.com/Masterminds/glide/path"
"github.com/Masterminds/glide/repo"
"github.com/Masterminds/glide/util"
"github.com/codegangsta/cli"
"fmt"
"os"
"os/user"
)
var version = "0.11.0-dev"
const usage = `The lightweight vendor package manager for your Go projects.
Each project should have a 'glide.yaml' file in the project directory. Files
look something like this:
package: github.com/Masterminds/glide
imports:
- package: github.com/Masterminds/cookoo
vcs: git
ref: 1.1.0
subpackages: **
- package: github.com/kylelemons/go-gypsy
subpackages: yaml
flatten: true
NOTE: As of Glide 0.5, the commands 'into', 'gopath', 'status', and 'env'
no longer exist.
`
// VendorDir default vendor directory name
var VendorDir = "vendor"
func main() {
app := cli.NewApp()
app.Name = "glide"
app.Usage = usage
app.Version = version
app.Flags = []cli.Flag{
cli.StringFlag{
Name: "yaml, y",
Value: "glide.yaml",
Usage: "Set a YAML configuration file.",
},
cli.BoolFlag{
Name: "quiet, q",
Usage: "Quiet (no info or debug messages)",
},
cli.BoolFlag{
Name: "debug",
Usage: "Print Debug messages (verbose)",
},
cli.StringFlag{
Name: "home",
Value: defaultGlideDir(),
Usage: "The location of Glide files",
EnvVar: "GLIDE_HOME",
},
cli.BoolFlag{
Name: "no-color",
Usage: "Turn off colored output for log messages",
},
}
app.CommandNotFound = func(c *cli.Context, command string) {
// TODO: Set some useful env vars.
action.Plugin(command, os.Args)
}
app.Before = startup
app.Commands = commands()
// Detect errors from the Before and After calls and exit on them.
if err := app.Run(os.Args); err != nil {
msg.Err(err.Error())
os.Exit(1)
}
// If there was a Error message exit non-zero.
if msg.HasErrored() {
m := msg.Color(msg.Red, "An Error has occurred")
msg.Msg(m)
os.Exit(2)
}
}
func commands() []cli.Command {
return []cli.Command{
{
Name: "create",
ShortName: "init",
Usage: "Initialize a new project, creating a glide.yaml file",
Description: `This command starts from a project without Glide and
sets it up. It generates a glide.yaml file, parsing your codebase to guess
the dependencies to include. Once this step is done you may edit the
glide.yaml file to update imported dependency properties such as the version
or version range to include.
To fetch the dependencies you may run 'glide install'.`,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "skip-import",
Usage: "When initializing skip importing from other package managers.",
},
},
Action: func(c *cli.Context) {
action.Create(".", c.Bool("skip-import"))
},
},
{
Name: "get",
Usage: "Install one or more packages into `vendor/` and add dependency to glide.yaml.",
Description: `Gets one or more package (like 'go get') and then adds that file
to the glide.yaml file. Multiple package names can be specified on one line.
$ glide get github.com/Masterminds/cookoo/web
The above will install the project github.com/Masterminds/cookoo and add
the subpackage 'web'.
If a fetched dependency has a glide.yaml file, configuration from Godep,
GPM, or GB Glide that configuration will be used to find the dependencies
and versions to fetch. If those are not available the dependent packages will
be fetched as either a version specified elsewhere or the latest version.
When adding a new dependency Glide will perform an update to work out the
the versions to use from the dependency tree. This will generate an updated
glide.lock file with specific locked versions to use.
If you are storing the outside dependencies in your version control system
(VCS), also known as vendoring, there are a few flags that may be useful.
The '--update-vendored' flag will cause Glide to update packages when VCS
information is unavailable. This can be used with the '--strip-vcs' flag which
will strip VCS data found in the vendor directory. This is useful for
removing VCS data from transitive dependencies and initial setups. The
'--strip-vendor' flag will remove any nested 'vendor' folders and
'Godeps/_workspace' folders after an update (along with undoing any Godep
import rewriting). Note, The Godeps specific functionality is deprecated and
will be removed when most Godeps users have migrated to using the vendor
folder.`,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "insecure",
Usage: "Use http:// rather than https:// to retrieve pacakges.",
},
cli.BoolFlag{
Name: "no-recursive, quick",
Usage: "Disable updating dependencies' dependencies.",
},
cli.BoolFlag{
Name: "force",
Usage: "If there was a change in the repo or VCS switch to new one. Warning, changes will be lost.",
},
cli.BoolFlag{
Name: "all-dependencies",
Usage: "This will resolve all dependencies for all packages, not just those directly used.",
},
cli.BoolFlag{
Name: "update-vendored, u",
Usage: "Update vendored packages (without local VCS repo). Warning, changes will be lost.",
},
cli.BoolFlag{
Name: "cache",
Usage: "When downloading dependencies attempt to cache them.",
},
cli.BoolFlag{
Name: "cache-gopath",
Usage: "When downloading dependencies attempt to put them in the GOPATH, too.",
},
cli.BoolFlag{
Name: "use-gopath",
Usage: "Copy dependencies from the GOPATH if they exist there.",
},
cli.BoolFlag{
Name: "resolve-current",
Usage: "Resolve dependencies for only the current system rather than all build modes.",
},
cli.BoolFlag{
Name: "strip-vcs, s",
Usage: "Removes version control metada (e.g, .git directory) from the vendor folder.",
},
cli.BoolFlag{
Name: "strip-vendor, v",
Usage: "Removes nested vendor and Godeps/_workspace directories. Requires --strip-vcs.",
},
},
Action: func(c *cli.Context) {
if c.Bool("strip-vendor") && !c.Bool("strip-vcs") {
msg.Die("--strip-vendor cannot be used without --strip-vcs")
}
if len(c.Args()) < 1 {
fmt.Println("Oops! Package name is required.")
os.Exit(1)
}
if c.Bool("resolve-current") {
util.ResolveCurrent = true
msg.Warn("Only resolving dependencies for the current OS/Arch")
}
inst := repo.NewInstaller()
inst.Force = c.Bool("force")
inst.UseCache = c.Bool("cache")
inst.UseGopath = c.Bool("use-gopath")
inst.UseCacheGopath = c.Bool("cache-gopath")
inst.UpdateVendored = c.Bool("update-vendored")
inst.ResolveAllFiles = c.Bool("all-dependencies")
packages := []string(c.Args())
insecure := c.Bool("insecure")
action.Get(packages, inst, insecure, c.Bool("no-recursive"), c.Bool("strip-vcs"), c.Bool("strip-vendor"))
},
},
{
Name: "remove",
ShortName: "rm",
Usage: "Remove a package from the glide.yaml file, and regenerate the lock file.",
Description: `This takes one or more package names, and removes references from the glide.yaml file.
This will rebuild the glide lock file with the following constraints:
- Dependencies are re-negotiated. Any that are no longer used are left out of the lock.
- Minor version re-nogotiation is performed on remaining dependencies.
- No updates are peformed. You may want to run 'glide up' to accomplish that.`,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "delete,d",
Usage: "Also delete from vendor/ any packages that are no longer used.",
},
},
Action: func(c *cli.Context) {
if len(c.Args()) < 1 {
fmt.Println("Oops! At least one package name is required.")
os.Exit(1)
}
if c.Bool("delete") {
// FIXME: Implement this in the installer.
fmt.Println("Delete is not currently implemented.")
}
inst := repo.NewInstaller()
inst.Force = c.Bool("force")
packages := []string(c.Args())
action.Remove(packages, inst)
},
},
{
Name: "import",
Usage: "Import files from other dependency management systems.",
Subcommands: []cli.Command{
{
Name: "godep",
Usage: "Import Godep's Godeps.json files and display the would-be yaml file",
Flags: []cli.Flag{
cli.StringFlag{
Name: "file, f",
Usage: "Save all of the discovered dependencies to a Glide YAML file.",
},
},
Action: func(c *cli.Context) {
action.ImportGodep(c.String("file"))
},
},
{
Name: "gpm",
Usage: "Import GPM's Godeps and Godeps-Git files and display the would-be yaml file",
Flags: []cli.Flag{
cli.StringFlag{
Name: "file, f",
Usage: "Save all of the discovered dependencies to a Glide YAML file.",
},
},
Action: func(c *cli.Context) {
action.ImportGPM(c.String("file"))
},
},
{
Name: "gb",
Usage: "Import gb's manifest file and display the would-be yaml file",
Flags: []cli.Flag{
cli.StringFlag{
Name: "file, f",
Usage: "Save all of the discovered dependencies to a Glide YAML file.",
},
},
Action: func(c *cli.Context) {
action.ImportGB(c.String("file"))
},
},
{
Name: "gom",
Usage: "Import Gomfile and display the would-be yaml file",
Flags: []cli.Flag{
cli.StringFlag{
Name: "file, f",
Usage: "Save all of the discovered dependencies to a Glide YAML file.",
},
},
Action: func(c *cli.Context) {
action.ImportGom(c.String("file"))
},
},
},
},
{
Name: "name",
Usage: "Print the name of this project.",
Description: `Read the glide.yaml file and print the name given on the 'package' line.`,
Action: func(c *cli.Context) {
action.Name()
},
},
{
Name: "novendor",
ShortName: "nv",
Usage: "List all non-vendor paths in a directory.",
Description: `Given a directory, list all the relevant Go paths that are not vendored.
Example:
$ go test $(glide novendor)`,
Flags: []cli.Flag{
cli.StringFlag{
Name: "dir,d",
Usage: "Specify a directory to run novendor against.",
Value: ".",
},
cli.BoolFlag{
Name: "no-subdir,x",
Usage: "Specify this to prevent nv from append '/...' to all directories.",
},
},
Action: func(c *cli.Context) {
action.NoVendor(c.String("dir"), true, !c.Bool("no-subdir"))
},
},
{
Name: "rebuild",
Usage: "Rebuild ('go build') the dependencies",
Description: `This rebuilds the packages' '.a' files. On some systems
this can improve performance on subsequent 'go run' and 'go build' calls.`,
Action: func(c *cli.Context) {
action.Rebuild()
},
},
{
Name: "install",
ShortName: "i",
Usage: "Install a project's dependencies",
Description: `This uses the native VCS of each packages to install
the appropriate version. There are two ways a projects dependencies can
be installed. When there is a glide.yaml file defining the dependencies but
no lock file (glide.lock) the dependencies are installed using the "update"
command and a glide.lock file is generated pinning all dependencies. If a
glide.lock file is already present the dependencies are installed or updated
from the lock file.`,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "delete",
Usage: "Delete vendor packages not specified in config.",
},
cli.BoolFlag{
Name: "force",
Usage: "If there was a change in the repo or VCS switch to new one. Warning: changes will be lost.",
},
cli.BoolFlag{
Name: "update-vendored, u",
Usage: "Update vendored packages (without local VCS repo). Warning: this may destroy local modifications to vendor/.",
},
cli.StringFlag{
Name: "file, f",
Usage: "Save all of the discovered dependencies to a Glide YAML file. (DEPRECATED: This has no impact.)",
},
cli.BoolFlag{
Name: "cache",
Usage: "When downloading dependencies attempt to cache them.",
},
cli.BoolFlag{
Name: "cache-gopath",
Usage: "When downloading dependencies attempt to put them in the GOPATH, too.",
},
cli.BoolFlag{
Name: "use-gopath",
Usage: "Copy dependencies from the GOPATH if they exist there.",
},
cli.BoolFlag{
Name: "strip-vcs, s",
Usage: "Removes version control metada (e.g, .git directory) from the vendor folder.",
},
cli.BoolFlag{
Name: "strip-vendor, v",
Usage: "Removes nested vendor and Godeps/_workspace directories. Requires --strip-vcs.",
},
},
Action: func(c *cli.Context) {
if c.Bool("strip-vendor") && !c.Bool("strip-vcs") {
msg.Die("--strip-vendor cannot be used without --strip-vcs")
}
installer := repo.NewInstaller()
installer.Force = c.Bool("force")
installer.UseCache = c.Bool("cache")
installer.UseGopath = c.Bool("use-gopath")
installer.UseCacheGopath = c.Bool("cache-gopath")
installer.UpdateVendored = c.Bool("update-vendored")
installer.Home = gpath.Home()
installer.DeleteUnused = c.Bool("deleteOptIn")
action.Install(installer, c.Bool("strip-vcs"), c.Bool("strip-vendor"))
},
},
{
Name: "update",
ShortName: "up",
Usage: "Update a project's dependencies",
Description: `This uses the native VCS of each package to try to
pull the most applicable updates. Packages with fixed refs (Versions or
tags) will not be updated. Packages with no ref or with a branch ref will
be updated as expected.
If a dependency has a glide.yaml file, update will read that file and
update those dependencies accordingly. Those dependencies are maintained in
a the top level 'vendor/' directory. 'vendor/foo/bar' will have its
dependencies stored in 'vendor/'. This behavior can be disabled with
'--no-recursive'. When this behavior is skipped a glide.lock file is not
generated because the full dependency tree cannot be known.
Glide will also import Godep, GB, and GPM files as it finds them in dependencies.
It will create a glide.yaml file from the Godeps data, and then update. This
has no effect if '--no-recursive' is set.
If you are storing the outside dependencies in your version control system
(VCS), also known as vendoring, there are a few flags that may be useful.
The '--update-vendored' flag will cause Glide to update packages when VCS
information is unavailable. This can be used with the '--strip-vcs' flag which
will strip VCS data found in the vendor directory. This is useful for
removing VCS data from transitive dependencies and initial setups. The
'--strip-vendor' flag will remove any nested 'vendor' folders and
'Godeps/_workspace' folders after an update (along with undoing any Godep
import rewriting). Note, The Godeps specific functionality is deprecated and
will be removed when most Godeps users have migrated to using the vendor
folder.
Note, Glide detects vendored dependencies. With the '--update-vendored' flag
Glide will update vendored dependencies leaving them in a vendored state.
Tertiary dependencies will not be vendored automatically unless the
'--strip-vcs' flag is used along with it.
By default, packages that are discovered are considered transient, and are
not stored in the glide.yaml file. The --file=NAME.yaml flag allows you
to save the discovered dependencies to a YAML file.`,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "delete",
Usage: "Delete vendor packages not specified in config.",
},
cli.BoolFlag{
Name: "no-recursive, quick",
Usage: "Disable updating dependencies' dependencies. Only update things in glide.yaml.",
},
cli.BoolFlag{
Name: "force",
Usage: "If there was a change in the repo or VCS switch to new one. Warning, changes will be lost.",
},
cli.BoolFlag{
Name: "all-dependencies",
Usage: "This will resolve all dependencies for all packages, not just those directly used.",
},
cli.BoolFlag{
Name: "update-vendored, u",
Usage: "Update vendored packages (without local VCS repo). Warning, changes will be lost.",
},
cli.StringFlag{
Name: "file, f",
Usage: "Save all of the discovered dependencies to a Glide YAML file.",
},
cli.BoolFlag{
Name: "cache",
Usage: "When downloading dependencies attempt to cache them.",
},
cli.BoolFlag{
Name: "cache-gopath",
Usage: "When downloading dependencies attempt to put them in the GOPATH, too.",
},
cli.BoolFlag{
Name: "use-gopath",
Usage: "Copy dependencies from the GOPATH if they exist there.",
},
cli.BoolFlag{
Name: "resolve-current",
Usage: "Resolve dependencies for only the current system rather than all build modes.",
},
cli.BoolFlag{
Name: "strip-vcs, s",
Usage: "Removes version control metada (e.g, .git directory) from the vendor folder.",
},
cli.BoolFlag{
Name: "strip-vendor, v",
Usage: "Removes nested vendor and Godeps/_workspace directories. Requires --strip-vcs.",
},
},
Action: func(c *cli.Context) {
if c.Bool("strip-vendor") && !c.Bool("strip-vcs") {
msg.Die("--strip-vendor cannot be used without --strip-vcs")
}
if c.Bool("resolve-current") {
util.ResolveCurrent = true
msg.Warn("Only resolving dependencies for the current OS/Arch")
}
installer := repo.NewInstaller()
installer.Force = c.Bool("force")
installer.UseCache = c.Bool("cache")
installer.UseGopath = c.Bool("use-gopath")
installer.UseCacheGopath = c.Bool("cache-gopath")
installer.UpdateVendored = c.Bool("update-vendored")
installer.ResolveAllFiles = c.Bool("all-dependencies")
installer.Home = gpath.Home()
installer.DeleteUnused = c.Bool("deleteOptIn")
action.Update(installer, c.Bool("no-recursive"), c.Bool("strip-vcs"), c.Bool("strip-vendor"))
},
},
{
Name: "tree",
Usage: "Tree prints the dependencies of this project as a tree.",
Description: `This scans a project's source files and builds a tree
representation of the import graph.
It ignores testdata/ and directories that begin with . or _. Packages in
vendor/ are only included if they are referenced by the main project or
one of its dependencies.`,
Action: func(c *cli.Context) {
action.Tree(".", false)
},
},
{
Name: "list",
Usage: "List prints all dependencies that the present code references.",
Description: `List scans your code and lists all of the packages that are used.
It does not use the glide.yaml. Instead, it inspects the code to determine what packages are
imported.
Directories that begin with . or _ are ignored, as are testdata directories. Packages in
vendor are only included if they are used by the project.`,
Action: func(c *cli.Context) {
action.List(".", true, c.String("output"))
},
Flags: []cli.Flag{
cli.StringFlag{
Name: "output, o",
Usage: "Output format. One of: json|json-pretty|text",
Value: "text",
},
},
},
{
Name: "info",
Usage: "Info prints information about this project",
Flags: []cli.Flag{
cli.StringFlag{
Name: "format, f",
Usage: `Format of the information wanted (required).`,
},
},
Description: `A format containing the text with replacement variables
has to be passed in. Those variables are:
%n - name
%d - description
%h - homepage
%l - license
For example, given a project with the following glide.yaml:
package: foo
homepage: https://example.com
license: MIT
description: Some example description
Then running the following commands:
glide info -f %n
prints 'foo'
glide info -f "License: %l"
prints 'License: MIT'
glide info -f "%n - %d - %h - %l"
prints 'foo - Some example description - https://example.com - MIT'`,
Action: func(c *cli.Context) {
if c.IsSet("format") {
action.Info(c.String("format"))
} else {
cli.ShowCommandHelp(c, c.Command.Name)
}
},
},
{
Name: "about",
Usage: "Learn about Glide",
Action: func(c *cli.Context) {
action.About()
},
},
}
}
func defaultGlideDir() string {
c, err := user.Current()
if err != nil {
return ""
}
return filepath.Join(c.HomeDir, ".glide")
}
// startup sets up the base environment.
//
// It does not assume the presence of a Glide.yaml file or vendor/ directory,
// so it can be used by any Glide command.
func startup(c *cli.Context) error {
action.Debug(c.Bool("debug"))
action.NoColor(c.Bool("no-color"))
action.Quiet(c.Bool("quiet"))
action.Init(c.String("yaml"), c.String("home"))
action.EnsureGoVendor()
return nil
}
// Get the path to the glide.yaml file.
//
// This returns the name of the path, even if the file does not exist. The value
// may be set by the user, or it may be the default.
func glidefile(c *cli.Context) string {
path := c.String("file")
if path == "" {
// For now, we construct a basic assumption. In the future, we could
// traverse backward to see if a glide.yaml exists in a parent.
path = "./glide.yaml"
}
a, err := filepath.Abs(path)
if err != nil {
// Underlying fs didn't provide working dir.
return path
}
return a
}