Blog

Composer.json vs Composer.lock: Basics and Usage

When working with Drupal (or any PHP project), you’ll often see two important files: composer.json and composer.lock. Both play a crucial role in managing dependencies, but they serve different purposes.

composer.json

  • What it is:
    A configuration file where you declare the libraries, modules, and packages your project needs.

  • Purpose / Usage:

    • Defines required dependencies and version ranges.

    • Lists project metadata (name, description, license).

    • Acts as a blueprint of your project setup.

  • Example

{
  "name": "drupal/recommended-project",
  "require": {
    "php": ">=8.1",
    "drupal/core": "^10.0",
    "drupal/pathauto": "^1.11"
  }
}

composer.lock

  • What it is:
    An auto-generated file created after you install or update dependencies.

  • Purpose / Usage:

    • Stores the exact versions of all installed dependencies (including nested ones).

    • Guarantees consistency across all environments (your machine, staging, production).

    • Prevents “works on my machine” issues.

  • Key difference in short:

    • composer.json = What you want

    • composer.lock = What you actually get

When to Run Commands?

Here’s how composer.json and composer.lock interact with composer install and composer update:

CommandWhen to UseWhat It Does
composer installEveryday use (local setup, deploying to servers, cloning repo)Reads composer.lock and installs the exact same versions listed there. Does not update versions.
composer updateOnly when you want to upgrade dependenciesUpdates dependencies to the latest versions allowed in composer.json, then rewrites composer.lock with new exact versions.
composer require <package>To add a new module/libraryUpdates composer.json and composer.lock automatically.

Workflow Example

  1. Add "drupal/pathauto": "^1.11" in composer.json or run:

    composer require drupal/pathauto

  2. Run composer update → installs dependencies, updates composer.lock.

  3. Commit both composer.json and composer.lock to Git.

  4. On another machine or server, run composer install → installs the same versions from composer.lock.

In Drupal Projects:

  • composer.json tells which modules are needed.

  • composer.lock ensures all developers and environments run on the same versions.

  • Use composer install on servers and shared environments.

  • Use composer update cautiously, usually in development, followed by thorough testing.

Run composer update to change the plan, run composer install to stick to the reality.