MB-10168-custom-linter-doc #49
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
felipe-lee
reviewed
Nov 24, 2021
felipe-lee
reviewed
Nov 30, 2021
|
|
||
| The linter is actually analyzing an abstract syntax tree, AST, that represents code in a file. | ||
| When your linter gets to a position in a file, where it catches an error, bug, or issue, it will flag this for the user. | ||
| Because the linter is analyzing an AST, your code must be able to search through a file and mark which position it is when an issue is caught. |
There was a problem hiding this comment.
I'm not sure if it would be good or not to include an example of what it looks like to mark a position with a message.
There was a problem hiding this comment.
What do you mean?
There was a problem hiding this comment.
Like showing an example like this:
https://github.com/transcom/mymove/blob/d8d2b3862a28b344a1afdbb1a781d6529f04feb8/pkg/appcontext-linter/appctx.go#L46
To show that you call the .Pos() method on an AST object to get its position and pass that along with a message to pass.Reportf to report an issue found in the code. Maybe this is getting to specific though and they should just get that from reading the linked article on how to write the run function.
felipe-lee
approved these changes
Nov 30, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
In this document I wrote a how-to guide for creating Custom Go linters in MyMove and linked to resources that helped us write our linters.
Note for reviewer:
-Please leave feedback on how readable this guide is. Are the instructions clear? Is there anything missing?