cheezery/depdoc

Helps you document dependencies of your project

DepDoc helps you document the dependencies of your project, currently supporting Composer and Node packages., _(*1)

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., _(*2)

By adding a lock emoji (🔒) after the version number, you can document that this package should not be updated. Alternatively you can use 🛇, ⚠, or ✋., _(*3)

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., _(*4)

Use strict modes to verify your package version matches the documented dependencies., _(*5)

./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., _(*6)

./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., _(*7)

Configuration

Configuration can be provided via .depdoc.json, .depdoc.yml or .depdoc.yml files in the root directory of your project., _(*8)

Options

newlineCharacter, _(*9)

Default is \n but if you need a different one you can provide it., _(*10)

lockSymbol, _(*11)

Default is "🔒". Alternatively you can use 🛇, ⚠, or ✋., _(*12)

exportExternalLink, _(*13)

Default is true, but if you do not want the external link in your dependencies file you can deactivate it., _(*14)

composer, _(*15)

Default is true, if you do not want to add composer dependencies set this to false, _(*16)

npm, _(*17)

Default is true, if you do not want to add npm dependencies set this to false., _(*18)