This is a transformer which helps you manage different configurations for different builds of your web app.
Usually you need different configuration for different environments:
String apiRoot = "http://localhost:8080/api/v1 // Use in production!!!!! // String apiRoot = "http://this-is-very-important.qwerty/api/v1/"
... and that's just terrible. Let's try something else.
Add transformer to your pubspec.yaml:
dependencies: fnx_config: ^1.0.0 transformers: - fnx_config
Then create configuration profiles (YAML files). Usually you will need two of them.
Content of those files is completely up to you, it's probably going to be something like this:
ourSecretApiKey: qwertyuiop ourSecretApiUrl: http://this-is-very-secret.qwerty/api/v1/
<script type="pub/fnx_config"></script> into the
of your HTML files and run
Transformer searches for HTML files with this instruction, and replaces it with encoded content of your YAML file:
var fnx_config = "eyJjb25maWciOnsiYWhvai ... tMjlUMTg6NDE6MjAuMTkwIn19";
The reason why we encode the configuration, is that we don't want to tempt the user with too much knowledge. We don't need any bored teenager to play with our API endpoints and API keys.
Please don't mistake this feature for any kind of security, it's just simple BASE64 and the configuration will be accessible to any skilled user. But a little bit of obfuscation cannot do any harm.
and access your configuration via global function:
String apiKey = fnxConfig()["ourSecretApiKey"];
fnx_config also adds few metadata you might find useful:
fnxConfigMeta()["mode"]; // pub build mode (--mode=qwerty) fnxConfigMeta()["timestamp"]; // timestamp of build
Simply add more configuration files:
and use them with pub:
pub build --mode=qwerty pub serve --mode=jenkins
With Polymer, place fnx_config transformer after web_components
- web_components: entry_points: web/index.html - reflectable: entry_points: web/index.dart - fnx_config
Also with Angular2, keep the transformer at the end of the list.
Typical usage with firebase looks like this:
firebase: apiKey: "AIzaSyDq6qYBJHOMmdsdsEsKFiotLxKmjqA" authDomain: "my-app-1af5.firebaseapp.com" databaseURL: "https://my-app-1af5.firebaseio.com" storageBucket: "my-app-1af5.appspot.com"
import 'package:firebase3/firebase.dart' as f; import 'package:fnx_config/fnx_config_read.dart'; ... Map cfg = fnxConfig(); f.App app = f.initializeApp( apiKey: cfg["firebase"]["apiKey"], authDomain: cfg["firebase"]["authDomain"], databaseURL: cfg["firebase"]["databaseURL"], storageBucket: cfg["firebase"]["storageBucket"] );
Initial public version.
Add this to your package's pubspec.yaml file:
dependencies: fnx_config: ^1.2.0
You can install packages from the command line:
$ pub get
Alternatively, your editor might support
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
|1.2.0||Oct 28, 2016|
|1.1.0||Oct 12, 2016|
|1.0.1||Mar 2, 2016|
|1.0.0||Oct 30, 2015|
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.
Support Dart 2 in
The SDK constraint in
pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.
dartdoc successfully runs on your package's source files. (-10 points)
Dependencies were not resolved.
|Dart SDK||>=1.8.0 <2.0.0|