Skip to content

feat(eslint): Enforce that ts-expect-error is used #8987

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
merged 2 commits into from
Sep 11, 2023
Merged

feat(eslint): Enforce that ts-expect-error is used #8987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb085ee
feat(eslint): Enforce that ts-expect-error is used
AbhiPrasad Sep 8, 2023
df2a033
Merge branch 'develop' into abhi-enforce-ts-expect-error
AbhiPrasad Sep 8, 2023
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
2 changes: 1 addition & 1 deletion packages/core/src/integrations/inboundfilters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ function _getPossibleEventMessages(event: Event): string[] {

let lastException;
try {
// @ts-ignore Try catching to save bundle size
// @ts-expect-error Try catching to save bundle size
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
lastException = event.exception.values[event.exception.values.length - 1];
} catch (e) {
Expand Down
10 changes: 3 additions & 7 deletions packages/eslint-config-sdk/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,9 @@ module.exports = {
// Unused variables should be removed unless they are marked with and underscore (ex. _varName).
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],

// Make sure that all ts-ignore comments are given a description.
'@typescript-eslint/ban-ts-comment': [
'warn',
{
'ts-ignore': 'allow-with-description',
},
],
// Do not use ts-ignore, use ts-expect-error instead.
// Also make sure that all ts-expect-error comments are given a description.
'@typescript-eslint/ban-ts-comment': 'error',

// Types usage should be explicit as possible, so we prevent usage of inferrable types.
// This is especially important because we have a public API, so usage needs to be as
Expand Down