package
0.0.0-20241217204129-3c3b82064a1e
Repository: https://github.com/aep-dev/api-linter.git
Documentation: pkg.go.dev
# Functions
Debug is a LinterOption for setting if debug mode is on.
GetAllMessages returns a slice with every message (not just top-level messages) in the file.
IgnoreCommentDisables sets the flag for ignoring comments which disable rules.
New creates and returns a linter with the given rules and configs.
NewRuleName creates a RuleName from an AIP number and a unique name within that AIP.
NewRuleRegistry creates a new rule registry.
No description provided by the author
ReadConfigsFromFile reads Configs from a file.
ReadConfigsJSON reads Configs from a JSON file.
ReadConfigsYAML reads Configs from a YAML(.yml or .yaml) file.
# Constants
TODO: what should we do with may rules?.
No description provided by the author
TODO: Remove NotCategorized once all rules have categories.
No description provided by the author
# Structs
Config stores rule configurations for certain files that the file path must match any of the included paths but none of the excluded ones.
DescriptorRule defines a lint rule that is run on every descriptor in the file (but not the file itself).
EnumRule defines a lint rule that is run on each enum.
EnumValueRule defines a lint rule that is run on each enum value.
FieldRule defines a lint rule that is run on each field within a file.
FileRule defines a lint rule that checks a file as a whole.
Linter checks API files and returns a list of detected problems.
MessageRule defines a lint rule that is run on each message in the file.
MethodRule defines a lint rule that is run on each method.
Problem contains information about a result produced by an API Linter.
Response describes the result returned by a rule.
ServiceRule defines a lint rule that is run on each service.
# Interfaces
ProtoRule defines a lint rule that checks Google Protobuf APIs.
# Type aliases
Configs determine if a rule is enabled or not on a file path.
LinterOption prvoides the ability to configure the Linter.
RuleName is an identifier for a rule.
RuleRegistry is a registry for registering and looking up rules.
No description provided by the author