Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evilfreelancer/composer-json-generator
Small PHP library for generating/importing composer.json file with validation by composer's schema
https://github.com/evilfreelancer/composer-json-generator
composer generator json php74
Last synced: 3 months ago
JSON representation
Small PHP library for generating/importing composer.json file with validation by composer's schema
- Host: GitHub
- URL: https://github.com/evilfreelancer/composer-json-generator
- Owner: EvilFreelancer
- License: mit
- Created: 2019-09-21T18:25:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-24T18:35:47.000Z (over 5 years ago)
- Last Synced: 2024-09-29T20:01:29.467Z (3 months ago)
- Topics: composer, generator, json, php74
- Language: PHP
- Homepage: https://getcomposer.org/doc/04-schema.md
- Size: 43 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/evilfreelancer/composer-json-generator)
[](https://travis-ci.org/EvilFreelancer/composer-json-generator)
[](https://packagist.org/packages/evilfreelancer/composer-json-generator)
[](https://packagist.org/packages/evilfreelancer/composer-json-generator)
[](https://codeclimate.com/github/EvilFreelancer/composer-json-generator)
[](https://scrutinizer-ci.com/g/EvilFreelancer/composer-json-generator/?branch=master)
[](https://scrutinizer-ci.com/g/evilfreelancer/composer-json-generator/)
# Composer JSON generator
Small **PHP 7.4** library for generating composer.json file with validation by composer's schema
composer require evilfreelancer/composer-json-generator
Project inspired by [spatie/schema-org](https://github.com/spatie/schema-org).
# How to use
All available examples is [here](examples).
## Create new _composer.json_ file in OOP style
```php
require __DIR__ . '/vendor/autoload.php';
use \ComposerJson\Generator;
use \ComposerJson\Schemas\Composer;
use \ComposerJson\Schemas\Author;
use \ComposerJson\Schemas\Psr4;
// Initiate generator
$generator = new Generator();
// Initiate composer object
$composer = new Composer();
/*
* Set basic parameters of new composer.json file
*/
$composer->name = 'evilfreelancer/composer-json-generator';
$composer->type = 'library';
$composer->description = 'Small library for generating composer.json file with validation by composer\'s schema';
$composer->keywords = ['composer', 'json', 'generator'];
$composer->license = 'MIT';
/*
* Autoloader details
*/
// For normal usage
$psr4 = new Psr4();
$psr4->options = [
"ComposerJson\\" => './src/',
];
$composer->autoload[] = $psr4;
// For tests
$psr4 = new Psr4();
$psr4->options = [
"ComposerJson\\Tests\\" => './tests/',
];
$composer->autoloadDev[] = $psr4;
/*
* Authors of project
*/
$author = new Author();
$author->name = 'Paul Rock';
$author->email = '[email protected]';
$author->homepage = 'https://twitter.com/EvilFreelancer';
$author->role = 'Developer';
$composer->authors[] = $author;
/*
* Require rules
*/
$composer->require = [
'php' => '^7.4',
'ext-json' => '*'
];
$composer->requireDev = [
'phpunit/phpunit' => '^8.0',
];
/*
* Load composer into the generator
*/
$generator->load($composer);
/*
* Generate result
*/
$array = $generator->toArray();
$json = $generator->toJson();
var_dump($array);
echo $json . PHP_EOL;
```
Results is
```json
{
"name": "evilfreelancer/composer-json-generator",
"description": "Small library for generating composer.json file with validation by composer's schema",
"type": "library",
"keywords": [
"composer",
"json",
"generator"
],
"license": "MIT",
"authors": [
{
"name": "Paul Rock",
"email": "[email protected]",
"homepage": "https://twitter.com/EvilFreelancer",
"role": "Developer"
}
],
"require": {
"php": "^7.4",
"ext-json": "*"
},
"require-dev": {
"phpunit/phpunit": "^8.0"
},
"autoload": {
"psr-4": {
"ComposerJson\\": "./src/"
}
},
"autoload-dev": {
"psr-4": {
"ComposerJson\\Tests\\": "./tests/"
}
}
}
```
Btw, it used in current project.
## Read existing _composer.json_ file
```php
require __DIR__ . '/vendor/autoload.php';
use \ComposerJson\Generator;
$generator = new Generator();
$generator->read(__DIR__ . '/composer.json');
$array = $generator->toArray();
$json = $generator->toJson();
//var_dump($array);
echo $json . PHP_EOL;
```
# Links
* https://getcomposer.org/doc/04-schema.md
* https://github.com/spatie/schema-org - My project inspired by this library