Download the PHP package silverstripe/markdown-php-codesniffer without Composer
On this page you can find all versions of the php package silverstripe/markdown-php-codesniffer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download silverstripe/markdown-php-codesniffer
More information about silverstripe/markdown-php-codesniffer
Files in silverstripe/markdown-php-codesniffer
Package markdown-php-codesniffer
Short Description A wrapper around squizlabs/PHP_CodeSniffer which lets you lint PHP fenced code blocks in markdown files
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package markdown-php-codesniffer
Markdown PHP Codesniffer
A wrapper around squizlabs/PHP_CodeSniffer which lets you lint PHP fenced code blocks in markdown files.
Installation
Unlike squizlabs/PHP_CodeSniffer, this isn't intended to be installed globally - you should install it as a dev dependency of your project.
Usage
To sniff markdown files, run mdphpcs from the vendor bin directory:
Most of the options available with the phpcs and phpcbf commands from squizlabs/PHP_CodeSniffer are available with mdphpcs as well.
See PHP_CodeSniffer usage for more details.
Fixing violations automatically
Some violations can be fixed automatically, and PHP_CodeSniffer will include information about those in the CLI output. To fix them, simply pass the --fix option to mdphpcs:
This is the equivalent of using the phpcbf command on regular PHP files.
Linting other languages
squizlabs/PHP_CodeSniffer supports linting some languages other than PHP. Theoretically that can be done with this tool as well. You'll need to pass the language (as it's written in the markdown language hint) in with the --linting-language option.
Linting rules
If you have a default configuration file or explicitly pass in a standard using the --standard option, those rules will be used for linting - but be aware that some rules won't be appropriate for linting code blocks.
For example, the PSR12.Files.FileHeader.HeaderPosition rule will always fail linting, because we need to include empty lines prior to the content of the code block in the content we pass to squizlabs/PHP_CodeSniffer so it can correctly report the line of each violation in the original markdown file.
If you don't specify a standard and have no default configuration file, the default configuration included in this package will be used. This configuration is based on PSR12, with some exclusions that make it appropriate for use in linting code blocks.
