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

load-grunt-initconfig

v0.0.2

Published

Separate your long configuration into bite-sized chunks

Downloads

5

Readme

load-grunt-initconfig

Build Status

Separate your long configuration into bite-sized chunks.

Installation

npm install load-grunt-initconfig --save-dev

Usage

load-grunt-initconfig will look for config files in the .initconfig directory. Here is an example project structure:

$ tree -a
.
├── .initconfig
|   ├── clean.js
|   ├── copy.json
|   ├── jshint.js
|   └── mochaTest.json
└── Gruntfile.js

And an corresponding Gruntfile.js:

module.exports = function (grunt) {
  // load tasks
  grunt.loadNpmTasks('grunt-contrib-copy');
  grunt.loadNpmTasks('grunt-contrib-clean');
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-mocha-test');
  // require init config
  require('load-grunt-initconfig')(grunt); // this is the important bit
  // register tasks
  grunt.registerTask('test', ['copy', 'jshint', 'clean', 'mochaTest']);
  grunt.registerTask('default', ['test']);
};

In our example, this will require the config files, combine them into a single object, and apply that object to grunt.initConfig. Each of the config files' names should map to a grunt task (e.g. mochaTest.json maps to the mochaTest task).

Options

You can configure load-grunt-initconfig with options:

  • dir (the directory of your config files, default: .initconfig)

Here is an example using options:

module.exports = function (grunt) {
  // load tasks ...
  require('load-grunt-initconfig')(grunt, {
    dir: '.gruntconfig'
  });
  //register tasks ...
};

Config File Examples

There are two ways to include your config files, as json or javascript:

.json Example for jshint.js:

{
  "options": {
    "jshintrc": ".jshintrc"
  },
  "all": {
    "src": ["src/**/*.js"]
  }
}

For javascript, you can choose whether or not to inject the grunt object into your config:

javascript (with injection) Example for jshint.js:

// if you DO need injection, return an Function
module.exports = function (grunt) {
  return {
    options: {
      jshintrc: ".jshintrc"
    },
    all: {
      src: ["src/**/*.js"]
    }
  };
};

javascript (without injection) Example for jshint.js:

// if you don't need injection, return an Object
module.exports = {
  options: {
    jshintrc: ".jshintrc"
    },
    all: {
      src: ["src/**/*.js"]
    }
  }
};

More Info

If you are still unsure how the package works, check out the Gruntfile.js and .initconfig for this project on GitHub; it uses load-grunt-initconfig to test itself!