mkosir / typescript-style-guide

⚙️ TypeScript Style Guide. Concise set of conventions and best practices used to create consistent, maintainable code.

TypeScript Style Guide

TypeScript Style Guide provides a concise set of conventions and best practices used to create consistent, maintainable code.

Go to 👉 TypeScript Style Guide

Why

• As project grow in size and complexity, maintaining code quality and ensuring consistent practices becomes increasingly challenging.
• Defining and following a standard way to write TypeScript applications brings consistent codebase and faster development cycles.
• No need to discuss code styles in code reviews.
• Saves team time and energy.

Contributing

All contributions are welcome! Open a PR, issue or discussion.

typescript-style-guide's Issues

Differences between Types and Interfaces

Description

Hey @mkosir ,

I hope you're doing well! I wanted to discuss the section "Type Definition." I'm not entirely certain, but I think there might be a small issue with the text.

It currently says:
"Both are nearly equivalent, so to choose one is mostly an arbitrary decision to achieve a consistent codebase."

In my opinion, types offer more flexibility when defining union and intersection types, and for new projects, I think they could be preferable. What do you think?

For more information, you can check out this link:
Typescript-book on GitHub

If you have any questions or need further clarification, feel free to ask. Thanks for your time! 😊

Note background too dark in light mode

Description

The background color of a note doesn't change between dark/light mode, causing it to be hard to read in light mode.