composer-fallback/intl.symfony-polyfill

Satisfy "intl" with packages provided by user, or fallback to "symfony-polyfill".

1.1 2020-10-02 12:33 UTC

This package is auto-updated.

Last update: 2024-03-29 04:32:47 UTC


README

Provides a metapackage for library needing intl that fallback to a default implementation when user does not meet the initial requirements.

Usage

composer require "composer-fallback/intl.symfony-polyfill:*"

Composer will, by preference:

  • check if user has ext-intl
  • otherwise, fallbacks to symfony/intl

How does it works

This package contains 2 versions:

  1. The highest 1.1 needs ext-intl.

  2. The lowest 1.0 triggers install of symfony/intl.

Composer will choose this highest version when user has the extension ext-intl. Otherwise, composer will choose the lowest version and in that case will download the following packages: symfony/intl.

What problem does it solve?

You are maintaining a library that need an implementation of intl, but you don't want requiring a specific implementation.

ie. you need function defined in intl, but polyfill exists and would be enough.

When end users requires you library with the following code

{
    "name": "end-user/app",
    "require": {
      "acme/lib": "^1.0"
    }
}

They probably ends with such error

composer up

Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Installation request for acme/lib ^1.0 -> satisfiable by acme/lib[1.0].
    - acme/lib 1.0 requires ext-intl * -> no matching package found.

You can ask user to install a random package, it works, but the DX is very bad, and confusing at first.

By using composer-fallback/intl.symfony-polyfill, users will provide the native implementation or fallback to your default choice

Example of user that meet the preferred requirements

{
    "name": "end-user/app",
    "require": {
        "acme/lib": "^1.0",
        "third-party/provide-implementation": "^1.0"
    }
}
composer up
...
Package operations: 2 installs, 0 updates, 0 removals
  - Installing acme/lib (1.0)
  - Installing composer-fallback/intl.symfony-polyfill (1.1)

Example of user that fallback to your recommendations

{
    "name": "end-user/app",
    "require": {
        "acme/lib": "^1.0"
    }
}
composer up
...
Package operations: 3 installs, 0 updates, 0 removals
  - Installing acme/lib (1.0)
  - Installing composer-fallback/intl.symfony-polyfill (1.0)
  - Installing symfony/intl (1.0)

Contributing

This repository is automatically generated. If you want contributing and submitting an issue or a Pull Request, please use composer-fallback/generator.