#gulp-ng-config

It's often useful to generate a file of constants, usually as environment variables, for your Angular apps. This Gulp plugin will allow you to provide an object of properties and will generate an Angular module of constants.

npm install gulp-ng-config

It's pretty simple: gulpNgConfig(moduleName)

We start with our task. Our source file is a JSON file containing our configuration. We will pipe this through gulpNgConfig and out will come an angular module of constants.

gulp.task('test', function () {
  gulp.src('configFile.json')
  .pipe(gulpNgConfig('myApp.config'))
  .pipe(gulp.dest('.'))
});

Assume that configFile.json contains:

{
  "string": "my string",
  "integer": 12345,
  "object": {"one": 2, "three": ["four"]},
  "array": ["one", 2, {"three": "four"}, [5, "six"]]
}

Running gulp test will take configFile.json and produce configFile.js with the following content:

angular.module('myApp.config', [])
.constant('string', "my string")
.constant('integer', 12345)
.constant('object', {"one":2,"three":["four"]})
.constant('array', ["one",2,{"three":"four"},[5,"six"]]);

We now can include this configuration module in our main app and access the constants

angular.module('myApp', ['myApp.config']).run(function (string) {
  console.log("The string constant!", string) // outputs "my string"
});

Currently there are a few configurable options to control the output of your configuration file:

• options.environment
• options.constants
• options.createModule
• options.wrap
• options.parser

Type: String Optional

If your configuration contains multiple environments, you can supply the key you want the plugin to load from your configuration file.

Example config.json file with multiple environments:

{
  "local": {
    "EnvironmentConfig": {
      "api": "http://localhost/"
    }
  },
  "production": {
    "EnvironmentConfig": {
      "api": "https://api.production.com/"
    }
  }
}

Usage of the plugin:

gulpNgConfig('myApp.config', {
  environment: 'production'
})

Expected output:

angular.module('myApp.config', [])
.contant('EnvironmentConfig', {"api": "https://api.production.com/"});

Type: Object Optional

You can also override properties from your json file or add more by including them in the gulp tasks:

gulpNgConfig('myApp.config', {
  constants: {
    string: 'overridden',
    random: 'value'
  }
});

Generating configFile.js

angular.module('myApp.config', [])
.constant('string', "overridden")
.constant('integer', 12345)
.constant('object', {"one":2,"three":["four"]})
.constant('array', ["one",2,{"three":"four"},[5,"six"]])
.constant('random', "value");

Type: Boolean Default value: true Optional

By default, a new module is created with the name supplied. You can access an existing module, rather than creating one, by setting createModule to false.

gulpNgConfig('myApp.config', {
  createModule: false
});

This will produce configFile.js with an existing angular module

angular.module('myApp.config')
.constant('..', '..');

Type: Boolean or String Default value: false Optional

Wrap the configuration module in an IIFE or your own wrapper.

gulpNgConfig('myApp.config', {
  wrap: true
})

Will produce an IIFE wrapper for your configuration module:

(function () {
  return angular.module('myApp.config') // [] has been removed
  .constant('..', '..');
})();

You can provide a custom wrapper. Provide any string you want, just make sure to include <%= module %> for where you want to embed the angular module.

gulpNgConfig('myApp.config', {
  wrap: 'define(["angular"], function () {\n return <%= module %> \n});'
});

The reuslting file will contain:

define(["angular"], function () {
 return angular.module('myApp.config')
.constant('..', '..');
});

Type: String Default value: 'json' Optional

By default, json file is used to generate the module. You can provide yml file to generate the module. Just set parser to 'yml' or 'yaml'. If your file type is yml and you have not defined parser, your file will still be parsed and js be generated correctly. For example, you have a config.yml file,

string: my string
integer: 12345
object:
  one: 2
  three:
    - four

gulp.src("config.yml")
gulpNgConfig('myApp.config', {
  parser: 'yml'
});

Generating,

angular.module('myApp.config', [])
.constant('string', "my string")
.constant('integer', 12345)
.constant('object', {"one":2,"three":["four"]});

Contributions, issues, suggestions, and all other remarks are welcomed. To run locally just fork & clone the project and run npm install. Before submitting a Pull Request, make sure that your changes pass gulp test, and if you are introducing or changing a feature, that you add/update any tests involved.