cheezery / depdoc
Helps you document dependencies of your project
Installs: 25 410
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 5
Open Issues: 2
Type:project
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 helps you document the dependencies of your project, currently supporting Composer and Node packages.
Usage
Creating and updating dependencies file
./vendor/bin/depdoc update
Creates and updates a DEPENDENCIES.md file in your repository, which contains every installed Composer and Node package, its version and description, and offers you a way to document why and how you use this package.
By adding a lock emoji (🔒) after the version number, you can document that this package should not be updated. Alternatively you can use 🛇, ⚠, or ✋.
Validating dependencies file
./vendor/bin/depdoc validate
Validates that every installed dependency is documented in DEPENDENCIES.md. Also makes sure that no package surpasses its locked version.
Use strict modes to verify your package version matches the documented dependencies.
./vendor/bin/depdoc validate --strict
Checks for major and minor version to match, i.e. installed 1.0.1 and documented 1.0.0 will bypass validation but installed 1.1.0 and documented 1.0.0 won't.
./vendor/bin/depdoc validate --very-strict
Checks for full semantic versioning match, i.e. installed 1.0.1 and documented 1.0.0 will not bypass validation.
Configuration
Configuration can be provided via .depdoc.json, .depdoc.yml or .depdoc.yml files in the root directory of your project.
Options
newlineCharacter
Default is \n but if you need a different one you can provide it.
lockSymbol
Default is "🔒". Alternatively you can use 🛇, ⚠, or ✋.
exportExternalLink
Default is true, but if you do not want the external link in your dependencies file you can deactivate it.
composer
Default is true, if you do not want to add composer dependencies set this to false
npm
Default is true, if you do not want to add npm dependencies set this to false.