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

[#197] Dependent RepoInfo keys example #243

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aeqz
Copy link
Contributor

@aeqz aeqz commented Dec 15, 2022

Description

Problem: During the implementation of issue #197, we though about how we could customize the way filepaths are searched within the repository data in an efficient way, depending on whether filepaths are case-insensitive or not.

Solution: We implemented a GADT with its polymorphic parameter, corresponding to Map keys, hidden under an existentially quantified type. Although we end up not requiring this, we separate the essence of the idea to a commit in a separate branch, so it can be reviewed in the future.

Related issue(s)

Relates #197

✅ Checklist for your Pull Request

Ideally a PR has all of the checkmarks set.

If something in this list is irrelevant to your PR, you should still set this
checkmark indicating that you are sure it is dealt with (be that by irrelevance).

Related changes (conditional)

  • Tests

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from
      silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
  • Public contracts

    • Any modifications of public contracts comply with the Evolution
      of Public Contracts
      policy.
    • I added an entry to the changelog if my changes are visible to the users
      and
    • provided a migration guide for breaking changes if possible

Stylistic guide (mandatory)

Problem: During the implementation of issue #197, we though about how we
could customize the way filepaths are searched within the repository data
in an efficient way, depending on if filepaths are case-insensitive or not.

Solution: We implemented a GADT with its polymorphic parameter, corresponding
to Map keys, hidden under an existentially quantified type. Although we end up
not requiring this, we separate the essence of the idea to a commit in a
separate branch, so it can be reviewed in the future.
@aeqz aeqz mentioned this pull request Dec 15, 2022
8 tasks
@Martoon-00
Copy link
Member

I believe these changes may be handy if in the future we implement different scanners. As different languages may use different filepath formats when referring to the surrounding files, and these formats may have different comparison rules.

I suggested few changes to this PR in this thread.

We have to thoroughly think about use cases again and decide how much sense all this have.

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