Fix TypeScript error line/column by Zarel · Pull Request #125 · actions/setup-node

Zarel · 2020-03-24T05:42:24Z

Fixes#97

Zarel · 2020-03-24T05:51:01Z

I tested this on my own repository and it works!

Screenshot of it working:

Zarel · 2020-04-09T18:50:11Z

I'm surprised this hasn't gotten any attention after 17 days.

In the meantime, if you want this fixed in your local repository, it's a reasonably simple change:

Zarel · 2020-04-09T18:51:47Z

@ericsciple you self-assigned the bug this PR fixes; would you be interested in reviewing this?

bryanmacfarlane · 2020-05-02T15:46:56Z

Sorry. Been busy on some other changes. I'll have a look soon.

chancancode · 2020-05-28T21:12:38Z

+ "regexp": "^(?:\\s+\\d+\\>)?([^\\s].*)\\((\\d+)(?:,(\\d+)(?:,\\d+(?:,\\d+)?)?)?\\)\\s*:\\s+(error|warning|info)\\s+(\\w{1,2}\\d+)\\s*:\\s*(.*)$",
 "file": 1,
- "location": 2,
- "severity": 3,
- "code": 4,
- "message": 5
+ "line": 2,
+ "column": 3,
+ "severity": 4,
+ "code": 5,
+ "message": 6


I cannot human-parse this regex, but maybe this should just use the official $tsc pattern from vscode? Source: https://github.com/microsoft/vscode/blob/master/extensions/typescript-language-features/package.json#L974-L981 (it is not the same as this one)

I have tested the official regex and can confirm that it works:
// commit this file to .github/tsc.json{"problemMatcher": [{"owner": "tsc","pattern": [{"name": "tsc","regexp": "^([^\\s].*)[\$:](\\d+)[,:](\\d+)(?:\$:\\s+|\\s+-\\s+)(error|warning|info)\\s+TS(\\d+)\\s*:\\s*(.*)$","file": 1,"line": 2,"column": 3,"severity": 4,"code": 5,"message": 6}]}]}
- name: Set up Nodeuses: actions/setup-node@v1# Run this _after_ setup-node - name: Set up tsc problem matcherrun: echo "::add-matcher::${GITHUB_WORKSPACE}/.github/tsc.json"

Here is my regex, free-spaced and syntax highlighted:
Here is the official pattern from TypeScript, free-spaced and syntax-highlighted:
A TypeScript error message looks like this:
lib/net.ts(48,26): error TS1005: '}' expected.
Both regexes support that pattern. Mine is modified from the old one in this repository, which supported a variable number of commas.
In "fancy" mode, a TypeScript error message looks like this:
lib/net.ts:48:26 - error TS1005: '}' expected. 48 out += `${key}=${enc odeURIComponent('' + body[key])}`; ~~~~~~~~~~~~~~~
The official regex also supports this format (although it should never be passed to GitHub Actions in this format, in practice).

