Showing 53 of 63 total issues
Dollar signs used before commands without showing output Open
```bash
- Read upRead up
- Exclude checks
MD014 - Dollar signs used before commands without showing output
Tags: code
Aliases: commands-show-output
This rule is triggered when there are code blocks showing shell commands to be typed, and the shell commands are preceded by dollar signs ($):
$ ls
$ cat foo
$ less bar
The dollar signs are unnecessary in the above situation, and should not be included:
ls
cat foo
less bar
However, an exception is made when there is a need to distinguish between typed commands and command output, as in the following example:
$ ls
foo bar
$ cat foo
Hello world
$ cat bar
baz
Rationale: it is easier to copy and paste and less noisy if the dollar signs are omitted when they are not needed. See http://www.cirosantilli.com/markdown-styleguide/#dollar-signs-in-shell-code for more information.
exported method ArgumentBuilder.SetCommand should have comment or be unexported Open
func (b *ArgumentBuilder) SetCommand(cmd string) {
- Exclude checks
exported method PipeBuilder.SetErrorWriter should have comment or be unexported Open
func (b *PipeBuilder) SetErrorWriter(w io.Writer) {
- Exclude checks
exported function CreateFromString should have comment or be unexported Open
func CreateFromString(data string) (*Config, error) {
- Exclude checks
2: cannot find package "github.com/corvus-ch/rabbitmq-cli-consumer/config" in any of: Open
"github.com/corvus-ch/rabbitmq-cli-consumer/config"
- Exclude checks
Line length Open
rabbitmq-cli-consumer --verbose --url amqp://guest:guest@localhost --queue myqueue --executable command.php --configuration example.conf
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the code_blocks
and/or tables
parameters to false.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
exported method Config.AmqpUrl should have comment or be unexported Open
func (c *Config) AmqpUrl() string {
- Exclude checks
Your code does not pass gofmt in 1 place. Go fmt your code! Open
// +build integration
- Exclude checks
exported type ArgumentBuilder should have comment or be unexported Open
type ArgumentBuilder struct {
- Exclude checks
exported method PipeBuilder.GetCommand should have comment or be unexported Open
func (b *PipeBuilder) GetCommand(p delivery.Properties, d delivery.Info, body []byte) (*exec.Cmd, error) {
- Exclude checks
Multiple consecutive blank lines Open
- Read upRead up
- Exclude checks
MD012 - Multiple consecutive blank lines
Tags: whitespace, blank_lines
Aliases: no-multiple-blanks
This rule is triggered when there are multiple consecutive blank lines in the document:
Some text here
Some more text here
To fix this, delete the offending lines:
Some text here
Some more text here
Note: this rule will not be triggered if there are multiple consecutive blank lines inside code blocks.
Multiple consecutive blank lines Open
- Read upRead up
- Exclude checks
MD012 - Multiple consecutive blank lines
Tags: whitespace, blank_lines
Aliases: no-multiple-blanks
This rule is triggered when there are multiple consecutive blank lines in the document:
Some text here
Some more text here
To fix this, delete the offending lines:
Some text here
Some more text here
Note: this rule will not be triggered if there are multiple consecutive blank lines inside code blocks.
Code block style Open
rabbitmq-cli-consumer --verbose --url amqp://guest:guest@localhost --queue myqueue --executable command.php --include
- Exclude checks