package
1.20240719.1
Repository: https://github.com/blend/go-sdk.git
Documentation: pkg.go.dev

# Functions

Glob returns if a given pattern matches a given subject.
GlobAnyMatch tests if a file matches a (potentially) csv of glob filters.
ListDir reads the directory named by dirname and returns a sorted list of directory entries.
New creates a new profanity engine with a given set of config options.
OptConfig sets the config in its entirety.
OptDebug sets if we should show debug output.
OptExcludeDirs sets the exclude glob filter for directories.
OptExcludeFiles sets the exclude glob filter for files.
OptExitFirst sets if we should stop after the first failure.
OptIncludeDirs sets the include glob filter for files.
OptIncludeFiles sets the include glob filter for files.
OptRoot sets the root directory to start the profanity check.
OptRulesFile sets the rules file to check for in each directory.
OptVerbose sets if we should show verbose output.

# Constants

Defaults.
Defaults.
Errors.
Errors.
Errors.
Errors.
Glob constants.
Glob constants.
Glob constants.
Glob constants.

# Structs

Config is the profanity rules parsing config.
ContainsFilter is the contains filter.
Contents creates a new contents rule.
Filter is the base rule helper.
GlobFilter rules for if we should include or exclude file or directory by name.
GoCall is a package and function name pair.
GoImports returns a profanity error if a given file contains any of a list of imports based on a glob match.
NoGenericDecls returns a profanity error if a generic function or type declaration exists.
Profanity parses rules from the filesystem and applies them to a given root path.
RegexFilter represents rules around matching (or excluding) based on regular expressions.
RuleResult is a result from a rule.
RuleSpec is a serialized rule.
RuleSpecRules are the specific rules for a given RuleSpec.

# Interfaces

Logger are the methods required on the logger.
Rule is a criteria for profanity.

# Type aliases

GoCalls returns a profanity error if a given function is called in a package.
Option is a function that modifies a config.
RuleSpecFile is a map of string rule id to rule item.