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

chore: encourage return types in function definitions #1364

Merged
merged 15 commits into from
Jan 15, 2025

Conversation

samayer12
Copy link
Collaborator

Description

Encourage non-test code to specify return types.

Related Issue

Hotifx

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.40%. Comparing base (a4a942f) to head (6685fea).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1364   +/-   ##
=======================================
  Coverage   81.40%   81.40%           
=======================================
  Files          43       43           
  Lines        1979     1979           
  Branches      411      438   +27     
=======================================
  Hits         1611     1611           
  Misses        366      366           
  Partials        2        2           

@samayer12 samayer12 force-pushed the hotfix-return-types-in-funcs branch from 7c0cc20 to adfacf1 Compare October 31, 2024 16:04
@samayer12 samayer12 marked this pull request as ready for review October 31, 2024 16:04
@samayer12 samayer12 requested a review from a team as a code owner October 31, 2024 16:04
Copy link
Contributor

@schaeferka schaeferka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This will help us track down these issues.

@samayer12 samayer12 changed the title Encourage return types in function definitions chore: encourage return types in function definitions Oct 31, 2024
@samayer12
Copy link
Collaborator Author

samayer12 commented Nov 4, 2024

This PR would make the logs pretty noisy, but is useful for the project. After discussion with @btlghrants, we're opted to put this on hold while we work on other outstanding refactors (e.g., #1248, #1371, #1250, #1247, etc). This PR will be suitable to revisit once the existing set of linter warnings are resolved.

@samayer12 samayer12 self-assigned this Dec 12, 2024
github-merge-queue bot pushed a commit that referenced this pull request Jan 6, 2025
## Description

Adds typing to `templates.ts`

End to End Test:  <!-- if applicable -->  
(See [Pepr Excellent
Examples](https://github.com/defenseunicorns/pepr-excellent-examples))

## Related Issue

Relates to #1364 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging
- [x] Unit,
[Journey](https://github.com/defenseunicorns/pepr/tree/main/journey),
[E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples),
[docs](https://github.com/defenseunicorns/pepr/tree/main/docs),
[adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or
updated as needed
- [x] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request)
followed

---------

Co-authored-by: Case Wylie <[email protected]>
@samayer12 samayer12 requested a review from a team January 7, 2025 19:39
github-merge-queue bot pushed a commit that referenced this pull request Jan 14, 2025
## Description

In support of #1364, this PR adds typing to previously-untyped
functions.

End to End Test:  <!-- if applicable -->  
(See [Pepr Excellent
Examples](https://github.com/defenseunicorns/pepr-excellent-examples))

## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging
- [ ] Unit,
[Journey](https://github.com/defenseunicorns/pepr/tree/main/journey),
[E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples),
[docs](https://github.com/defenseunicorns/pepr/tree/main/docs),
[adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or
updated as needed
- [ ] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request)
followed
Copy link
Collaborator

@cmwylie19 cmwylie19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The team agrees that it is now time to turn this on. We only have 3 left

@cmwylie19 cmwylie19 enabled auto-merge January 15, 2025 14:32
@cmwylie19 cmwylie19 added this pull request to the merge queue Jan 15, 2025
Merged via the queue into main with commit ff12d45 Jan 15, 2025
47 of 48 checks passed
@cmwylie19 cmwylie19 deleted the hotfix-return-types-in-funcs branch January 15, 2025 14:44
tamirazrab pushed a commit to tamirazrab/pepr that referenced this pull request Jan 17, 2025
## Description

In support of defenseunicorns#1364, this PR adds typing to previously-untyped
functions.

End to End Test:  <!-- if applicable -->  
(See [Pepr Excellent
Examples](https://github.com/defenseunicorns/pepr-excellent-examples))

## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging
- [ ] Unit,
[Journey](https://github.com/defenseunicorns/pepr/tree/main/journey),
[E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples),
[docs](https://github.com/defenseunicorns/pepr/tree/main/docs),
[adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or
updated as needed
- [ ] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request)
followed
tamirazrab pushed a commit to tamirazrab/pepr that referenced this pull request Jan 17, 2025
…s#1364)

## Description

Encourage non-test code to specify return types.

## Related Issue

Hotifx

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging
- [x] Unit,
[Journey](https://github.com/defenseunicorns/pepr/tree/main/journey),
[E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples),
[docs](https://github.com/defenseunicorns/pepr/tree/main/docs),
[adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or
updated as needed
- [x] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request)
followed

Co-authored-by: Case Wylie <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants