Golang Source Code Cartographer
Gerardus reads all the .go
files in a directory recursively and then generates a Sqlite database containing what it found.
It defaults to reading the directory found in GOROOT
if you don't specify otherwise.
Still very much a work-in-progress, and thus pre-alpha.
In no particular order:
- Install commands for
go generate
in GitHub Actionsyaml
- Vendor dependencies
Implement robust integration testsSimulate calling from the command line.Stubbing out the databaseAdd tests foradd project
command.Add tests foradd codebase
command.Add tests formap
command.Add tests forhelp
command.
Ensure chans refactor worksBreak out Package from ImportBreak out Project from CodebaseAdd GitHub URL parser for Name, VersionAdd Web client to get About and Website- Get slices vs. chans working
- Leverage https://deps.dev/
Add other commands besidesmap
- Add switch for local directory to clone repos to
- Add ability to clone a Git repo
- Use Cobra
- Try Kong
Add survey_id to all relevant tablesAdd Name, About to ProjectAdd VersionTag, Website fields to CodebaseCapture package data- Add schema migration tool
- Write SQL for Category Interfaces
- Capture constraint interfaces
- Capture interface methods
- Capture struct fields
- Break out
survey_file
fromfile
- Support Postgres as an alternative
- Implement categories
- Implement category types
- Implement type category
- Create JSON config files
- Embed default config files
- Support YAML config files.
- Add local clone root directory config
- Allow options to be set by env
- Especially Codebase Repo URL
- Write Markdown template for interfaces for a category
text/template
orhtml/template
?
- Serve Markdown for Obsidian
- Http server to serve Markdown snippets
- Command to serve
- Command to add serve to
at
command - Command to add serve to
cron
command - Configuration to serve via SystemD service
- Mac
- Linux
- Windows