Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamwojs/symfony-config-schema-gen
A utility bundle to generates JSON Schema from Symfony configuration.
https://github.com/adamwojs/symfony-config-schema-gen
configuration json-schema symfony symfony-bundle
Last synced: 14 days ago
JSON representation
A utility bundle to generates JSON Schema from Symfony configuration.
- Host: GitHub
- URL: https://github.com/adamwojs/symfony-config-schema-gen
- Owner: adamwojs
- License: gpl-2.0
- Created: 2021-01-15T10:09:14.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-29T19:52:28.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T13:13:48.332Z (about 1 month ago)
- Topics: configuration, json-schema, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 54.7 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# adamwojs/symfony-config-schema-gen
A utility bundle to generates JSON Schema from Symfony configuration.
## Installation
### Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
### Applications that don't use Symfony Flex
#### Step 1: Download the Bundle
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
```console
composer require adamwojs/symfony-config-schema-gen --dev
```
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation.
#### Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:
```php
// config/bundles.php
return [
// ...
AdamWojs\SymfonyConfigGenBundle\SymfonyConfigSchemaGenBundle::class => ['dev' => true],
];
```
## Usage
### Basic usage
```console
php bin/console config:dump-schema > config.schema.json
```
### Synopsis
```
Usage:
config:dump-schema [options] [--] [...]
Arguments:
extensions Extensions whitelist
Options:
--schema-id=SCHEMA-ID Unique identifier for the schema [default: "http://symfony.com/schema/config.schema.json"]
--format=FORMAT Output format [default: "json"]
--pretty-print Prettify schema output
--strict Generates strict schema
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-e, --env=ENV The Environment name. [default: "dev"]
--no-debug Switches off debug mode.
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```