https://github.com/alexkohler/cfmt
cfmt is a tool to wrap Go comments over a certain length to a new line.
https://github.com/alexkohler/cfmt
comment commenting comments go golang static-analysis static-analyzer static-code-analysis
Last synced: about 20 hours ago
JSON representation
cfmt is a tool to wrap Go comments over a certain length to a new line.
- Host: GitHub
- URL: https://github.com/alexkohler/cfmt
- Owner: alexkohler
- License: mit
- Created: 2018-03-21T21:42:19.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-23T22:28:03.000Z (almost 8 years ago)
- Last Synced: 2024-06-20T17:45:42.879Z (over 1 year ago)
- Topics: comment, commenting, comments, go, golang, static-analysis, static-analyzer, static-code-analysis
- Language: Go
- Homepage:
- Size: 32.2 KB
- Stars: 27
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cfmt
cfmt is a tool to wrap Go comments over a certain length to a new line.
## Installation
`go get -u github.com/alexkohler/cfmt`
**Note**: cfmt requires gofmt.
## Usage
Similar to other Go static anaylsis tools (such as golint, go vet), cfmt can be invoked with one or more filenames, directories, or packages named by its import path. cfmt also supports the `...` wildcard.
cfmt [flags] files/directories/packages
### Flags
- **-m** - Maximum comment length before cfmt should insert a line break. (Default 80)
- **-w** - Writes changes to file. By default, `cfmt` will only print the changes it will make, but will not modify the input files.
## Examples
`cfmt` will wrap to a new line or join an existing line as appropriate. See the following before/afters of running `cfmt -m=100`:
**Before**
```Go
// I am a long comment that is over 100 characters long. I should probably wrap to a new line.
```
**After**
```Go
// I am a long comment that is over 100 characters long. I should probably wrap
// to a new line.
```
---
**Before**
```Go
// I am a long comment that is over 100 characters long. I should probably wrap below to the
// rest of the comment.
```
**After**
```Go
// I am a long comment that is over 100 characters long. I should probably wrap
// below to the rest of the comment.
```
---
**Before**
```Go
//I am a long comment that starts without a space and is over 100 characters long. When I wrap, I should still start without a space
```
**After**
```Go
//I am a long comment that starts without a space and is over 100 characters
//long. When I wrap, I should still start without a space
```
---
`cfmt` ignores block (`/* */`) comments and "grouped" comments over a length of 10 (i.e. 10+ consecutive lines starting with `//`).
## Contributing
Pull requests welcome!
## Other static analysis tools
If you've enjoyed cfmt, take a look at my other static anaylsis tools!
- [nakedret](https://github.com/alexkohler/nakedret) - Finds naked returns.
- [unimport](https://github.com/alexkohler/unimport) - Finds unnecessary import aliases.
- [prealloc](https://github.com/alexkohler/prealloc) - Finds slice declarations that could potentially be preallocated.