https://github.com/decodelabs/integra

Composer file inspector and front-end
https://github.com/decodelabs/integra

Last synced: 17 days ago
JSON representation

Composer file inspector and front-end

• Host: GitHub
• URL: https://github.com/decodelabs/integra
• Owner: decodelabs
• License: mit
• Created: 2022-11-23T09:25:48.000Z (about 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-09-04T21:25:54.000Z (5 months ago)
• Last Synced: 2024-12-29T14:48:05.116Z (26 days ago)
• Language: PHP
• Size: 41 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Integra

[![PHP from Packagist](https://img.shields.io/packagist/php-v/decodelabs/integra?style=flat)](https://packagist.org/packages/decodelabs/integra)

[![Latest Version](https://img.shields.io/packagist/v/decodelabs/integra.svg?style=flat)](https://packagist.org/packages/decodelabs/integra)

[![Total Downloads](https://img.shields.io/packagist/dt/decodelabs/integra.svg?style=flat)](https://packagist.org/packages/decodelabs/integra)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/decodelabs/integra/integrate.yml?branch=develop)](https://github.com/decodelabs/integra/actions/workflows/integrate.yml)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-44CC11.svg?longCache=true&style=flat)](https://github.com/phpstan/phpstan)

[![License](https://img.shields.io/packagist/l/decodelabs/integra?style=flat)](https://packagist.org/packages/decodelabs/integra)

### Composer file inspector and front-end

Integra provides inspection tools for your composer.json file and a front end to control composer within your project.

_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._

---

## Installation

Install via Composer:

```bash

composer require decodelabs/integra

```

## Usage

Load a context to work from:

```php

use DecodeLabs\Integra\Context;

$context = new Context('path/to/project/');

```

Or use the `Integra` Veneer frontage to work from `cwd()`.

Integra will search back up the file tree for the nearest composer.json.

```php

echo Integra::$runDir; // Working directory

echo Integra::$rootDir; // Parent or current dir containing composer.json

echo Integra::$binDir; // Bin dir relative to composer

echo Integra::$composerFile; // Location  of composer.json

Integra::run('update'); // composer update

Integra::runGlobal('update'); // composer global update

Integra::runScript('my-script'); // composer run-script my-script

Integra::runBin('phpstan', '--debug'); // composer exec phpstan -- --debug

Integra::runGlobalBin('phpstan', '--debug'); // composer global exec phpstan -- --debug

if(!Integra::hasPackage('package1')) {

    Integra::install('package1', 'package2'); // composer require package1 package2

}

Integra::installDev('package1', 'package2'); // composer require package1 package2 --dev

Integra::installGlobal('package1', 'package2'); // composer global require package1 package2

Integra::installDevGlobal('package1', 'package2'); // composer global require package1 package2 --dev

```

### Manifest

Access the composer.json manifest:

```php

$manifest = Integra::getLocalManifest();

echo $manifest->getDescription();

foreach($manifest->getRequiredPackages() as $package) {

    echo $package->name;

}

```

See the Manifest.php class for full data access interface - it maps to the majority of the documented composer config options.

## Licensing

Integra is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.