Ng-constant NPM

ng-constant

Node module that creates an angular constants file from data (like JSON file)

Based on gulp-ng-constant

Usage

Default `option.stream = false`

index.js

var ngConstant = require('ngConstant');

var file = ngConstant({
  name: 'app.config',
  deps: ['ngAnimate'],
  constants: { john: 'doe' },
  wrap: 'es6',
});

console.log(file);

(output)

'use strict';

import angular from 'angular';

let env = angular.module("app.config", ["ngAnimate"])

.constant("john", "doe")

;

export default env;

Stream `options.stream = true`

index.js

var fs = require('fs');
var ngConstant = require('ngConstant');

var file = [];

fs.createReadStream('app/config.json')
  .pipe(ngConstant({
    name: 'app.config',
    deps: ['ngAnimate'],
    stream: true,
    constants: { john: 'doe' },
    wrap: 'es6',
  }))
  .on('data', function (data) {
    file.push(data);
  })
  .on('end', function () {
    console.log(file.toString());
  });

app/config.json

{
  "foo": true,
  "bar": { "hello": "world" }
}

(output)

'use strict';

import angular from 'angular';

let env = angular.module("app.config", ["ngAnimate"])

.constant("foo", true)

.constant("bar", {
  "hello": "world"
})

.constant("john", "doe")

;

export default env;

Options

options.name

Type: string Default: filename or "ngConstants" Overrides: json.name optional

The module name. This property will override any name property defined in the input json file.

options.stream

Type: boolean Default: false optional

If true it returns a stream.

options.constants

Type: Object | string Default: undefined Exends/Overrides: json.constants

Constants to defined in the module. Can be a JSON string or an Object. This property extends the one defined in the input json file. If there are properties with the same name, this properties will override the ones from the input json file.

options.deps

Type: array<string>|boolean Default: [] Overrides: json.deps optional

An array that specifies the default dependencies a module should have. To add the constants to an existing module, you can set it to false. This property will override any deps property defined in the input json file.

options.wrap

Type: boolean|string Default: false Available: ['amd', 'commonjs', 'es6', 'typescript'] optional

A boolean to active or deactive the automatic wrapping. A string who will wrap the result of file, use the <%= __ngModule %> variable to indicate where to put the generated module content. A string with 'amd' that wraps the module as an AMD module, compatible with RequireJS

options.space

Type: string Default: '\t' optional

A string that defines how the JSON.stringify method will prettify your code.

options.template

Type: string Default: content of tpls/constant.tpl.ejs optional

EJS template to apply when creating the output configuration file. The following variables are passed to the template during render:

moduleName: the module name (string)
deps: the module dependencies (array<string>)
constants: the module constants (array<constantObj>)
- where a constantObj is an object with a name and a value, both strings.