7x31/shellcheck
1
0
Fork 0
mirror of https://github.com/koalaman/shellcheck.git synced 2025-10-03 19:29:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix caps and highlight embedded code-blocks

John Gardner
2021-12-22 16:06:36 +11:00
parent 23e8cd81f8
commit 751dddc707
1 changed files with 71 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
JUnit.md

@@ -1,39 +1,43 @@
## Getting JUnit XML from ShellCheck
ShellCheck does not have a JUnit XML formatter, but here you can find `checkstyle2junit.xslt`, a XSLT program that converts from Checkstyle XML output to JUnit XML.
ShellCheck does not have a JUnit XML formatter, but here you can find `checkstyle2junit.xslt`, an XSLT program that converts from CheckStyle's XML output to JUnit's XML.
Here's shellcheck's checkstyle XML output:
Here's ShellCheck's (CheckStyle-compatible) XML output:
$ shellcheck -f checkstyle foo.bash bar.bash
```console
$ shellcheck -f checkstyle foo.bash bar.bash
<?xml version='1.0' encoding='UTF-8'?>
<checkstyle version='4.3'>
<file name='foo.bash' >
<error line='1' column='1' severity='error' message='Tips depend on target shell and yours is unknown. Add a shebang.' source='ShellCheck.SC2148' />
<error line='1' column='6' severity='info' message='Double quote to prevent globbing and word splitting.' source='ShellCheck.SC2086' />
</file>
<file name='bar.bash' >
</file>
</checkstyle>
<?xml version='1.0' encoding='UTF-8'?>
<checkstyle version='4.3'>
<file name='foo.bash' >
<error line='1' column='1' severity='error' message='Tips depend on target shell and yours is unknown. Add a shebang.' source='ShellCheck.SC2148' />
<error line='1' column='6' severity='info' message='Double quote to prevent globbing and word splitting.' source='ShellCheck.SC2086' />
</file>
<file name='bar.bash'>
</file>
</checkstyle>
```
Here it is with the XSLT applied using `xmlstarlet`:
$ shellcheck -f checkstyle foo.bash bar.bash | xmlstarlet tr checkstyle2junit.xslt
```console
$ shellcheck -f checkstyle foo.bash bar.bash | xmlstarlet tr checkstyle2junit.xslt
<?xml version="1.0" encoding="UTF-8"?>
<testsuite tests="2" failures="2">
<testcase classname="foo.bash" name="foo.bash">
<failure type="ShellCheck.SC2148">Line 1: Tips depend on target shell and yours is unknown. Add a shebang. See https://www.shellcheck.net/wiki/SC2148</failure>
<failure type="ShellCheck.SC2086">Line 1: Double quote to prevent globbing and word splitting. See https://www.shellcheck.net/wiki/SC2086</failure>
</testcase>
<testcase classname="bar.bash" name="bar.bash">
</testcase>
</testsuite>
<?xml version="1.0" encoding="UTF-8"?>
<testsuite tests="2" failures="2">
<testcase classname="foo.bash" name="foo.bash">
<failure type="ShellCheck.SC2148">Line 1: Tips depend on target shell and yours is unknown. Add a shebang. See https://www.shellcheck.net/wiki/SC2148</failure>
<failure type="ShellCheck.SC2086">Line 1: Double quote to prevent globbing and word splitting. See https://www.shellcheck.net/wiki/SC2086</failure>
</testcase>
<testcase classname="bar.bash" name="bar.bash">
</testcase>
</testsuite>
```
`checkstyle2junit.xslt` :
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
`checkstyle2junit.xslt`:
```xslt
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output encoding="UTF-8" method="xml"></xsl:output>
<xsl:template match="/">
@@ -75,4 +79,5 @@ Here it is with the XSLT applied using `xmlstarlet`:
<xsl:value-of select="substring(@source, '12')" />
</failure>
</xsl:template>
</xsl:stylesheet>
</xsl:stylesheet>
```