Command line tool to convert tsc output to checkstyle format
MIT License
Typescript-checkstyle is a tool for reporting typescript compiler
output in checkstyle
format. It was created to improve pull request decoration with compiler errors.
Project requires:
All arifacts are published to npm. To use the latest version, you can install it using:
npm i --save-dev @bartekbp/typescript-checkstyle
Typescript-checkstyle can be used from command line and javascript.
Library reads tsc
output from standard input. You may want to run both of them together. The following command typechecks your project and shows compilation errors in checkstyle
format:
> npx tsc --noEmit | npx @bartekbp/typescript-checkstyle
If you already have npm scripts
configured and want to use output from one of them to typescript-checkstyle, you need to invoke npm
with --silent to suppress npm prologue:
> npm --silent run lint:tsc | npx @bartekbp/typescript-checkstyle
If you want to automate adding comments to your pull request based on complier output, typescript-checkstyle will help you achieve it. To configure it, I will use jenkins
, but the solution applies to other continuous integration systems as well.
You need to setup a jenkins pipeline
that will be triggered with bitbucket branch source plugin or github branch source plugin. In the pipeline you need to run typescript-checkstyle with tsc
and redirect output to a file:
stage('tsc') {
steps {
sh 'npx tsc --noEmit | npx @bartekbp/typescript-checkstyle > tsc-checkstyle.xml'
}
}
Depending on your code review system, tomasbjerre created different plugins for pull request decoration. You can find the full list of them at the bottom of violations-lib readme. I'll focus on the configuration for bitbucket cloud
.
You need to update pipeline with additional stage for pr decoration:
The bold parts in the stage needs to updated to reflect your project:
Typescript-checkstyle exposes one function format
:
/**
* Converts tsc errors to checkstyle format
*
* @param {string} input - errors from tsc
* @return {string} errors in checkstyle format
function format(input) {}
*/
You can use it as follows:
import format from '@bartekbp/typescript-checkstyle';
const input = `src/test.component.ts(3, 12): error TS2564: Property 'name' has no initializer`;
const errorsInCheckstyleFormat = format(input);
console.log(errorsInCheckstyleFormat);
This code prints out errors from input
in checkstyle format.
Distributed under the MIT License. See LICENSE for more information.
Great thanks to: