dawen / config-to-js-bundle
Provides a command to dump defined config to js file
Installs: 6 295
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 0
Forks: 1
Open Issues: 1
Type:symfony-bundle
Requires
- php: >=5.5.0
- symfony/console: ~2.8|~3.0
- symfony/framework-bundle: ~2.8|~3.0
Requires (Dev)
- phpunit/phpunit: ~4.8
This package is not auto-updated.
Last update: 2024-10-26 18:44:11 UTC
README
Provides a command to dump defined config to js file.
Installation
Step 1: Composer
Required in composer.json
"dawen/config-to-js-bundle": "~1.0"
Run composer update dawen/config-to-js-bundle after modifiering composer.json file.
Step 2: AppKernel
In your app/config/AppKernel.php file you should activate the bundle by adding it to the array
$bundles[] = new Dawen\Bundle\ConfigToJsBundle\ConfigToJsBundle();
Step 3: Configuration
config_to_js: type: 'module' output_path: '%kernel.root_dir%/../web/js/app-config.js' config: imageLocation: 'http://this-is-an-example.com/images' appVersion: '1.1.0'
If parameter are not defined, default values will be applied.
Step 4: Run the command
Go to your console and run
bin/console config:js:dump
Configuration Parameter Description
type:
possible values: module default value: module description: This defines for what the dumped code is optimized.
output_path:
possible values: a valid string for a filepath default value: null description: This parameter defines a path and filename that will be created. If this value is not set, the dumper will throw an error.
config:
possible values: array default value: empty array description: Here you can create you config vars that should be availabe on your javascript side.
Supported Types/Renderers
module: Your file is includeable by module pattern like this: import appConfig from './ccurrent-folder/web/js/app-config.js'