In conclusion, the official pattern is probably better.
Do you think the free-spaced annotated version should be put somewhere, for readability?
^ # filename ([^\s].*) # line number in "(1,2)" or ":1:2 -" format [$:] (\d+) [,:] (\d+) (?:$:\s+|\s+-\s+) # severity (error|warning|info) # error code \s+ TS(\d+) # ":" \s* : # error message \s* (.*) $
(It can be compiled into the version in the repository with https://zarel.github.io/regexfree/ )

(One other difference is that the official pattern doesn't consider "TS" part of the error code. There's an argument that it should be kept, for googleability.)

TimWolla

This change works for me.

TimWolla · 2020-10-27T09:59:33Z

@bryanmacfarlane Is this one still on your radar?

bryanmacfarlane · 2021-01-20T16:58:46Z

@Zarel any interest in changing the PR to target main instead of master?

Zarel · 2021-01-20T19:27:06Z

@bryanmacfarlane Sure! I just did. Does this mean you're planning to merge this?

bryanmacfarlane · 2021-02-16T14:58:41Z

LGTM. @ericsciple can you have a quick look?

Also, side question - I think that regex was pulled (or created from) the one that VS Code uses in it's problem matchers. Anyone know what VS Code is currently using and how this PR compares to it?

lumaxis · 2021-02-16T15:00:45Z

@bryanmacfarlane As somebody mentioned in one of the comments above, this is the exact same regex that VS Code is currently using: https://github.com/microsoft/vscode/blob/8d9002679558432eca926b6bb4f767eaae6b1068/extensions/typescript-language-features/package.json#L1095-L1106

ericsciple · 2021-02-16T15:29:13Z

 "pattern": [
 {
- "regexp": "^(?:\\s+\\d+\\>)?([^\\s].*)\\((\\d+|\\d+,\\d+|\\d+,\\d+,\\d+,\\d+)\\)\\s*:\\s+(error|warning|info)\\s+(\\w{1,2}\\d+)\\s*:\\s*(.*)$",
+ "regexp": "^([^\\s].*)[\\(:](\\d+)[,:](\\d+)(?:\\):\\s+|\\s+-\\s+)(error|warning|info)\\s+TS(\\d+)\\s*:\\s*(.*)$",


It might be good to add a unit test that loads the regexp and processes it against a line, asserts expected match groups
I'm worried if this change regresses something, at least we have a baseline unit test suite going forward.
Also i'm curious how this compares to vscode's built-in tsc problem matcher or their tsc-watch problem matcher. I briefly looked, but wan't able to find those built-in regexps in their repo.

@ericsciple looks like tests were added below at your request. have a quick look

bryanmacfarlane · 2021-02-16T16:32:49Z

@lumaxis are you ok to add unit test(s) per @ericsciple comment? I think we're good to merge after that.

lumaxis · 2021-02-16T18:11:48Z

@bryanmacfarlane Yea, that sounds like a great idea 👍🏼 Added tests in Zarel#1
Either @Zarel can merge my PR directly or @bryanmacfarlane can you merge/cherry-pick them into this branch with maintainer edit powers?

Add tests for tsc problem matcher

Zarel · 2021-02-17T04:06:28Z

@bryanmacfarlane Yea, that sounds like a great idea 👍🏼 Added tests in Zarel#1
Either @Zarel can merge my PR directly or @bryanmacfarlane can you merge/cherry-pick them into this branch with maintainer edit powers?

I merged your PR directly. I'm glad to see this is finally getting looked at! :)

bryanmacfarlane · 2021-02-17T04:26:23Z

LGTM. any objections @ericsciple ? (if not, I'll merge tomorrow)

This reverts commit a6ad5c9. The `tsc` problem matcher is now properly included in `setup-node` (actions/setup-node#125).

* chore(docs): Update explanation for token input * docs: move token info to dedicated paragraph * Fix typos Co-authored-by: Federico Grandi <fgrandi30@gmail.com>

This allegedly will result in annotations in GitHub on the specific files and linenumbers where the compilation fails. See: actions/setup-node#125 (comment)

SpaceEEC mentioned this pull request Mar 28, 2020
ci(Testing): add TypeScript test job discordjs/discord.js#4002
Merged
5 tasks

bryanmacfarlane self-assigned this May 2, 2020

chancancode reviewed May 28, 2020
View reviewed changes

Zarel commented May 29, 2020
View reviewed changes

Comment thread.github/tsc.json Outdated

xt0rted mentioned this pull request Jun 26, 2020
Outdated label not fully styled StylishThemes/GitHub-Dark#1152
Closed

TimWolla approved these changes Oct 27, 2020
View reviewed changes

Zarel added 2 commits November 16, 2020 23:52

Fix TypeScript error line/column
1d2297f

Adopt official pattern from VS Code
c7026a4

Zarel force-pushed the patch-1 branch from 8f76801 to c7026a4Compare November 16, 2020 23:52

bryanmacfarlane added the enhancement New feature or request label Jan 20, 2021

Zarel changed the base branch from master to mainJanuary 20, 2021 19:26

bryanmacfarlane requested a review from ericsciple February 16, 2021 14:57

ericsciple reviewed Feb 16, 2021
View reviewed changes

Minor cleanup
a7be6d9

lumaxis mentioned this pull request Feb 16, 2021
Add tests for tsc problem matcher Zarel/setup-node#1
Merged

lumaxisand others added 2 commits February 16, 2021 19:12

Add tests for tsc problem matcher
7a808f9

Merge pull request#1from lumaxis/feature/add-tsc-problem-matcher-tests
5f44226
Add tests for tsc problem matcher

marcelgerber added a commit to owid/owid-grapher that referenced this pull request Mar 2, 2022
Revert "add tsc problem matcher for GH Actions ..."
45330cf
This reverts commit a6ad5c9. The `tsc` problem matcher is now properly included in `setup-node` (actions/setup-node#125).

Sindhuja365 approved these changes Apr 10, 2023
View reviewed changes

Uh oh!

Conversation

Zarel commented Mar 24, 2020

Uh oh!

Zarel commented Mar 24, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Zarel commented Apr 9, 2020

Uh oh!

Zarel commented Apr 9, 2020

Uh oh!

bryanmacfarlane commented May 2, 2020

Uh oh!

chancancodeMay 28, 2020

Choose a reason for hiding this comment

Uh oh!

chancancodeMay 28, 2020

Choose a reason for hiding this comment

Uh oh!

ZarelMay 29, 2020

Choose a reason for hiding this comment

Uh oh!

ZarelMay 29, 2020

Choose a reason for hiding this comment

Uh oh!

ZarelMay 29, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TimWolla left a comment

Choose a reason for hiding this comment

Uh oh!

TimWolla commented Oct 27, 2020

Uh oh!

bryanmacfarlane commented Jan 20, 2021

Uh oh!

Zarel commented Jan 20, 2021

Uh oh!

bryanmacfarlane commented Feb 16, 2021

Uh oh!

lumaxis commented Feb 16, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ericscipleFeb 16, 2021

Choose a reason for hiding this comment

Uh oh!

bryanmacfarlaneFeb 17, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bryanmacfarlane commented Feb 16, 2021

Uh oh!

lumaxis commented Feb 16, 2021

Uh oh!

Zarel commented Feb 17, 2021

Uh oh!

bryanmacfarlane commented Feb 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Zarel commented Mar 24, 2020•
edited
Loading

lumaxis commented Feb 16, 2021•
edited
Loading

bryanmacfarlaneFeb 17, 2021•
edited
Loading