search

FloeDesignTechnologies / phpcs-security-audit

phpcs-security-audit is a set of PHP_CodeSniffer rules that finds vulnerabilities and weaknesses related to security in PHP code
GNU General Public License v3.0
712 stars 85 forks source link

placeholder for github pages #55

Closed jmarcil closed 4 years ago

jmarcil commented 4 years ago

Following what's recently discussed on #44, this would be the target output by using PHPCS mechanism to generate sniff documentation.

I'm not 100% sure yet that I can generate the exact code for jekyll on GitHub Pages from PHPCS, but if it can all work together that'd be great.

Since it's just about the /docs directory needed by GitHub Pages, this PR has literally 0 impact on the tool itself.

jrfnl commented 4 years ago

I'm not 100% sure yet that I can generate the exact code for jekyll on GitHub Pages from PHPCS, but if it can all work together that'd be great.

FYI: that is one of the tools I intend to add to PHPCSDevTools, in case you're interested ;-)

The tool I envision would take the sniff description from the class docblock + provide information on public properties which can be set from the ruleset, and would generate the output as markdown so it can be used in a README, GH Wiki page and/or GH Pages site with Jekyll enabled.