Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Override style-guide citation links and references #519

Open
fangism opened this issue Oct 1, 2020 · 4 comments
Open

Override style-guide citation links and references #519

fangism opened this issue Oct 1, 2020 · 4 comments
Assignees
Labels
enhancement New feature or request style-linter Verilog style-linter issues

Comments

@fangism
Copy link
Collaborator

fangism commented Oct 1, 2020

Summary

Currently, style guide citation links are hard-coded into the rule implementations themselves.
In the future, users and rule-set maintainers may wish to redirect these to point to their own style guides.

Proposal

Have a way at run-time to re-map each rule's citation to a new link, for example loading such a map through a command-line option that reads an external configuration.

@fangism fangism added enhancement New feature or request style-linter Verilog style-linter issues labels Oct 1, 2020
@fangism
Copy link
Collaborator Author

fangism commented Oct 1, 2020

b/169867142

@pawelsag
Copy link
Contributor

pawelsag commented Apr 2, 2021

I'm thinking about loading the custom style guide citation from the JSON file. What do you think about this idea?

@mithro
Copy link
Collaborator

mithro commented Apr 2, 2021

I would suggest that we follow whatever other tools do in this area? What do clang-format and pylint do?

@pawelsag pawelsag self-assigned this Apr 23, 2021
@pawelsag
Copy link
Contributor

Most of the tools are using just plain text configuration in a format

key1: value
key2: value

I will do the same for our config:

rule 1: style guide citation 1
rule 2: style guide citation 2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request style-linter Verilog style-linter issues
Projects
None yet
Development

No branches or pull requests

3 participants