Skip to content

Commit

Permalink
Deployed 867f2a2 with MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jul 31, 2024
1 parent 0ab9be6 commit 187c9e1
Show file tree
Hide file tree
Showing 8 changed files with 150 additions and 122 deletions.
214 changes: 108 additions & 106 deletions 1.0/assets/images/converter-phpstan.graphviz.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions 1.0/assets/images/converter-phpstan.html.gv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ digraph {
"Bartlett\\Sarif\\Converter\\Normalizer\\PhpStanNormalizer" [shape="none" label=<
<table cellspacing="0" border="0" cellborder="1">
<tr><td bgcolor="#eeeeee"><b><br/>PhpStanNormalizer</b></td></tr>
<tr><td><table border="0" cellspacing="0" cellpadding="2">
<tr><td align="left">+ «static» URI_PATTERN : string = "https\:\/\/phpstan\.org\/error\-identifiers\/\%s" {readOnly}</td></tr>
</table></td></tr>
<tr><td></td></tr>
<tr><td><table border="0" cellspacing="0" cellpadding="2">
<tr><td align="left">+ normalize(data, format : string, context : array) : ?ArrayObject</td></tr>
Expand Down
Binary file modified 1.0/assets/images/phpstorm-phpstan.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 1.0/assets/images/sarif-web-phpstan.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 25 additions & 2 deletions 1.0/converter/phpstan/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#web-sarif-viewer" class="md-nav__link">
<span class="md-ellipsis">
Web SARIF viewer
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -922,6 +931,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#web-sarif-viewer" class="md-nav__link">
<span class="md-ellipsis">
Web SARIF viewer
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -954,12 +972,13 @@ <h2 id="table-of-contents">Table Of Contents</h2>
<li><a href="#how-to-customize-your-converter">How to customize your converter</a></li>
<li><a href="#learn-more">Learn more</a></li>
<li><a href="#ide-integration">IDE Integration</a></li>
<li><a href="#web-sarif-viewer">Web SARIF viewer</a></li>
</ol>
<p><img alt="phpstan converter" src="../../assets/images/converter-phpstan.graphviz.svg" /></p>
<h2 id="requirements">Requirements</h2>
<ul>
<li><a href="https://github.com/phpstan/phpstan">PHPStan</a> requires PHP version 7.2.0 or greater</li>
<li>This SARIF converter requires at least PHPStan version 1.9.0</li>
<li><a href="https://github.com/phpstan/phpstan">PHPStan</a> requires PHP version 8.1.0 or greater</li>
<li>This SARIF converter requires at least PHPStan version 1.11.0</li>
</ul>
<h2 id="installation">Installation</h2>
<div class="highlight"><pre><span></span><code>composer<span class="w"> </span>require<span class="w"> </span>--dev<span class="w"> </span>phpstan/phpstan<span class="w"> </span>bartlett/sarif-php-converters
Expand Down Expand Up @@ -1017,6 +1036,10 @@ <h2 id="learn-more">Learn more</h2>
<h2 id="ide-integration">IDE Integration</h2>
<p>The SARIF report file <code>[*].sarif.json</code> is automagically recognized and interpreted by PhpStorm (2024).</p>
<p><img alt="PHPStorm integration" src="../../assets/images/phpstorm-phpstan.png" /></p>
<h2 id="web-sarif-viewer">Web SARIF viewer</h2>
<p>With the <a href="https://github.com/Microsoft/sarif-web-component">React based component</a>, you are able to explore a sarif report file previously generated.</p>
<p>For example:</p>
<p><img alt="sarif-web-phpstan" src="../../assets/images/sarif-web-phpstan.png" /></p>



Expand Down
2 changes: 1 addition & 1 deletion 1.0/search/search_index.json
View file

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions 1.0/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,67 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://llaville.github.io/sarif-php-converters/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/ecs/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/phan/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/phpcs-fixer/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/phpcs/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/phplint/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/phpmd/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/phpstan/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/psalm/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/rector/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/converter/twigcs-fixer/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://llaville.github.io/sarif-php-converters/guides/installation/</loc>
<lastmod>2024-07-28</lastmod>
<lastmod>2024-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified 1.0/sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 187c9e1

Please sign in to comment.