status-im
/
todo-to-docs
mirror of https://github.com/status-im/todo-to-docs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Tool to inspect a package for todos and compiles all found todos into a single document
22 Commits 1 Branch 0 Tags 64 KiB
Go 100%
Go to file
Samuel Hawksby-Robinson 2df33fe301
Bug fix on isValidFile 		2021-03-05 23:24:36 +00:00
sample Added README and sample output 2021-01-07 12:53:31 +00:00
.gitignore Added getter functionality and dynamic file type handler 2021-03-05 23:17:17 +00:00
README.md Added additional todo item 2021-03-05 15:21:01 +00:00
entity_tracker.go go fmt 2021-01-05 14:44:31 +00:00
main.go Added getter functionality and dynamic file type handler 2021-03-05 23:17:17 +00:00
node.go Updated project todos and go fmt 2021-01-07 12:57:18 +00:00
todo.go Updated project todos and go fmt 2021-01-07 12:57:18 +00:00
todo_finder.go Bug fix on isValidFile 2021-03-05 23:24:36 +00:00
todo_finder_test.go Added getter functionality and dynamic file type handler 2021-03-05 23:17:17 +00:00

README.md

Todo To Docs

Tool to inspect a package for todos and compiles all found todos into a single document.

This tool currently only works on go code but can be easily expanded to analyse other code bases.

Install

go get github.com/status-im/todo-to-docs

Run

Currently the tool is hardcoded to process the status-go repo and assumes that the repo is present on the user's machine.

cd into the github.com/status-im/todo-to-docs repo.

Run the following

go build
todo-to-doc

Sample Output

...

  • 📁 params
    • 📃 config.go
      • ⬜ Todo:
        Related func or type : func (c *NodeConfig) updatePeerLimits()
        On line : 723
        Description : TODO(dshulyak) register mailserver limits when we will change how they are handled.
  • 📁 peers
    • 📃 peerpool.go
      • ⬜ Todo:
        On line : 249
        Description : TODO(adam): split it into peers and discovery management loops. This should
        simplify the whole logic and allow to remove timeout field from PeerPool.
    • 📃 topicpool.go
      • ⬜ Todo:
        Related func or type : func (t *TopicPool) AddPeerFromTable(server *p2p.Server) *discv5.Node
        On line : 401
        Description : TODO(adam): investigate if it's worth to keep the peer in the queue
        until the server confirms it is added and in the meanwhile only adjust its priority.

...

For a full sample output see here