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: use more verbose naming for secondary types when needed #1147

Open
weboko opened this issue Feb 1, 2023 · 1 comment
Open

chore: use more verbose naming for secondary types when needed #1147

weboko opened this issue Feb 1, 2023 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@weboko
Copy link
Collaborator

weboko commented Feb 1, 2023

This is a change request

Problem

It seems that in some places we use way to generic type definition names for data structures such as Options. Due to ts-doc we still need to export them even though they are no intended to be used outside.

This can cause some minor issues in the future:

  • naming collision on the side of consumer if someone accidentally imports it;
  • naming collision within the library due to modular nature of it: some packages can re-export it and we can end up with different types with the same name.

Proposed Solutions

We should use more precise naming while avoiding being too verbose.

This issue is for tracking renaming of too-general type names.

Notes

Original discussion: https://github.com/waku-org/js-waku/pull/1135/files#diff-f7c943c7b03f1d1fa65caeacc3a9e74bfc34e1f40b4d373e0b7aa522b35400deR39

@weboko weboko added enhancement New feature or request good first issue Good for newcomers labels Feb 1, 2023
@fryorcraken
Copy link
Collaborator

Something to keep in mind by the whole team moving forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Status: To Do
Development

No branches or pull requests

2 participants