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

Naming interfaces and types #25

Closed
pwalsh opened this issue Dec 19, 2021 · 1 comment
Closed

Naming interfaces and types #25

pwalsh opened this issue Dec 19, 2021 · 1 comment

Comments

@pwalsh
Copy link
Member

pwalsh commented Dec 19, 2021

It is not idiomatic TypeScript to prefix interfaces with I (See here and here, an in general, any of the types from @types), and so on creation of this codebase, I didn't carry over the usage of I prefixed interfaces in general from the internal codebase it is based on.

As documented, I did retain I prefixes for a special meaning - as a way to indicate interfaces that can be overridden by plugins.

Some recent additions used the I prefix for non-pluggable interfaces. Let's discuss, so that the codebase remains consistent.

@pwalsh
Copy link
Member Author

pwalsh commented Dec 20, 2021

We are going to stick with using I for interfaces that can be overridden by plugins.

@pwalsh pwalsh closed this as completed Dec 20, 2021
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

No branches or pull requests

1 participant