Skip to content
JcmXiFPublic

About

Generate a navigable structure map of the codebase: annotated directory tree, per-file purposes, and top-level symbols.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

code-map

一个独立的 AI coding skill:生成可导航的代码结构图。

它把代码库的目录结构、每个文件的职责、主要的函数和类变成可读的 Markdown,供人和 agent 在需要时查阅。地图是生成的视图;annotations 是手写的稳定层。

使用

  • 新进一个仓库、离开一段时间回来、或要动一个不熟悉的文件时,输入 /code-map。
  • 生成物:
    • docs/map/index.md:带注释的目录树,每个文件一句话职责和主要顶层符号
    • docs/map/tree.md:纯目录树
    • docs/map/symbols.md:每个文件的函数、类、方法和签名
    • docs/map/annotations.md:手写职责,首次运行创建,之后永不覆盖
  • 检查地图是否过期:/code-map --check
  • 它不做重构建议,也不解析依赖,只告诉你东西在哪、文件负责什么、有哪些主要符号。

详细说明见 docs/code-map.md。

安装

从 GitHub 安装:

/plugin marketplace add JcmXiF/code-map
/plugin install code-map@code-map

也可以单独安装 skill:

npx skills@latest add JcmXiF/code-map --skill=code-map

开发

node --test

需要 Node.js 20+,零第三方依赖。

原则

  • 生成物可重建;手写物有明确 owner。
  • 地图是结构导航,不是依赖证明。
  • 不复制别人的项目内容;自己的内容自己维护。

License

MIT

About

Generate a navigable structure map of the codebase: annotated directory tree, per-file purposes, and top-level symbols.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages