feat: introduce todo-bot #4443
Draft
feat: introduce todo-bot #4443
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
tmatsuo
reviewed
Sep 22, 2022
| const contextMatcher = new RegExp( | ||
| `${annotation}(?:\\((?<context>.*)\\))?:` | ||
| ); | ||
| const {stdout} = await exec(`grep -rn -E '${annotation}(\\(.*\\))?:'`, { |
There was a problem hiding this comment.
Is it possible not to use exec?
There was a problem hiding this comment.
We could try to rewrite the functionality of scanning every file in a directory for a pattern, but this was expecting to run on Cloud Run where we control the runtime (git and grep would be installed).
There was a problem hiding this comment.
I also assume grep will be way more efficient in terms of speed and memory usage than we can possibly do in node.
|
|
||
| // TODO: example todo | ||
| // TODO(context): another example annotation | ||
| async findAnnotations(annotations: string[]): Promise<Annotation[]> { |
There was a problem hiding this comment.
How about to make the interface receiving a list of regex and returning the match object?
That way it's more generic
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.
This is a proof of concept for scanning a repository for annotations (like
TODOorFIXME). The bot does not do anything useful with the results of the scan.Currently implemented is an
AnnotationScannerclass which encapsulates the logic of shallow cloning a repo and scanning for annotations and a CLI to test it out locally.Fixes #1301