Download the PHP package hanneskod/readme-tester without Composer

On this page you can find all versions of the php package hanneskod/readme-tester. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of hanneskod/readme-tester

Informations about the package readme-tester

Readme-Tester

Packagist Version Build Status Quality Score

Validate PHP code examples in documentation.

This file describes version 2 which uses php8 attributes.

For version 1 which uses docblock style annotations see this link.

Why?

Did you update your library, but forgot to update code examples in README? Are your users complaining on syntax errors in your examples? Do you find it too cumbersome to manually test all examples? Readme-Tester lets you automate the process of validating PHP code examples in documentation files.

A simple example

Readme-Tester uses php8 style attributes inside HTML-comments (to make them invisible after rendering on for example github) to specify the expected result of a code example.

The following simple example asserts that the code outputs content.

<!--
#[ReadmeTester\ExpectOutput('/foo/')]
-->

For more information read the documentation.

Installation

Using phive (recommended)

Install using phive

As a phar archive

Download the latest phar archive from the releases tab.

Optionally rename readme-tester.phar to readme-tester for a smoother experience.

Using composer

Install as a composer dependency

This will make readme-tester avaliable as vendor/bin/readme-tester.

From source

To build you need make

The build script uses composer to handle dependencies and phive to handle build tools. If they are not installed as composer or phive respectivly you can use something like

Getting started

Using the command line tool is as simple as

For more detailed information use

All versions of readme-tester with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
amphp/parallel-functions Version ^1
crell/tukio Version ^1
fig/event-dispatcher-util Version ^1
psr/container Version ^1
psr/event-dispatcher Version ^1
symfony/console Version ^5
symfony/dependency-injection Version ^5
symfony/finder Version ^5
symfony/process Version ^5
symfony/yaml Version ^5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hanneskod/readme-tester contains the following files

Loading the files please wait ....