通过 
搜索
搜索cheezery / depdoc
帮助您记录项目的依赖关系
v4.0.3
2023-09-06 06:00 UTC
Requires
- php: >=7.4.0
- ext-json: *
- ext-pcre: *
- composer/composer: ^2.0
- symfony/config: ^4.4 | ^5.4 | ^6.0
- symfony/console: ^4.4 | ^5.4 | ^6.0
- symfony/dependency-injection: ^4.4 | ^5.4 | ^6.0
- symfony/property-access: ^4.4 | ^5.4 | ^6.0
- symfony/serializer: ^4.4 | ^5.4 | ^6.0
- symfony/yaml: ^4.4 | ^5.4 | ^6.0
- z4kn4fein/php-semver: ^2.0
Requires (Dev)
- php-mock/php-mock-prophecy: ^0.1.0
- phpspec/prophecy-phpunit: ^2.0
- phpstan/phpstan: ^1.4.10
- phpstan/phpstan-strict-rules: ^1.1.0
- phpunit/phpunit: ^9.5
- roave/security-advisories: dev-latest
- symfony/var-dumper: ^4.4 | ^5.4 | ^6.0
README
DepDoc 帮助您记录项目的依赖关系，目前支持 Composer 和 Node 包。
用法
创建和更新依赖文件
./vendor/bin/depdoc update
在您的仓库中创建和更新一个 DEPENDENCIES.md 文件，其中包含每个安装的 Composer 和 Node 包及其版本和描述，并提供一种记录您为何以及如何使用此包的方法。
通过在版本号后添加锁表情符号（🔒），您可以记录该包不应被更新。或者您可以使用 🛇、⚠ 或 ✋。
验证依赖文件
./vendor/bin/depdoc validate
验证 DEPENDENCIES.md 中是否记录了每个安装的依赖项。同时确保没有包超出其锁定版本。
使用严格模式验证您的包版本与记录的依赖项匹配。
./vendor/bin/depdoc validate --strict
检查主版本和次要版本的匹配，例如安装 1.0.1 和记录的 1.0.0 将绕过验证，但安装 1.1.0 和记录的 1.0.0 不会。
./vendor/bin/depdoc validate --very-strict
检查完整语义版本匹配，例如安装 1.0.1 和记录的 1.0.0 不会绕过验证。
配置
配置可以通过在项目的根目录中的 .depdoc.json、.depdoc.yml 或 .depdoc.yml 文件中提供。
选项
newlineCharacter
默认为 \n，但如果您需要其他字符，您可以提供它。
lockSymbol
默认为 "🔒"。您也可以使用 🛇、⚠ 或 ✋。
exportExternalLink
默认为 true，但如果您不想在依赖文件中包含外部链接，可以将其禁用。
composer
默认为 true，如果您不想添加 composer 依赖项，请将其设置为 false
npm
默认为 true，如果您不想添加 npm 依赖项，请将其设置为 false。