doc/Static-analysis.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta charset="utf-8">
   5   <meta name="generator" content="pandoc">
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
   7   <title>Shaarli - Static analysis</title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <!--[if lt IE 9]>
  10     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  11   <![endif]-->
  12   <link rel="stylesheet" href="github-markdown.css">
  13 </head>
  14 <body>
  15 <div id="local-sidebar">
  16 <ul>
  17 <li><a href="Home.html">Home</a></li>
  18 <li>Installation
  19 <ul>
  20 <li><a href="Server-requirements.html">Server requirements</a></li>
  21 <li><a href="Server-configuration.html">Server configuration</a></li>
  22 <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  23 </ul></li>
  24 <li><a href="Usage.html">Usage</a>
  25 <ul>
  26 <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  27 <li><a href="Firefox-share.html">Firefox share</a></li>
  28 <li><a href="RSS-feeds.html">RSS feeds</a></li>
  29 </ul></li>
  30 <li>How To
  31 <ul>
  32 <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  33 <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
  34 <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  35 <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  36 </ul></li>
  37 <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  38 <li><a href="Development.html">Development</a>
  39 <ul>
  40 <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  41 <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  42 <li><a href="Directory-structure.html">Directory structure</a></li>
  43 <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  44 <li><a href="Plugin-System.html">Plugin System</a></li>
  45 <li><a href="Security.html">Security</a></li>
  46 <li><a href="Static-analysis.html">Static analysis</a></li>
  47 <li><a href="Theming.html">Theming</a></li>
  48 <li><a href="Unit-tests.html">Unit tests</a></li>
  49 </ul></li>
  50 <li>About
  51 <ul>
  52 <li><a href="FAQ.html">FAQ</a></li>
  53 <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  54 <li><a href="TODO.html">TODO</a></li>
  55 </ul></li>
  56 </ul>
  57 </div>
  58 <h1 id="static-analysis">Static analysis</h1>
  59 <h2 id="wip">WIP</h2>
  60 <p>This topic is currently being discussed here:</p>
  61 <ul>
  62 <li><a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)<a href=".html"></a></li>
  63 <li><a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools &amp; features</a> (#130)<a href=".html"></a></li>
  64 </ul>
  65 <h3 id="usage">Usage</h3>
  66 <p>Static analysis tools can be installed with Composer, and used through Shaarli's <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile">Makefile</a>.<a href=".html"></a></p>
  67 <p>For an overview of the available features, see:</p>
  68 <ul>
  69 <li><a href="https://github.com/shaarli/Shaarli/pull/124">Code quality: Makefile to run static code checkers</a> (#124)<a href=".html"></a></li>
  70 <li><a href="https://github.com/shaarli/Shaarli/pull/276">Run PHPCS against different coding standards</a> (#276)<a href=".html"></a></li>
  71 </ul>
  72 </body>
  73 </html>