README

围绕各种文档校验器的一个抽象，使Markdown文档的校验变得容易。

警告

此仓库旨在供商业支持的Silverstripe CMS模块使用。其校验规则具有主观性，可能包括针对这些模块使用的文档样式和语法的特定规则。

安装

将此包添加为开发依赖项

composer require --dev silverstripe/documentation-lint

您还需要允许仓库中的dealerdirect/phpcodesniffer-composer-installer插件（这不会影响下游用户），以便正确拉取slevomat PHP校验规则。

{
    // ...
    "config": {
        "allow-plugins": {
            "dealerdirect/phpcodesniffer-composer-installer": true
        }
    }
}

您需要安装nvm（或安装正确版本的node - 查看.nvmrc）和yarn。

警告

如果您使用的是bash以外的shell（例如zsh），您需要在运行校验脚本之前设置您的node版本，因为您的nvm安装可能没有被设置为可以在bash中使用。

您还需要安装（增强型）getopt - 您可能已经安装了，但脚本会通知您如果没有安装。

您必须在仓库根目录中添加一个.doclintrc文件，该文件包含您要校验的Markdown文档。此文件必须包含指向包含您的文档的目录的相对路径，并且该路径必须以/结尾。

例如

docs/en/

警告

仅使用文件的第一行。

只需运行命令。默认情况下，它将假定您从包含.doclintrc文件的目录中运行，并且您想校验Markdown、PHP和JavaScript中的.md文件。

vendor/bin/doclint

要校验特定模块（例如，如果您安装了多个模块），您可以传递包含.doclintrc文件的文件夹的相对路径。

vendor/bin/doclint vendor/silverstripe/developer-docs

如果您只想校验Markdown语法、PHP代码块或JavaScript代码块中的任何一个，请使用相应的标志。

vendor/bin/doclint -jp
# or
vendor/bin/doclint --with-js --with-php

要自动修复任何可以自动修复的问题，请传递--fix标志。

vendor/bin/doclint -f
# or
vendor/bin/doclint --fix

以下标志可以与doclint脚本一起使用

如果传递了任何语言标志，则只会校验传递的语言（如果传递了--fix，则修复）。如果没有传递语言标志，则校验所有语言。