This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Improve an error message on invalid source file #1480
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rhysd
force-pushed
the
check-invalid-source
branch
from
0719a43
to
776c49d
Compare
|
nice, this partially addresses #516 |
| @@ -91,6 +91,10 @@ class Linter { | |||
| sourceFile = getSourceFile(this.fileName, this.source); | |||
| } | |||
|
|
|||
| if (sourceFile === undefined) { | |||
| throw new Error("Invalid source code: " + this.fileName); | |||
There was a problem hiding this comment.
can we be more descriptive here and suggest why the input is considered invalid? how about:
throw new Error(`Invalid source file "${this.fileName}". Ensure that the files supplied to lint have a .ts or .tsx extension.`);There was a problem hiding this comment.
I'm not sure that tsc only checks file extension. sourceFile may be undefined because of other than file extension.
There was a problem hiding this comment.
last time I touched this code IIRC tsc does care about the file extension. having the wrong extension is a common error I see in issue reports so that's why I suggested it for a small improvement to the error message
There was a problem hiding this comment.
I understood. I'll update the commit soon. Thanks 😄
rhysd
force-pushed
the
check-invalid-source
branch
from
776c49d
to
a6fa4fc
Compare
|
I fixed the point you commented 😄 |
rhysd
force-pushed
the
check-invalid-source
branch
from
a6fa4fc
to
78fef53
Compare
When input file is not a TypeScript code, `getSourceFile()` returns
`undefined` but tslint doesn't handle it properly. As the result,
tslint raises an error which is not easy to understand when invalid
soruce file is passed.
```
$ tslint mocha.opts
```
It raised below error:
```
/path/to/node_modules/tslint/lib/language/walker/ruleWalker.js:18
this.limit = this.sourceFile.getFullWidth();
```
I improved this error message by checking returned value from
`getSourceFile` is valid or not.
Improved error message is below:
```
Error: Invalid source code: test/mocha.opts
```
I didn't write a test for this yet because I couldn't find where I
should add tests for `src/tslint.ts`.
|
thanks @rhysd! |
soniro
pushed a commit
to soniro/tslint
that referenced
this pull request
Aug 31, 2016
Partially addresses palantir#516.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When input file is not a TypeScript code,
getSourceFile()returnsundefinedbut tslint doesn't handle it properly. As the result, tslint raises an error which is not easy to understand when invalid soruce file is passed.It raised below error:
I improved this error message by checking returned value from
getSourceFileis valid or not. Improved error message is below:I didn't write a test for this yet because I couldn't find where I should add tests for
src/tslint.ts.