README
¶
deplist
Scan and list the dependencies in a source code repository.
Supports:
- Go
- Java
- NodeJS
- Python
- Ruby
- Rust
Dependencies are printed in PackageURL format.
Requirements
On Fedora:
dnf install golang-bin yarnpkg rubygem-bundler ruby-devel npm
Command Line
Build from source
$ make
go build cmd/deplist/deplist.go
Run
$ ./deplist test/testRepo
pkg:npm/[email protected]
pkg:npm/[email protected]
pkg:npm/[email protected]
pkg:npm/[email protected]
...
Verbose/debug output:
deplist -debug ./test/testRepo/
DEBU[0000] Checking ./test/testRepo/
DEBU[0000] GetRubyDeps test/testRepo/Gemfile
DEBU[0000] Running env [--chdir=test/testRepo ruby /tmp/gemfile-parser.rb927489446 .]
DEBU[0000] GetGoPkgDeps test/testRepo/Gopkg.lock
DEBU[0000] GetGlideDeps test/testRepo/glide.lock
DEBU[0000] GetGolangDeps test/testRepo/go.mod
...
API
The api functions as follows:
func GetDeps(fullPath string, ignoreDirs ...string) ([]Dependency, Bitmask, error) {
Parameters
-
fullPath:
Path to directory with source code.
Returns
-
Dependency:
Array of Dependency structs from dependencies.go
-
Bitmask:
A bitmask of found languages:
const (
LangGolang = 1 << iota
LangJava
LangNodeJS
LangPython
LangRuby
LangRust
)
-
error:
Standard Go error handling
Documentation
¶
Index ¶
Constants ¶
const ( LangGolang = 1 << iota LangJava LangNodeJS LangPython LangRuby LangRust )
enums start at 1 to allow us to specify found languages 0 = nil
const LangGeneric = 0
Variables ¶
This section is empty.
Functions ¶
func GetDeps ¶
func GetDeps(fullPath string, ignoreDirs ...string) ([]Dependency, Bitmask, error)
GetDeps scans a given repository and returns all dependencies found in a DependencyList struct.
func GetLanguageStr ¶
GetLanguageStr returns from a bitmask return the ecosystem name
Types ¶
type Bitmask ¶
type Bitmask uint32
Bitmask type allows easy tagging of what langs there are
func (*Bitmask) DepFoundAddFlag ¶
DepFoundAddFlag add a lang type to the bitmask
func (Bitmask) DepFoundHasFlag ¶
DepFoundHasFlag deteremine if bitmask has a lang type
type Dependency ¶
type Dependency struct {
DepType Bitmask // golang, nodejs, python etc
Path string // the module path, github.com/teris-io/shortid
Version string // v0.0.0-20171029131806-771a37caa5cf
Files []string // if available, list of all files for a package
}
Dependency per dependency info
func (*Dependency) ToString ¶ added in v1.0.31
func (d *Dependency) ToString() string
type Discovered ¶ added in v1.0.30
type Discovered struct {
// contains filtered or unexported fields
}
Source Files
Directories