Skip to content

Documentation: Invalid example configuration #295

Description

@tifrueh

I just set up svls with nvim-lspconfig and tried to just dump the example configuration from the manual into .svlint.toml to try out the linting. For reference, this example configuration looks like this:

[option]
exclude_paths = ["ip/.*"]
prefix_label = "lab_"

[textrules]
style_indent = true

[syntaxrules]
module_nonansi_forbidden = true
keyword_forbidden_wire_reg = true

But using this config I got a warning from neovim:

LSP[svls][Warning] Failed to parse /path/to/.svlint.toml. Enable all lint rules.

After digging around in the rest of the manual a bit, I found that style_indent is not a text rule, but rather a syntax rule, which seems to be why the parse failure happens. I think it might make sense to update that configuration in the manual (it is in md/manual-introduction.md, I believe).

Or was this done intentionally to prevent users from just using the configuration blindly?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions