README
¶
goutils/v2/lint
The lint package is a part of goutils library. It provides utility
functions for lint operations in Go.
Functions
InstallGoPCDeps
func InstallGoPCDeps() error
Install dependencies used for pre-commit with Golang projects.
InstallPCHooks
func InstallPCHooks() error
Installs pre-commit hooks locally.
UpdatePCHooks
func UpdatePCHooks() error
Update pre-commit hooks locally.
ClearPCCache
func ClearPCCache() error
Clears the pre-commit cache.
RunPCHooks
func RunPCHooks() error
Run all pre-commit hooks locally.
AddFencedCB
func AddFencedCB(filePath string, language string) error
Addresses MD040 issues found with markdownlint by adding the input language to fenced code blocks in the input filePath.
Installation
To use the goutils/v2/lint package, you need to install it via go get:
go get github.com/l50/goutils/v2/lint
Usage
After installation, you can import it in your project:
import "github.com/l50/goutils/v2/lint"
Tests
To run the tests for the goutils/v2/lint package, navigate to
your $GOPATH/src/github.com/l50/goutils/v2/lint directory
and run go test:
go test -v
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddFencedCB ¶
AddFencedCB addresses MD040 issues found with markdownlint by adding the input language to fenced code blocks in the input filePath.
Parameters:
filePath: A string representing the path to the markdown file to modify. language: A string representing the language to be added to the fenced code block.
Returns:
error: An error if the markdown file fails to be modified.
Example:
err := AddFencedCB("/path/to/markdown/file", "go")
if err != nil {
log.Fatalf("Error modifying markdown file: %v", err)
}
func ClearPCCache ¶
func ClearPCCache() error
ClearPCCache clears the pre-commit cache.
Returns:
error: An error if the cache fails to clear.
Example:
err := ClearPCCache()
if err != nil {
log.Fatalf("Error clearing cache: %v", err)
}
func InstallGoPCDeps ¶
func InstallGoPCDeps() error
InstallGoPCDeps installs dependencies used for pre-commit with Golang projects.
Returns:
error: An error if the dependencies fail to install.
Example:
err := InstallGoPCDeps()
if err != nil {
log.Fatalf("Error installing dependencies: %v", err)
}
func InstallPCHooks ¶
func InstallPCHooks() error
InstallPCHooks installs pre-commit hooks locally.
Returns:
error: An error if the hooks fail to install.
Example:
err := InstallPCHooks()
if err != nil {
log.Fatalf("Error installing hooks: %v", err)
}
func RunPCHooks ¶
RunPCHooks runs pre-commit hooks with a provided timeout. If no timeout is provided, it defaults to 600.
Parameters:
timeout (optional): An integer specifying the timeout duration for running pre-commit hooks.
Returns:
error: An error if the pre-commit hook execution fails.
Example:
err := RunPCHooks() // Runs with a default timeout of 600.
if err != nil {
log.Fatalf("Failed to run pre-commit hooks: %v", err)
}
err = RunPCHooks(300) // Runs with a specified timeout of 300.
if err != nil {
log.Fatalf("Failed to run pre-commit hooks: %v", err)
}
func UpdatePCHooks ¶
func UpdatePCHooks() error
UpdatePCHooks updates pre-commit hooks locally.
Returns:
error: An error if the hooks fail to update.
Example:
err := UpdatePCHooks()
if err != nil {
log.Fatalf("Error updating hooks: %v", err)
}
Types ¶
This section is empty.
Source Files