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-module-index

v0.1.7

Published

Auto-build module index file (exports) based on folders and files.

Downloads

9

Readme

grunt-module-index

Grunt task to auto-build module index files (exports) based on folders and files.

Getting Started

This plugin requires Grunt ~0.4.0.

Install this grunt plugin with:

npm install grunt-module-index --save-dev

Then add this line to your project's grunt.js Gruntfile:

grunt.loadNpmTasks('grunt-module-index');

Tests

To do.

Options

format

Type: String Values: coffee, js Default: js

File format and extension.

indentTab

Type: String Default: ' ' (2 spaces)

Indentation characters.

notice

Type: String

Optional file header message.

omitDirs

Type: Array|String Default: []

Omit these directory names for the object hierarchy.

Example: omitDirs: ['src']

pathPrefix

Type: String

Optional prefix for every file path.

Example: pathPrefix: './' and a file in src/ ends as require('./src/...

requireWithExtension

Type: Boolean Default: false

Include file extensions on require calls.

flatIndex

Type: Boolean Default: false

Object hierarchy omits every directory.

Examples

Basic (javascript)

moduleIndex: {
  build: {
    src: ["src/"],
    options: {
      omitDirs: ["src"]
    }
  }
}

Full (coffee)

moduleIndex:
  build:
    src: ["modules/**/*.js", "components", "mixins/"]
    dest: "index.coffee"
    options:
      format: "coffee"
      indentTab: "\t"
      notice: "Generated with grunt"
      omitDirs: ["src"]
      pathPrefix: "./"
      requireWithExtension: true

Output example

//! This file was auto-generated by grunt-module-index, DO NOT edit it directly
module.exports = exports = {
  components: {
    nav: {
      nav: require("components/nav/nav"),
      navItem: require("components/nav/navItem")
    },
    form: {
      button: require("components/form/button"),
      input: require("components/form/input")
    }
  }
};
//EOF

License

Copyright (c) 2014-2015 Ignacio Lago

Licensed under the MIT license.