Skip to content

feat(typescript-estree): throw custom error instead of plain object #3011

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 7 commits into from
Feb 28, 2021
Merged

feat(typescript-estree): throw custom error instead of plain object #3011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3903add
feat(typescript-estree): throw custom error instead of plain object
armano2 Feb 7, 2021
4a5b20c
fix(typescript-estree): merge TSError with ParseError
armano2 Feb 7, 2021
80ea072
test(typescript-estree): add custom serializer for TSError
armano2 Feb 8, 2021
130b4a7
fix(typescript-estree): add missing readonly modifiers
armano2 Feb 8, 2021
8604da4
test(typescript-estree): improve printing TSError in snapshots
armano2 Feb 8, 2021
e28ee8b
fix(typescript-estree): remove prototype and update serializer
armano2 Feb 8, 2021
582ff63
test: correct issue with TSError
armano2 Feb 15, 2021
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
29 changes: 17 additions & 12 deletions packages/typescript-estree/src/node-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,16 +649,26 @@ export function convertTokens(ast: ts.SourceFile): TSESTree.Token[] {
return result;
}

export interface TSError {
index: number;
lineNumber: number;
column: number;
message: string;
export class TSError extends Error {
constructor(
message: string,
public readonly fileName: string,
public readonly index: number,
public readonly lineNumber: number,
public readonly column: number,
) {
super(message);
Object.defineProperty(this, 'name', {
value: new.target.name,
enumerable: false,
configurable: true,
});
}
}

/**
* @param ast the AST object
* @param start the index at which the error starts
* @param start the index at which the error starts
* @param message the error message
* @returns converted error object
*/
Expand All @@ -668,12 +678,7 @@ export function createError(
message: string,
): TSError {
const loc = ast.getLineAndCharacterOfPosition(start);
return {
index: start,
lineNumber: loc.line + 1,
column: loc.character,
message,
};
return new TSError(message, ast.fileName, start, loc.line + 1, loc.character);
}

/**
Expand Down
5 changes: 4 additions & 1 deletion packages/typescript-estree/tests/ast-fixtures.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import fs from 'fs';
import glob from 'glob';
import 'jest-specific-snapshot';
import { addSerializer } from 'jest-specific-snapshot';
import makeDir from 'make-dir';
import path from 'path';
import { parseAndGenerateServices } from '../src/parser';
import { isJSXFileType } from '../tools/test-utils';
import { serializer } from '../tools/tserror-serializer';

addSerializer(serializer);

// Assign a segment set to this variable to limit the test to only this segment
// This is super helpful if you need to debug why a specific fixture isn't producing the correct output
Expand Down
Loading