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
feat(framework-core): main interface for create review on a pull request #114
Conversation
Codecov Report
@@ Coverage Diff @@
## comment-pr #114 +/- ##
==============================================
+ Coverage 85.44% 92.08% +6.63%
==============================================
Files 26 26
Lines 2213 2325 +112
Branches 151 182 +31
==============================================
+ Hits 1891 2141 +250
+ Misses 321 183 -138
Partials 1 1
Continue to review full report at Codecov.
|
5497076
to
321107a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Kristie!
src/default-options-handler.ts
Outdated
* @param options The user's options input for review comments | ||
* @returns the formatted version of user input for pull request review comments | ||
*/ | ||
export function addRevuewCommentsDefaults( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export function addRevuewCommentsDefaults( | |
export function addReviewCommentsDefaults( |
src/index.ts
Outdated
repo: gitHubConfigs.repo, | ||
}; | ||
logger.info( | ||
`Successfully created a review on pull requestt: ${gitHubConfigs.pullNumber}.` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`Successfully created a review on pull requestt: ${gitHubConfigs.pullNumber}.` | |
`Successfully created a review on pull request: ${gitHubConfigs.pullNumber}.` |
src/default-options-handler.ts
Outdated
) { | ||
const reviewCommentSettings: CreateReviewComment = { | ||
repo: options.repo, | ||
owner: options.owner, | ||
pullNumber: options.pullNumber, | ||
// if zero set as 0 | ||
pageSize: | ||
options.pageSize === null || options.pageSize === undefined | ||
? DEFAULT_PAGE_SIZE | ||
: options.pageSize, | ||
}; | ||
return reviewCommentSettings; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's declare the return type in the signature and then we can return the object directly.
src/index.ts
Outdated
); | ||
return; | ||
} | ||
const gitHubConfigs = addRevuewCommentsDefaults(options); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we name this createReviewComment
as it's a CreateReviewComment
type?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking solid to me once @chingor13's typo and naming nits are addressed.
…n pull requests (#105) * feat(patch text to hunk bounds): support regex for patch texts (#83) * fix(patch text to hunk bounds): support regex for patch texts * more comments and more tests * fix(framework-core): core-library get remote patch ranges (#84) * fix(framework-core): given files old content and new content, compute the valid hunks (#86) * fix(framework-core): parse raw changes to ranges * refactor(framework-core): rename modules, functions, & re-org project structure (#89) * fix(framework-core): hunk to patch object (#91) * feat: build failure message from invalid hunks (#90) * test: add failing stub and test for building the failure message * fix: implement message building * fix: use original line numbers in error message * docs: add docstring * docs: add note about empty input returning empty string * feat(framework-core): comment on prs given suggestions (#93) * feat(framework-core): main interface for create review on a pull request (#114) * feat(framework-core): main interface for create review on a pull request * docs: fix typo * nits and typos... * gts lint warning fix * fix(framework-core): combine review comments (#116) * fix(framework-core): collapsing timeline and inline comments into single review * test: fixed imports * added case when there are out of scope suggestions and no valid suggestions * feat(framework-core): return review number and variable renaming (#117) * feat(framework-core): return review number and variable renaming * lint Co-authored-by: Jeff Ching <chingor@google.com> Co-authored-by: Justin Beckwith <justin.beckwith@gmail.com> Co-authored-by: Benjamin E. Coe <bencoe@google.com>
Main interface for frame-work core, documentation + review comments:
comment
toreviewPullRequest
PR commit for #105