--format=checkstyle option for tsc --noEmit

[dennis-c]

Suggestion

🔍 Search Terms

Checkstyle

✅ Viability Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

We have automated checking for typescript errors in our CI tooling (Jenkins), using the following command ./node_modules/.bin/tsc --project ./tsconfig.json --noEmit > build-logs/typescript-error.log. Currently we save the output to a plaint text file, but we would like to be able to parse it in our CI. The standards most tooling follows is a format option which supports a checkstyle format, which can easily be parsed by most CI's.

See https://checkstyle.sourceforge.io/config.html#Configuration_XML_Structure for more information on how to format the xml.

It would be great to have a --format=checkstyle option we could add to our current command to get a formatted xml file with all errors.

📃 Motivating Example

Most of our current tooling already supports this, and this enables us to check code quality, fail builds, etc.

💻 Use Cases

We currently have checks for stylelint, eslint, php codesniffer, phpstan, psalm and htmlhint. It would be great if we could also easily identify and report which typescript errors exist within our projects and possibly fail a build if we encounter them.

[idan-at]

Any progress on this one?

I have a similar use case - I'd like to format the TS compiler errors a bit differently, so our CI can catch the errors and display them nicely (ATM, when a build fails, we need to manually search the errors in the logs).

Adding the option for other formats (including custom ones, using plugins?) can be extremely helpful.

[michal-kocarek]

I have same error. It is hard to integrate TS compilation steps into CI without being able to simply visualize the errors. There are packages that are parsing the console output of TSC, however it does not seem to be standardized enough to be stable.

Having ability to export errors with different reporter format (aka checkstyle), would be great.

[dennis-c]

Just a small update, we have as a workaround started using https://github.com/bartekbp/typescript-checkstyle for parsing the errors to checkstyle and written a package ourselves to filter out messages from node_modules https://github.com/Moxio/checkstyle-filter-by-name