Categorygithub.com/methodci/checkstyle
modulepackage
0.5.0
Repository: https://github.com/methodci/checkstyle.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
4
Dependents
1
Files
184 SLOC

# README

checkstyle / chksutil

CI GoDoc Go Report Card

checkstyle is a library for working with checkstyle files.

The included chksutil is a utility for inspecting and diffing checkstyle files.

$ chksutil diff old.chk new.chk
Fixed info on GoalSetting.php:44 - DocblockTypeContradiction: Cannot resolve types for $value - docblock-defined type int does not contain null
Fixed info on GoalSetting.php:44 - RedundantConditionGivenDocblockType: Found a redundant condition when evaluating docblock-defined type $value and trying to reconcile type 'int' to !null
Created info on GoalSetting.php:72 - MissingParamType: Parameter $value has no provided

Install chksutil

binaries are attached to the releases

https://github.com/methodci/checkstyle/releases

otherwise you can install from source via

$ go install github.com/methodci/checkstyle/cmd/chksutil@latest

# Packages

No description provided by the author

# Functions

Decode reads a checkstyle file from a reader.
Diff runs a diff operation on two checkstyle structs and returns two new checkstyle structs of fixed and created errors.

# Constants

SeverityLevels as defined by the checkstyle standard.
SeverityLevels as defined by the checkstyle standard.
SeverityLevels as defined by the checkstyle standard.
SeverityLevels as defined by the checkstyle standard.

# Structs

Checkstyle <checkstyle /> XML struct as defined by the checkstyle standard.
DiffOptions are the options for the Diff command.
File <file /> XML struct as defined by the checkstyle standard.
FileError <error /> XML struct as defined by the checkstyle standard.

# Type aliases

Files is a collection of <file /> XML structs with added helpers.
SeverityLevel as defined by severity levels from https://checkstyle.sourceforge.io/property_types.html#SeverityLevel.