godox

README

GoDoX

GoDoX extracts comments from Go code based on keywords. This repository is fork of https://github.com/766b/godox but a lot of code has changed, this repository is updated and the code was adjusted for better integration with https://github.com/golangci/golangci-lint.

Installation

go get github.com/matoous/godox

The main idea

The main idea of godox is the keywords like TODO, FIX, OPTIMIZE is temporary and for development purpose only. You should create tasks if some TODOs cannot be fixed in the current merge request.

Documentation

Overview

Package godox is a linter that scans Go code for comments containing certain keywords (like TODO, BUG, FIXME) which typically indicate areas that require attention.

Index

• type Message
  • func Run(file *ast.File, fset *token.FileSet, keywords ...string) ([]Message, error)

Types

type Message

type Message struct {
	Pos     token.Position
	Message string
}

Message contains a message and position.

func Run

func Run(file *ast.File, fset *token.FileSet, keywords ...string) ([]Message, error)

Run runs the godox linter on given file. Godox searches for comments starting with given keywords and reports them.