Download the PHP package silverstripe/documentation-lint without Composer

On this page you can find all versions of the php package silverstripe/documentation-lint. 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?

Informations about the package documentation-lint

Documentation lint

An abstraction around various documentation linters to make linting markdown documentation easy.

[!WARNING] This repository is intended for use by commercially supported Silverstripe CMS modules. Its linting rules are opinionated and may include rules which are specific to the documentation style and syntax used by those modules.

Installation

Add this package as a dev dependency

You'll also need to allow the dealerdirect/phpcodesniffer-composer-installer plugin in the repository (this won't affect downstream users) so that the slevomat PHP linting rules are pulled in correctly.

Setup

Required software

You need nvm (or node installed with the right version - see .nvmrc) and yarn installed.

[!WARNING] If you're using a shell other than bash (e.g. zsh) you'll need to set your node version before running the linting script, since your nvm installation is probably not set up in a way that it can be used in bash.

You also need getopt (enhanced) installed - which you probably do but the script will let you know if you don't.

Setup in the repository

You must add a .doclintrc file to the root of the repository which has markdown documentation you want linted. This file must contain a relative path to the directory which holds your documentation, and that path must end with a /.

For example:

[!WARNING] Only the first line of the file will be used.

Usage

Simply run the command. By default it will assume you're running it from the directory that holds the .doclintrc file and that you want to lint markdown, php, and javascript within .md files.

To lint for a specific module (e.g. if you have multiple modules installed) you can pass the relative path to the folder containing the .doclintrc file.

If you want to specifically only lint one of markdown syntax, PHP codeblocks, or JavaScript codeblocks, use the appropriate flag(s).

To automatically fix any problems that can be automatically fixed, pass the --fix flag.

Flags

The following flags can be used with the doclint script:

long name short name description
--fix -f Fix any automatically fixable problems
--with-md -m Lint markdown syntax
--with-js -j Lint JavaScript code blocks
--with-php -p Lint PHP code blocks

If any language flag is passed, only the languages that are passed will be linted (or fixed if --fix is passed). If no language flags are passed, all languages will be linted.

All versions of documentation-lint with dependencies

PHP Build Version
Package Version
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 silverstripe/documentation-lint contains the following files

Loading the files please wait ....