peterretief/codemap

选用指南

AI 根据 README 整理 · 2026/11/5 15:07:29

使用方式

在模块目录下运行命令生成HTML文件，然后在浏览器中打开。

查看 README 依据

# codemap One HTML page that maps a Go module: every package, what it builds on within the module, and the functions in each of its files. Search it, click a package to see what it uses and what uses it, and, for a module on GitHub, jump to any function's line. Tests are left out. [](https://get.withcare.co.za/code-map/) Open [that example](https://get.withcare.co.za/code-map/) to try it. ## Use it In your module's folder, with Go 1.24 or later: ```sh go run github.com/peterretief/codemap@latest -o code-map.html ```

Then open `code-map.html` in a browser. It's one file with nothing to serve, so it can go on any website. `-root DIR` maps another folder. ## In GitHub Actions ```yaml - uses: actions/checkout@v4 - uses: peterretief/codemap@v0.1.3 with: output: code-map.html - uses: actions/upload-artifact@v4 with: name: code-map path: code-map.html ``` ## How it reads the map - Each row builds only on the rows below it, so the foundations are at the bottom and your commands at the top. - Wider boxes have more functions, and colours are top-level folders.

部署要求

需要Go 1.24或更高版本。

查看 README 依据

# codemap One HTML page that maps a Go module: every package, what it builds on within the module, and the functions in each of its files. Search it, click a package to see what it uses and what uses it, and, for a module on GitHub, jump to any function's line. Tests are left out. [](https://get.withcare.co.za/code-map/) Open [that example](https://get.withcare.co.za/code-map/) to try it. ## Use it In your module's folder, with Go 1.24 or later: ```sh go run github.com/peterretief/codemap@latest -o code-map.html ```

已知限制

测试被排除，internal目录和vendor等被忽略。

查看 README 依据

# codemap One HTML page that maps a Go module: every package, what it builds on within the module, and the functions in each of its files. Search it, click a package to see what it uses and what uses it, and, for a module on GitHub, jump to any function's line. Tests are left out. [](https://get.withcare.co.za/code-map/) Open [that example](https://get.withcare.co.za/code-map/) to try it. ## Use it In your module's folder, with Go 1.24 or later: ```sh go run github.com/peterretief/codemap@latest -o code-map.html ```

- Lines show direct links; ones already implied by others appear when you pick a package. - `internal/` is left off names. `vendor`, `testdata` and folders with their own `go.mod` are left out. - The page loads its fonts from Google Fonts, and falls back to system fonts without them. ## Licence MIT