Sign upLogin

neechbear/blip

View on GitHub
Star

Showing 192 of 192 total issues

Header style
Open

### LONGOPT
Severity: Info
Found in CMDARG.md by markdownlint

MD003 - Header style

Tags: headers

Aliases: header-style

Parameters: style ("consistent", "atx", "atxclosed", "setext", "setextwith_atx"; default "consistent")

This rule is triggered when different header styles (atx, setext, and 'closed' atx) are used in the same document:

# ATX style H1

## Closed ATX style H2 ##

Setext style H1
===============

Be consistent with the style of header used in a document:

# ATX style H1

## ATX style H2

The setextwithatx doc style allows atx-style headers of level 3 or more in documents with setext style headers:

Setext style H1
===============

Setext style H2
---------------

### ATX style H3

Note: the configured header style can be a specific style to use (atx, atxclosed, setext, setextwith_atx), or simply require that the usage be consistent within the document.

Code block style
Open

    declare -A animal_phylum=()
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    function validate_int
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    cmdarg_parse "$@"
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    cmdarg 'x:' 'some required thing'
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    # Change the way arguments are described in --help
Severity: Info
Found in CMDARG.md by markdownlint

Header style
Open

### DESCRIPTION
Severity: Info
Found in CMDARG.md by markdownlint

MD003 - Header style

Tags: headers

Aliases: header-style

Parameters: style ("consistent", "atx", "atxclosed", "setext", "setextwith_atx"; default "consistent")

This rule is triggered when different header styles (atx, setext, and 'closed' atx) are used in the same document:

# ATX style H1

## Closed ATX style H2 ##

Setext style H1
===============

Be consistent with the style of header used in a document:

# ATX style H1

## ATX style H2

The setextwithatx doc style allows atx-style headers of level 3 or more in documents with setext style headers:

Setext style H1
===============

Setext style H2
---------------

### ATX style H3

Note: the configured header style can be a specific style to use (atx, atxclosed, setext, setextwith_atx), or simply require that the usage be consistent within the document.

Header style
Open

## Helper Functions
Severity: Info
Found in CMDARG.md by markdownlint

MD003 - Header style

Tags: headers

Aliases: header-style

Parameters: style ("consistent", "atx", "atxclosed", "setext", "setextwith_atx"; default "consistent")

This rule is triggered when different header styles (atx, setext, and 'closed' atx) are used in the same document:

# ATX style H1

## Closed ATX style H2 ##

Setext style H1
===============

Be consistent with the style of header used in a document:

# ATX style H1

## ATX style H2

The setextwithatx doc style allows atx-style headers of level 3 or more in documents with setext style headers:

Setext style H1
===============

Setext style H2
---------------

### ATX style H3

Note: the configured header style can be a specific style to use (atx, atxclosed, setext, setextwith_atx), or simply require that the usage be consistent within the document.

Header style
Open

## Usage Helper
Severity: Info
Found in CMDARG.md by markdownlint

MD003 - Header style

Tags: headers

Aliases: header-style

Parameters: style ("consistent", "atx", "atxclosed", "setext", "setextwith_atx"; default "consistent")

This rule is triggered when different header styles (atx, setext, and 'closed' atx) are used in the same document:

# ATX style H1

## Closed ATX style H2 ##

Setext style H1
===============

Be consistent with the style of header used in a document:

# ATX style H1

## ATX style H2

The setextwithatx doc style allows atx-style headers of level 3 or more in documents with setext style headers:

Setext style H1
===============

Setext style H2
---------------

### ATX style H3

Note: the configured header style can be a specific style to use (atx, atxclosed, setext, setextwith_atx), or simply require that the usage be consistent within the document.

Code block style
Open

    cmdarg_info "version" "4.02 (stable)"
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    $ your_script.sh --help
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    myscript.sh -x 0 --longopt thingy -- --some-thing-with-dashes
Severity: Info
Found in CMDARG.md by markdownlint

Multiple top level headers in the same document
Open

# Command Line Argument Parsing
Severity: Info
Found in CMDARG.md by markdownlint

MD025 - Multiple top level headers in the same document

Tags: headers

Aliases: single-h1

Parameters: level (number; default 1)

This rule is triggered when a top level header is in use (the first line of the file is a h1 header), and more than one h1 header is in use in the document:

# Top level header

# Another top level header

To fix, structure your document so that there is a single h1 header that is the title for the document, and all later headers are h2 or lower level headers:

# Title

## Header

## Another header

Rationale: A top level header is a h1 on the first line of the file, and serves as the title for the document. If this convention is in use, then there can not be more than one title for the document, and the entire document should be contained within this header.

Note: The level parameter can be used to change the top level (ex: to h2) in cases where an h1 is added externally.

Code block style
Open

    cmdarg 'x' 'x-option' 'some opt' '' "grep -E '^[0-9]+$'"
Severity: Info
Found in CMDARG.md by markdownlint

Header style
Open

### VALIDATOR
Severity: Info
Found in CMDARG.md by markdownlint

MD003 - Header style

Tags: headers

Aliases: header-style

Parameters: style ("consistent", "atx", "atxclosed", "setext", "setextwith_atx"; default "consistent")

This rule is triggered when different header styles (atx, setext, and 'closed' atx) are used in the same document:

# ATX style H1

## Closed ATX style H2 ##

Setext style H1
===============

Be consistent with the style of header used in a document:

# ATX style H1

## ATX style H2

The setextwithatx doc style allows atx-style headers of level 3 or more in documents with setext style headers:

Setext style H1
===============

Setext style H2
---------------

### ATX style H3

Note: the configured header style can be a specific style to use (atx, atxclosed, setext, setextwith_atx), or simply require that the usage be consistent within the document.

Code block style
Open

    cmdarg 'f' 'boolean-flag' 'Some boolean flag'
Severity: Info
Found in CMDARG.md by markdownlint

Code block style
Open

    myscript.sh -x 0 --longopt thingy file1 file2
Severity: Info
Found in CMDARG.md by markdownlint

FIXME found
Open

  # FIXME: Optimise this so that we return a boolean true or false, instead of
Severity: Minor
Found in blip.bash.in by fixme

TODO found
Open

## TODO
Severity: Minor
Found in README.md by fixme

TODO found
Open

# TODO(nicolaw): Should this be extended to have is_word_in_strings, and/or
Severity: Minor
Found in blip.bash.in by fixme
Severity
Category
Status
Source
Language