[FEATURE]: add TS checklist #13
Conversation
mibled
added
documentation
| @@ -1 +1,178 @@ | |||
| # TypeScript Best Practices | |||
|
|
|||
| 1. **Consistent Coding Style**: | |||
There was a problem hiding this comment.
I think that the official lint recommended configuration is :
https://github.com/typescript-eslint/typescript-eslint
https://typescript-eslint.io/getting-started
https://typescript-eslint.io/users/configs/
I think we dont need again to use "airbnb-typescript".
|
|
||
| Configure ESLint: Create or modify the `.eslintrc.json` file at the root of your project with the following configuration: | ||
|
|
||
| ```json |
There was a problem hiding this comment.
I recommend to not add a configuration code since it can oftenly changes. We can say:
- Use a linter like ESLint to maintain a consistent coding style.
- The recommended configuration => link to https://typescript-eslint.io/getting-started
| ``` | ||
|
|
||
| 3. **Interfaces**: | ||
| - **Explanation**: Prefer interfaces over type aliases for defining object shapes. |
There was a problem hiding this comment.
personally I prefer using type until I need to "extends" then I use interface.
type is more intuitive to define type.
interface is more about contract that an object must adhere to or protocol.
| } | ||
| ``` | ||
|
|
||
| 4. **Avoid `any`**: |
| } | ||
| ``` | ||
|
|
||
| 7. **Prefer `const` over `let`**: |
There was a problem hiding this comment.
this is more related to JS than a specific TS feature, it's common for both JS and TS.
We can have as prerequisite at the begin for example: Adhere to JS best practices => link to JS gems.
| type UserWithoutEmail = Omit<User, 'email'>; | ||
| ``` | ||
|
|
||
| 9. **Avoid Magic Numbers and Strings**: |
There was a problem hiding this comment.
| } | ||
| ``` | ||
|
|
||
| 10. **Document Your Code**: |
There was a problem hiding this comment.
Add a new checklist for Typescript