This repository has been archived by the owner on Dec 8, 2022. It is now read-only.
feat(*): add SDK core #1
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
* support staticcheck * save report to JSON * generate TOML files for each issue * use a markdown parser for parsing issue descriptions
|
Using TOML files. |
* integration tests for analyzers * parse triggers using tree-sitter * utilities for working with tree-sitter * staticcheck trigger for tree-sitter
There was a problem hiding this comment.
- Make the CLI runner more robust (handle stderr, stdout and also allow safe exits in case of non-zero exit codes).
- Processor (takes the result from the CLI output, and converts it to our format): The processor should receive an io.Reader interface, and return the report.
- Reporter (takes in the report in our format, and returns a io.Writer): Return an io.Writer to
RunandRunshould write it to the desired location. - Processors:
a. Do not write processors for specific CLI formats. Add support for the common ones, likepep8,emacs,go vet,go-ruleguardetc.
b. Processor should be specified in the struct. - Specifying issues:
a. Use a single issues.toml:
[[issues]]
code = "U1000"
description = """
This is **an** issue.
"""
[[issues]]
code="compile"
...- Add support for more languages in tree-sitter comment parser.
- Reorganize the code.
* add unit tests * update SDK structure * clean analyzer fields * add unix processor * add utilities
* test TOML generation and verify content * add workflow for running tests
refactor(*): refactor SDK and add tests
sourya-deepsource
suggested changes
Jun 13, 2022
|
Can you add a |
* use environment variable based exporting * use named groups for RegexProcessor
* guide for writing CSS analyzer * add issueProcessor
* add integration test for CSS using csslint * cleanup tests
sourya-deepsource
suggested changes
Jun 15, 2022
* refactor tests * add guide for testing analyzers
sourya-deepsource
approved these changes
Jun 15, 2022
vishnu-deepsource
suggested changes
Jun 16, 2022
There was a problem hiding this comment.
@burntcarrot Write unit tests. Since this SDK lot of data wrangling, not writing unit tests will cause a lot of maintainability issues.
vishnu-deepsource
suggested changes
Jun 16, 2022
|
Added unit tests; ready for review. |
vishnu-deepsource
suggested changes
Jun 17, 2022
| } | ||
|
|
||
| // readMarkdown is a helper utility used for parsing and sanitizing markdown content. | ||
| func readMarkdown(content string) (string, error) { |
There was a problem hiding this comment.
content can be accepted as a byte array..
Comment on lines
+93
to
+95
| } else { | ||
| issue.IssueCode = issueCodeGenerator(content) | ||
| } |
There was a problem hiding this comment.
nitpick: Do we need this else block? Does it improve readability by much? @sourya-deepsource
vishnu-deepsource
approved these changes
Jun 20, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
tree-sitter