todolint

README

todolint

Description

Requires TODO comments to be in the form of "TODO(author) ...

Badges

Install

go install github.com/timonwong/loggercheck/cmd/loggercheck

Usage

todolint: Requires TODO comments to be in the form of "TODO(author) ...

Usage: todolint [-flag] [package]

  -keywords value
        comma-separated list of case-insensitive keywords to check for (default TODO,FIXME)

Example

package a

import "fmt"

// TODO: This is not ok // want `TODO comment should be in the form TODO\(author\)`
func NotOkFunc() {
}

// TODO(author1): This is ok
func OkFunc() {
}

type ABC struct {
	A int    // @FIXME: This field comment is not ok // want `TODO comment should be in the form FIXME\(author\)`
	B string // FIXME(author2): This field comment is ok
}

func Example() {
	// TODO(timonwong): This is ok
	//

	// 🚀🚀🚀 FixMe: 你好世界 // want `TODO comment should be in the form FIXME\(author\)`
	fmt.Println("Hello")

	fmt.Println("你好，世界") // fixme: more languages // want `TODO comment should be in the form FIXME\(author\)`
}

Documentation

Index

• Constants
• func NewAnalyzer() *analysis.Analyzer

Constants

const Doc = `Requires TODO comments to be in the form of "TODO(author) ...`

Functions

func NewAnalyzer

func NewAnalyzer() *analysis.Analyzer