sllh/composer-lint

Extends the composer validate command with extra rules

Maintainers

Details

github.com/Soullivaneuh/composer-lint

Source

Issues

Installs: 172 331

Dependents: 8

Suggesters: 0

Security: 0

Stars: 14

Watchers: 4

Forks: 5

Type:composer-plugin

v2.0.0 2021-03-13 15:49 UTC

Requires

  • php: ^7.4 || ^8.0
  • composer-plugin-api: ^2.0

Requires (Dev)

MIT acf0b38f1b4efca1b11e7589fa57f7749adf744f

  • Sullivan SENECHAL <soullivaneuh.woop@gmail.com>

plugincomposervalidatelint

This package is auto-updated.

Last update: 2024-12-11 02:19:24 UTC

README

composer-lint is a plugin for Composer.

It extends the composer validate command with extra rules.

Latest Stable Version Latest Unstable Version License Dependency Status Reference Status

Total Downloads Monthly Downloads Daily Downloads

Build Status Scrutinizer Code Quality Code Climate Coverage Status SensioLabsInsight

Installation

You can install it either globally (recommended):

composer global require sllh/composer-lint

or locally:

composer require sllh/composer-lint

Usage

That's it! Composer will enable automatically the plugin as soon it's installed.

Just run composer validate command to see the plugin working.

Configuration

You can configure the plugin via the COMPOSER_HOME/config.json file. Here is the default one:

{
    "config": {
        "sllh-composer-lint": {
            "php": true,
            "type": true,
            "minimum-stability": true,
            "version-constraints": true
        },
        "sort-packages": false
    }
}
  • php: Checks if the PHP requirement is set on the require section.
  • type: Check if package type is defined.
  • minimum-stability: Checks if minimum-stability is set. It raises an error if it is, except for project packages.
  • version-constraints: Checks if version constraint formats are valid (e.g. ~2.0 should be ^2.0).
  • sort-packages: Checks if packages are sorted on each section. This option is outside sllh-composer-lint because it's a composer native one.