README
¶
wslint
A file formatter that eliminates trailing whitespaces and ensures there is exactly one blank line at the end of the file.
Table of Contents
Overview
wslint is designed to help keep your codebase clean and consistent by removing unnecessary whitespaces and enforcing a single blank line at the end of each file.
Installation
go install github.com/idelchi/wslint@latest
Usage
wslint [flags] [path ...]
Paths can be specified as one or more glob patterns or simple file paths.
Enclose path arguments in quotes to prevent shell expansion.
Examples
Lint all files in the current directory and its subdirectories:
wslint "**"
Lint all text files in the current directory and its subdirectories:
wslint "**/*.txt"
Format all .js and .css files in the src directory, including hidden files:
wslint -w -a "src/*.js" "src/*.css"
Lint all .py files in the app directory, excluding __init__.py files and the tests folder:
wslint -e "app/**/__init__.py,app/tests/**" "app/**/*.py"
Run wslint on the my_project directory with four parallel jobs:
wslint -j 4 "my_project/**"
Command Line Flags
| Flag | Description |
|---|---|
-w |
Format the files. Without this flag, wslint only performs linting. |
-a |
Include hidden files and folders. |
-e |
Exclude patterns, separated by commas (e.g., *.log,*.tmp). |
-j |
Set the number of parallel jobs. |
-h |
Print help information. |
-v |
Print the version number. |
-d |
Show debug output. |
-q |
Suppress messages. |
Default Exclusion Patterns
By default, wslint excludes the following patterns. These patterns represent common files or folders that are either binary, temporary, or irrelevant to code formatting:
**/*.exe**/.git/****/.vscode-server/****/node_modules/****/vendor/****/.task/****/.cache/**- The executable itself
- Folders and files starting with '
.', unless the-aflag is used
To include files that are normally excluded, either:
- Write a full path to the file
- Use glob patterns only in the filename portion of the path (excluding the extension)
Example:
wslint ".git/config"
wslint ".task/*.env"
wslint "*.exe"
Disclaimer
Warning This project serves as a learning exercise for Go and its surrounding ecosystem and tooling. Users are advised against using this tool on files that are not under version control.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
wslint
Wslint formats files, removing trailing whitespaces and enforcing exactly one blank line at the end of the file.
|
Wslint formats files, removing trailing whitespaces and enforcing exactly one blank line at the end of the file. |
|
internal
|
|
|
checkers
Package checkers contains line analysis tooling.
|
Package checkers contains line analysis tooling. |
|
linter
Package linter provides functions to check and fix files for trailing whitespaces and blank lines.
|
Package linter provides functions to check and fix files for trailing whitespaces and blank lines. |
|
worker
Package worker provides a concurrent mechanism to process a set of jobs using a pool of workers.
|
Package worker provides a concurrent mechanism to process a set of jobs using a pool of workers. |
|
Package matcher provides a utility for matching files based on glob patterns, with support for excluding directories, hidden files and folders, and binary files.
|
Package matcher provides a utility for matching files based on glob patterns, with support for excluding directories, hidden files and folders, and binary files. |
|
Package trailing provides functions to check and remove trailing whitespace(s) from a string.
|
Package trailing provides functions to check and remove trailing whitespace(s) from a string. |