npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

grunt-build-config

v0.2.4

Published

Make config file for broswer at build time

Downloads

5

Readme

grunt-build-config

Make config file for browser at build time

NPM Version Build Status

Why I wrote this

For server-side applications like node.js, configuration per mode can be set with env variable(ex. NODE_ENV). But client-side applications cannot be easily configured in this way, because the apps run on the browser.

So I wrote this! This plugin generates configuration file for browser at 'build time'.

For example, when configuration file is given,

module.exports = {
  development: {
    api_host: "http://localhost:7000",
    env: process.env.NODE_ENV
  },
  production: {
    api_host: "http://my-api.server.com",
    env: process.env.NODE_ENV
  }
};

run buildconfig task,

$ grunt buildconfig:development

then a file which will run on browsers is generated.

default mode:

/* jshint ignore:start */
;(function () {

  'use strict';

  window.__BUILD_CONFIG__ =
  {
    "api_host": "http://localhost:7000",
    "env": "development"
  };

})();
/* jshint ignore:end */

browserify mode:

/* jshint ignore:start */
'use strict';
module.exports = {
  "api_host": "http://localhost:7000",
  "env": "development"
};
/* jshint ignore:end */

Installation

$ npm install grunt-build-config --save-dev

Buildconfig task

Run this task with the grunt buildconfig command.

Read a configuration table and generate a configuration file with given environment.

Options

srcFile

Type: String
Default: 'buildconfig'

Input file path.

srcFile should be an requirable path (ex. *.js, *.json) that returns an object with properties. task target will be used to choose value of which property will be used. The value of it will be given to the global variable.

destFile

Type: String
Default: 'out/buildconfig.js'

Output file path.

varName

Type: String
Default: '_BUILD_CONFIG_'

Name of the global variable which contains the configuration information.

mode

Type: String Default: 'default'

Form of output js file.
When mode is default, config file data is assigned to a global variable.
When mode is browserify, config file data will be exported in commonjs way.

Usage Examples

buildconfig: {
  options: {
    srcFile: 'test/fixtures/config.js',
    destFile: '.tmp/config.js',
    varName: '__CONFIG__',
    mode: 'default'
  }
},

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

License

MIT