Improve error message when there is a JS syntax error

[willdurand]

Fixes #3482

---

It'll be awesome once it's ready.

Output

❯ ./bin/addons-linter test-addon
Validation Summary:

errors          1
notices         0
warnings        0

ERRORS:

Code              Message                                               Description                                                                                        File    Line   Column
JS_SYNTAX_ERROR   JavaScript syntax error (Parsing as module error:     There is a JavaScript syntax error in your code, which might be related to some experimental       cs.js   1      1
                  Unexpected token = at line: 4 and column: 5)          JavaScript features that aren't an official part of the language specification and therefore not
                  (Parsing as script error: 'import' and 'export' may   supported yet. The validation cannot continue on this file.
                  appear only with 'sourceType: module' at line: 1
                  and column: 1)

[rpl]

@willdurand looked to this again once more and I confirm that I'm ok with the general approach, my +1 on proceeding to complete this PR.

[willdurand]

@rpl so I wasn't very inspired when writing tests but on the other hand, I think coverage is pretty good already. I thought about adding some more tests for the replace() call, etc. but the test setup would be quite complex for little value IMO. WDYT? Mind looking at this patch a bit? It's not urgent.

[rpl]

@willdurand I didn't reviewed all the PR in detail, but I did find a detail (described below) that I'd like to discuss with you (while I'm going to look to the rest of this patch).

[willdurand]

@willdurand I didn't reviewed all the PR in detail, but I did find a detail (described below) that I'd like to discuss with you (while I'm going to look to the rest of this patch).

@rpl thanks. I updated this PR to fix the issue you raised in the previous review. I added a note about reporting a new issue when there is likely a bug in our code. The rest is unchanged. Let me know what you think.

[willdurand]

(ugh, forgot to request a review)

[rpl]

@willdurand apologies for letting you wait, there are a couple more changes that I think would be good to apply to this PR (these should be the last ones, I promise ;-))

Let me know if you think that any of those points may use some discussion over a synchronous channel.

[rpl]

@willdurand lgtm, thanks for covering the last round of changes requested.