chore(eslint): use @typescript-eslint/stylistic rules #2821
Conversation
csouchet
added
chore
|
♻️ PR Preview 9b01ca9 has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
|
♻️ PR Preview 9b01ca9 has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
csouchet
changed the title
tbouffard
changed the title
There was a problem hiding this comment.
This seems OK.
Let's review potential impacts of switching from type to interface for users of the lib.
- https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#differences-between-type-aliases-and-interfaces
- https://typescript-eslint.io/rules/consistent-type-definitions (default: interface)
This will probably break some extensions like
There was a problem hiding this comment.
👍🏿 Good points:
- consistent syntax when casting and for declaring arrays
- the syntax when declaring a Map is clearer
🤔 The transition from interfaces to types in the public API can also introduce breaks, in the same way as if we decide to use only interfaces.
Let's discuss this in person.
(cherry picked from commit 63e073e)
…e 'type' and not 'interface' (cherry picked from commit 78bcbd5)
(cherry picked from commit 2854fc9)
(cherry picked from commit 26ad0a6)
(cherry picked from commit 43086bf)
(cherry picked from commit 4058e5a)
(cherry picked from commit be829fa56be1867a3bbd479c219d5af12d069897)
csouchet
force-pushed
the
2742-use_stylistic_rule
branch
from
6154ac1
to
0e93a22
Compare
|
As decided with @tbouffard, I disabled the |
| @@ -63,6 +64,7 @@ module.exports = { | |||
| }, | |||
| ], | |||
| '@typescript-eslint/consistent-type-imports': ['error'], | |||
| '@typescript-eslint/consistent-type-definitions': 'off', | |||
There was a problem hiding this comment.
suggestion: we may add a comment to explain why we disable it for know. Adding a link to the PR comment is enough IMHO
|
Kudos, SonarCloud Quality Gate passed! |
Introduced the
plugin:@typescript-eslint/stylisticrules. This addition ensures that the code follows consistent and recommended coding practices.Addressed linting issues identified by
plugin:@typescript-eslint/stylistic.ℹ️ See configs/stylistic.ts for the exact contents of this config.
Covers #2742