ngoldack/slog-highlight

View on GitHub

Showing 15 of 15 total issues

Line length
Open

This library implements the slog handler for the [highlight.io](https://highlight.io) logging service.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length

Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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. To do this, set the ignore_code_blocks parameter to true. To exclude this rule for tables set the tables parameters to false. Setting the parameter code_blocks to false to exclude the rule for code blocks is deprecated and will be removed in a future release.

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.

Line length
Open

- [multi](multi) - Example of how to use the `slog-highlight` library with multiple loggers. Eg. to log to both Highlight and stdout/stderr.
Severity: Info
Found in examples/README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length

Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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. To do this, set the ignore_code_blocks parameter to true. To exclude this rule for tables set the tables parameters to false. Setting the parameter code_blocks to false to exclude the rule for code blocks is deprecated and will be removed in a future release.

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.

Ordered list item prefix
Open

2. Run the example:
Severity: Info
Found in examples/minimal/README.md by markdownlint

MD029 - Ordered list item prefix

Tags: ol

Aliases: ol-prefix

Parameters: style (:one, :ordered; default :one)

This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').

Example valid list if the style is configured as 'one':

1. Do this.
1. Do that.
1. Done.

Example valid list if the style is configured as 'ordered':

1. Do this.
2. Do that.
3. Done.

Ordered list item prefix
Open

2. Run the example:
Severity: Info
Found in examples/multi/README.md by markdownlint

MD029 - Ordered list item prefix

Tags: ol

Aliases: ol-prefix

Parameters: style (:one, :ordered; default :one)

This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').

Example valid list if the style is configured as 'one':

1. Do this.
1. Do that.
1. Done.

Example valid list if the style is configured as 'ordered':

1. Do this.
2. Do that.
3. Done.

Line length
Open

1. Set the `HIGHLIGHT_PROJECT_ID` environment variable in `.env` to your Highlight project id.
Severity: Info
Found in examples/minimal/README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length

Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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. To do this, set the ignore_code_blocks parameter to true. To exclude this rule for tables set the tables parameters to false. Setting the parameter code_blocks to false to exclude the rule for code blocks is deprecated and will be removed in a future release.

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.

Line length
Open

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length

Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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. To do this, set the ignore_code_blocks parameter to true. To exclude this rule for tables set the tables parameters to false. Setting the parameter code_blocks to false to exclude the rule for code blocks is deprecated and will be removed in a future release.

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.

Line length
Open

- [api](api) - Example of how to use the `slog-highlight` library with the [go-chi](https://go-chi.io) router.
Severity: Info
Found in examples/README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length

Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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. To do this, set the ignore_code_blocks parameter to true. To exclude this rule for tables set the tables parameters to false. Setting the parameter code_blocks to false to exclude the rule for code blocks is deprecated and will be removed in a future release.

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.

Line length
Open

1. Set the `HIGHLIGHT_PROJECT_ID` environment variable in `.env` to your Highlight project id.
Severity: Info
Found in examples/multi/README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length

Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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. To do this, set the ignore_code_blocks parameter to true. To exclude this rule for tables set the tables parameters to false. Setting the parameter code_blocks to false to exclude the rule for code blocks is deprecated and will be removed in a future release.

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.

typecheck: undefined: highlight
Open

    span.AddEvent(highlight.LogEvent, trace.WithAttributes(attrs...), trace.WithTimestamp(r.Time))

Severity: Minor
Found in logger.go by golangci-lint

typecheck: undefined: highlight
Open

    span, _ := highlight.StartTrace(ctx, "highlight-go/log")
    defer highlight.EndTrace(span)
Severity: Minor
Found in logger.go by golangci-lint

typecheck: undefined: HighlightHandler
Open

type HighlightHandlerOption func(*HighlightHandler) error

Severity: Minor
Found in option.go by golangci-lint

typecheck: undefined: HighlightHandlerOption
Open

func NewHighlightHandler(options ...HighlightHandlerOption) slog.Handler {
    h := &HighlightHandler{
Severity: Minor
Found in logger.go by golangci-lint

typecheck: undefined: highlight
Open

    defer highlight.EndTrace(span)

Severity: Minor
Found in logger.go by golangci-lint

TODO found
Open

        // TODO: correctly type infer the values
Severity: Minor
Found in logger.go by fixme

typecheck: undefined: HighlightHandler
Open

    return func(h *HighlightHandler) error {
        h.level = level
Severity: Minor
Found in option.go by golangci-lint
Severity
Category
Status
Source
Language