Skip to content

chore: Reconfigure @typescript-eslint/explicit-function-return-type #38

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.

Sign up for GitHub

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

Merged
rekmarks merged 1 commit into from
Aug 28, 2024
Merged

chore: Reconfigure @typescript-eslint/explicit-function-return-type #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,16 @@ module.exports = {
project: ['./tsconfig.packages.json'],
},
rules: {
'@typescript-eslint/explicit-function-return-type': [
'error',
{
// To permit omitting the return type in situations like:
// `const obj = { foo: (bar: string) => bar };`
// We'll presume that `obj` has a type that enforces the return type.
allowExpressions: true,
},
],

'@typescript-eslint/no-explicit-any': 'error',

// This rule is broken, and without the `allowAny` option, it reports a lot
Expand Down
5 changes: 3 additions & 2 deletions packages/shims/src/vitest-environment-endoified.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ export default {
clearTimeout,
});
},
// eslint-disable-next-line no-empty-function
teardown(): void {},
teardown(): void {
return undefined;
},
Comment on lines +16 to +18
Copy link
Contributor

@SMotaal SMotaal Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rekmarks This is not a blocker, just curiosity about the reasons for this?

As far as the runtime is concerned, they are equivalent, as long as the runtime is optimizing for no-op returning undefined.

Copy link
Member Author

@rekmarks rekmarks Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should prefer code of equivalent behavior and complexity over lint exceptions when possible. Lint rules exist for a reason, and the more exceptions we add, the more we compromise the stylistic and behavioral patterns we want to enforce with our lint rules. Lint exceptions should therefore only be used when necessary.

};
},
async setup() {
Expand Down