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

fix: Add Type <T> #540

Merged
merged 1 commit into from
Oct 5, 2024
Merged

fix: Add Type <T> #540

merged 1 commit into from
Oct 5, 2024

Conversation

philipbrembeck
Copy link
Contributor

@philipbrembeck philipbrembeck commented Oct 5, 2024

Summary by Sourcery

Improve type safety in the readJsonFile function by adding a generic type parameter and update JSON files to reflect changes in vegan and non-vegan ingredient lists.

Bug Fixes:

  • Add generic type parameter to the readJsonFile function to ensure type safety when parsing JSON data.

Chores:

  • Update the isnotvegan.json file by adding 'E631' and 'E1105' to the list.
  • Update the isvegan.json file by removing 'E631' and 'E999' from the list.

Copy link

stackblitz bot commented Oct 5, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

sourcery-ai bot commented Oct 5, 2024

Reviewer's Guide by Sourcery

This pull request introduces a generic type parameter to the readJsonFile function for improved type safety, and updates the isnotvegan.json and isvegan.json files with some ingredient changes.

Class diagram for updated readJsonFile function

classDiagram
    class JsonFileReader {
        +readJsonFile<T>(filePath: string): Promise<T>
    }
Loading

File-Level Changes

Change Details Files
Add generic type parameter to readJsonFile function
  • Introduce generic type parameter to the function signature
  • Update the return type to Promise
  • Cast the parsed JSON data to type T
src/ingredients/jsonFileReader.ts
Update non-vegan ingredients list
  • Add 'E631' to the list of non-vegan ingredients
  • Replace 'E966' with 'E1105' in the list
isnotvegan.json
Update vegan ingredients list
  • Remove 'E631' from the list of vegan ingredients
  • Remove 'E999' from the list of vegan ingredients
isvegan.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@philipbrembeck philipbrembeck merged commit dd4e7f2 into main Oct 5, 2024
6 checks passed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @philipbrembeck - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

1 participant