hb-chen / deps Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 2.0 122 KB

Deps 是一个帮助获取项目依赖包的版本、开源协议、安全漏洞等清单的工具，数据源来自 Google 的 https://deps.dev 项目，当前支持 Go、Java。

License: Apache License 2.0

Go 90.59% Java 2.35% Makefile 2.62% Smarty 4.44%

deps's Introduction

Deps

Deps 是一个帮助获取项目依赖包的版本、开源协议、安全漏洞等清单的工具，数据源来自 Google 的 deps.dev 项目，当前支持 Go、Java。

Feature

获取项目依赖包清单，包括以下信息:
- 包名、版本
- 开源协议
- 安全漏洞
- 是否直接依赖
- 包间依赖拓扑
支持语言
- Go mod
- Java maven
- npm
  - https://stackoverflow.com/questions/25997519/how-to-view-the-dependency-tree-of-a-given-npm-module
数据源
- deps.dev
- 取本地 mod/pom 中的 licenses 信息
其他功能
- 支持模板输出，自定义格式
- 开源协议友好性标识
- 通过 Project 目录文件自动识别语言及包管理工具
- License 文件提取
- Brew 安装

Install

Binary

Releases

Source

go install github.com/hb-chen/deps@latest

Usage

Usage:
  deps [flags]

Flags:
  -h, --help             help for deps
  -o, --out string       template output filepath (default "./deps.md")
  -p, --project string   project path (default "", use "pwd")
      --skip strings     skip scrape package regexp pattern
  -s, --system string    system type:auto, mod, maven (default "auto")
  -t, --tpl string       template output template filepath. md.tpl,csv.tpl or custom template filepath (default "md.tpl")
  -v, --version          version for deps

--skip 忽略非开源依赖包
- deps -s maven -p ./ --skip="com.hbchen.*"

Golang

# Run
cd {golang project path}
deps -s mod
# Or run with -p
deps -s mod -p {project path}

# Output
# Markdown
./deps.md

# Stdout
Dependencies:
Pkg: golang.org/x/tools, Licenses: BSD-3-Clause , Direct: false ,Advisories: 0 
Pkg: github.com/kr/text, Licenses: MIT , Direct: false ,Advisories: 0 
Pkg: golang.org/x/mod, Licenses: BSD-3-Clause , Direct: false ,Advisories: 0 
...

Maven

引入依赖 github.com/ferstl/depgraph-maven-plugin，能够通过 mvnw depgraph:graph OR mvn depgraph:graph 生成 target/dependency-graph.json

# Run
cd {golang project path}
deps -s maven
# Or run with -p
# deps -s go -p {project path}
deps -s maven -p ./example/java/

# Output
# Markdown
./deps.md

# Stdout
Dependencies:
Pkg: org.mockito:mockito-junit-jupiter, Licenses: MIT , Direct: false ,Advisories: 0 
Pkg: org.ow2.asm:asm, Licenses: BSD-3-Clause , Direct: false ,Advisories: 0 
Pkg: jakarta.xml.bind:jakarta.xml.bind-api, Licenses: non-standard , Direct: false ,Advisories: 0 
Pkg: org.apache.logging.log4j:log4j-api, Licenses: Apache-2.0 , Direct: false ,Advisories: 0 
...