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-task-options

v1.0.0

Published

Loads structured grunt tasks option files.

Downloads

1

Readme

Load Grunt Task Options

Loads structured grunt tasks option files.

Structuring Grunt tasks

Using a build system to automate repetitive tasks can simplify a developer's work-flow. If you are using Grunt, then you might be aware that a Gruntfile grows wildly really fast, making it hard to maintain.

The following is an example of a simple Grunt setup.

There is a generic Gruntfile that loads all grunt tasks declared as dependencies in the package.json file. Next, it will load custom tasks located under the tasks directory.

Each custom task should be in a separated JavaScript file. As a convention the filename should match the task name declared within.

Next, all task configuration options should be placed in their own JavaScript file inside the tasks/options directory. The filename must match the task it references. For example, the grunt-contrib-cssmin expects a cssmin options object so its corresponding file should be named cssmin.js

The structure project should look something like this:

.
├── Gruntfile.js
├── app
├── package.json
├── tasks
│   ├── build.js
│   ├── dist.js
│   ├── options
│   │   ├── cssmin.js
│   │   ├── ...
│   │   ├── gconfig.js
│   │   └── usemin.js
│   └── test.js
└── tests

Gruntfile.js

module.exports = function (grunt) {
  'use strict';  
  // load all grunt tasks
  require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);

  // Time how long tasks take.
  require('time-grunt')(grunt);

  /*
   * Default values.
   */
  var config = {
    app: 'app',
    dist: 'dist',
    test: 'tests'
  };
  
  var options = {};
  options.config = config;

  /*
   * Load configuration files.
   * Each file will be mapped to a property
   * in options object.
   */
  var loadConfigs = require('load-grunt-task-options');

  /**
   * Extend the default options object with
   * the loaded task options. 
   */
  grunt.util._.extend(options, loadConfigs('./tasks/options/'));  
  
  /**
   * We have a tasks directory with all
   * our custom tasks.
   */
  grunt.loadTasks('tasks');

  /**
   * Finally, run grunt with 
   * loaded options.
   */
  grunt.initConfig(options);
};

tasks/build.js

/**
 * Serve grunt task
 * @param  {Object} grunt Grunt instance
 */
module.exports = function(grunt) {
  /**
   * Define `build` task alias:
   */
  grunt.registerTask('build', [
    'clean:dist',
    'gconfig:dist',
    'version',
    'copy:build',
    'copy:gconf'
  ]);
};

tasks/options/cssmin.js

module.exports = {
  dist: {
    files: {
      '<%= config.dist %>/css/main.css': [
        '.tmp/css/{,*/}*.css',
        '<%= config.app %>/css/{,*/}*.css'
      ]
    }
  }
};

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2014 goliatone
Licensed under the MIT license.