composer-substitution-plugin

KO | EN

gitlite — search

#hacktoberfest #react #llm #go #deep-learning #linux #macos #java #windows #awesome #kubernetes #vue #openai #open-source

composer-substitution-plugin

(★ 51)

Composer plugin replacing placeholders in the scripts section by dynamic values

composer-substitution-plugin 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Composer Substitution Plugin

The [Composer](https://getcomposer.org/) Substitution plugin replaces placeholders in the scripts section by dynamic values.

It also permits to cache these values during the command execution and adds the ability to escape them with the function of your choice.

[![Build Status](https://github.com/villfa/composer-substitution-plugin/workflows/Build/badge.svg)](https://github.com/villfa/composer-substitution-plugin/actions)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/villfa/composer-substitution-plugin?branch=main&svg=true)](https://ci.appveyor.com/project/villfa/composer-substitution-plugin)
[![Latest Stable Version](https://poser.pugx.org/villfa/composer-substitution-plugin/v/stable)](https://packagist.org/packages/villfa/composer-substitution-plugin)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%205.3.2-8892BF.svg?style=flat-square)](https://php.net/)
[![License](https://poser.pugx.org/villfa/composer-substitution-plugin/license)](https://raw.githubusercontent.com/villfa/composer-substitution-plugin/main/LICENSE)

## Installation

```sh
composer require villfa/composer-substitution-plugin
```

## Requirements

* PHP >= 5.3.2
* Composer >= 1.0.0

## Usage

You need to configure the plugin in the *extra* section of `composer.json`.

Here an example:

```json
"extra": {
    "substitution": {
        "enable": true,
        "mapping": {
            "{MY_NAME}": {
                "type": "literal",
                "value": "John Doe",
                "escape": "addslashes"
            },
            "{PHP_VERSION}": {
                "type": "callback",
                "value": "phpversion"
            },
            "{DB_STATUS}": {
                "type": "include",
                "value": "./scripts/db.php",
                "cached": true
            },
            "{HOME}": {
                "type": "env",
                "value": "HOME"
            },
            "{COMPOSER_VERSION}": {
                "type": "constant",
                "value": "Composer\\Composer::VERSION"
            },
            "{NPROC}": {
                "type": "process",
                "value": "nproc"
            }
        }
    }
}
```

Then you can add the configured placeholders in the *scripts* section:

```json
"scripts": {
    "welcome": "echo 'Hi {MY_NAME}, the database is {DB_STATUS}.'"
}
```

And now if you run the command:

```sh
$ composer run-script welcome
Hi John Doe, the database is OK.
```

### Configuration

Configuration key | Mandatory | Type | Default value | Description
----------------- | --------- | ---- | ------------- | -----------
extra.substitution.enable | no | bool | true with Composer 2.2+, false otherwise | Disables the plugin when false
extra.substitution.mapping | yes | object | empty object | Mapping between placeholders (the keys) and substitution rules (the values). There is no restriction with the placeholders format.
extra.substitution.mapping.*.type | yes | string | n/a | Substitution type (see [the related section](#substitution-types) below)
extra.substitution.mapping.*.value | yes | string | n/a | Substitution value (depends on the type)
extra.substitution.mapping.*.cached | no | bool | false | Indicates whether the value provided after the first substitution must be cached
extra.substitution.mapping.*.escape | no | string | null | Escaping function that will receive the substitute value as argument
extra.substitution.priority | no | integer | 0 | Plugin's event handler priority (see [Composer documentation](https://getcomposer.org/doc/articles/plugins.md#event-handler))

| :warning: **From Composer 2.2+ you'll have to configure your `composer.json` file to allow the plugin to run** |
| --- |

Example:
```json
{
    "config": {
        "allow-plugins": {
            "villfa/composer-substitution-plugin": true
        }
    }
}
```

You can just execute this command:
```
composer config allow-plugins.villfa/composer-substitution-plugin true
```

For more details, see https://getcomposer.org/doc/06-config.md#allow-plugins

### Substitution types

For each type of substitution the value replacing the placeholder comes from a different source.

* `literal`: The value in configuration is used directly.
* `callback`: The value is the string returned by a callback.
* `include`: The value is the string returned by a PHP file.
* `env`: The value is an ENV variable.
* `constant`: The value comes from a constant or a class constant.
* `process`: The value is the output of the processed command.

## Real-life examples

### [PHPUnit Extra Constraints](https://github.com/villfa/phpunit-extra-constraints)

This library defines a Composer script which uses [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) this way:
```sh
"scripts": {
    "phpcs": "phpcs --standard=PSR12 --parallel=$(nproc) src/ tests/",
```
Unfortunately it is not cross-platform because of the usage of `nproc`.

This is solved by the substitution plugin in combination with [Linfo](https://github.com/jrgp/linfo)
(See also the tiny script [nproc.php](https://github.com/villfa/phpunit-extra-constraints/blob/a2c8e5a6f5079f4a2c9d83f45283ad25330ae16b/scripts/nproc.php)).
Here how it is configured:

```json
"extra": {
    "substitution": {
        "enable": true,
        "mapping": {
            "$(nproc)": {
                "cached": true,
                "type": "include",
                "value": "./scripts/nproc.php"
            }
        }
    }
}
```

So now it also works on Windows without even touching the *scripts* section.

composer-substitution-plugin

composer-substitution-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

composer-substitution-plugin

composer-substitution-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README