Friendly error output #4

@lc-soft has funded $20.00 to this issue.

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

@lc-soft I would like to take this up. This is my first contribution here. Could you help me more to understand the exact issue.

Could you help me more to understand the exact issue.

@arshadkazmi42

The error handling of the compiler needs to be improved. The error object should contain the path, content, line, column of the compiled file.

How to getting started?

To getting started, you should define some custom error classes, for example:

class TradError extends Error {
  // ...
}
class TradTypeError extends TradError {
  // ...
}
class TradSyntaxError extends TradError {
  // ...
}
class TradReferenceError extends TradError {
  // ...
}

How to get path, content, line, column of the compiled file?

For path and content of file, please read this source file: https://github.com/lc-soft/trad/blob/master/packages/trad-compiler/index.js#L129

Maybe you need to write code to store them.

For getting line and column, please read: https://github.com/acornjs/acorn/tree/master/acorn#interface

When locations is true, acorn parser will provide these data, but where is the data and how to get it, you need to solve it.

How to throw these errors?

Search all assert function calls and change them to the throw statement, for example:

- assert(variable, `${input.id.name} not defined`)
+ if (!variable) {
+   throw new TradReferenceError(`${input.id.name} not defined`, ...someRequiredData)
+ }

How to collect errors?

Maybe you need to add a try...catch statement to the root level parse() function call, for example:

try {
  this.parse(input)
} catch (err) {
  if (err instanceof TradError) {
    // Handling error
  }
}

What should be the format of the output error message?

Refer friendly-errors-webpack-plugin:

Hey @arshadkazmi42, are you working on this? If not, can I give this a shot? Thanks

@kenanchristian I got busy with some other work was not able to look into it. Please go ahead with it.

@lc-soft has funded $5.00 to this issue.

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

@lc-soft has rewarded $20.00 to @lc-soft. See it on IssueHunt

• :moneybag: Total deposit: $25.00
• :tada: Repository reward(10%): $2.50
• :wrench: Service fee(10%): $2.50