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

[Dev] Add prettylint to CI #1110

Merged
merged 1 commit into from
Sep 29, 2023
Merged

[Dev] Add prettylint to CI #1110

merged 1 commit into from
Sep 29, 2023

Conversation

jkasten2
Copy link
Member

@jkasten2 jkasten2 commented Sep 29, 2023

Description

1 Line Summary

Provides exact prettier errors when it fails in CI.

Details

Screenshots

prettier (before)

image

prettylint (after)

image

Validation

Tests

Info

Checklist

  • All the automated tests pass or I explained why that is not possible
  • I have personally tested this on my machine or explained why that is not possible
  • I have included test coverage for these changes or explained why they are not needed

Programming Checklist
Interfaces:

  • Don't use default export
  • New interfaces are in model files

Functions:

  • Don't use default export
  • All function signatures have return types
  • Helpers should not access any data but rather be given the data to operate on.

Typescript:

  • No Typescript warnings
  • Avoid silencing null/undefined warnings with the exclamation point

Other:

  • Iteration: refrain from using elem of array syntax. Prefer forEach or use map
  • Avoid using global OneSignal accessor for context if possible. Instead, we can pass it to function/constructor so that we don't call OneSignal.context

Screenshots

Info

Checklist

  • I have included screenshots/recordings of the intended results or explained why they are not needed

Related Tickets



This change is Reviewable

The prettier CLI tool only provides a list of files that failed its
check which isn't helpful for someone trying to find the problem based
on the CI failing. The prettylint tool provides a human readable
message on how to fix the issue.
Base automatically changed from upgrade-to-node18 to main September 29, 2023 22:00
@jkasten2 jkasten2 merged commit ca6b116 into main Sep 29, 2023
2 checks passed
@jkasten2 jkasten2 deleted the dev/add-prettylint-to-ci branch September 29, 2023 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants