README

pamald-yarn is a PHP library that collects dependency information from yarn.lock files. It is the Yarn-specific implementation of the pamald/pamald project, enabling detailed analysis of NPM packages.

Project Goals

The library aims to collect and analyze NPM dependencies from yarn.lock and package.json files in a structured way. This is particularly useful for:

• Tracking dependency changes: Easily identify package updates, new dependencies, or removed packages
• Security audits: Quick overview of package versions in use
• CI/CD pipelines: Automated dependency analysis during build processes
• Documentation: Generate accurate dependency lists for projects
• Prepare Git Commit Message: Automatically generate a commit message with dependency information

Usage

<?php

declare(strict_types = 1);

use Pamald\PamaldYarn\DependencyCollector;
use Siketyan\YarnLock\YarnLock;

$collector = new DependencyCollector();

$lock = YarnLock::toArray(file_get_contents('yarn.lock') ?: '');
$json = json_decode(file_get_contents('package.json') ?: '{}', true);

$rightDependencies = $collector->collect($lock, $json);
// See pamald/pamald how to use this to generate a report.

Links

• pamald/pamald
• pamald/pamald-composer
• pamald/pamald-npm
• pamald/pamald-yarn
• pamald/robo-pamald
• pamald/robo-pamald-composer
• pamald/robo-pamald-npm
• pamald/robo-pamald-yarn