Summarise Code ANNotations (NOTE, TODO, FIXME, BUG)
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
commands
config
testdata
version
.flint.toml
.gitignore
.rocket.toml
.scann.san
.travis.yml
LICENSE.txt
Makefile
README.md
go.mod
go.sum
main.go

README.md

Scann

GoDoc GitHub release Build Status

Summarise Code ANNotations (NOTE, TODO, FIXME, BUG)

  1. Installation
  2. Usage
  3. Configuration

Installation

Using go (nightly)

$ go get -u github.com/z0mbie42/scann

Binary releases

https://github.com/z0mbie42/scann/releases/latest

Usage

$ scann # will recursively parse files for annotations
testdata/main.go:4: TODO: lorem ipsum

Configuration

scann can be configured using a .scann.san file. It uses the SAN configuration file format.

By default scann will search in the current directory then recursively updward to find a .scann.san configuration file, however a file can be specified using the -c flag.

Field Type Default value Description
format string "console" Configure the ouput format, available formats are: [console]
ignore [string] [".git/**"] Ignore files according to Glob patterns (** are supported)

Example

$ cat .scann.san
ignore = [ ".git/**" ]