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

expand-config

v0.4.3

Published

Expand tasks, targets and files in a declarative configuration.

Downloads

7

Readme

expand-config NPM version Build Status

Expand tasks, targets and files in a declarative configuration.

TOC

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm i expand-config --save

Usage

Expand a declarative configuration with tasks, targets and files mappings. Optionally pass a name as the first argument.

var config = require('expand-config');

config({
  site: {
    src: 'templates/*.hbs',
    dest: 'site/'
  },
  blog: {
    src: 'content/*.md',
    dest: 'site/blog/'
  }
});

API

Config

Expand a declarative configuration with tasks and targets. Create a new Config with the given options

Params

  • options {Object}

Example

var config = new Config();

// example usage
config.expand({
  jshint: {
    src: ['*.js', 'lib/*.js']
  }
});

.expand

Expand and normalize a declarative configuration into tasks, targets, and options.

Params

  • config {Object}: Config object with tasks and/or targets.
  • returns {Object}

Example

config.expand({
  options: {},
  assemble: {
    site: {
      mapDest: true,
      src: 'templates/*.hbs',
      dest: 'site/'
    },
    docs: {
      src: 'content/*.md',
      dest: 'site/docs/'
    }
  }
});

.addTask

Add a task to the config, while also normalizing targets with src-dest mappings and expanding glob patterns in each target.

Params

  • name {String}: the task's name
  • config {Object}: Task object where each key is a target or options.
  • returns {Object}

Example

task.addTask('assemble', {
  site: {src: '*.hbs', dest: 'templates/'},
  docs: {src: '*.md', dest: 'content/'}
});

.addTarget

Add a target to the config, while also normalizing src-dest mappings and expanding glob patterns in the target.

Params

  • name {String}: The target's name
  • target {Object}: Target object with a files property, or src and optionally a dest property.
  • returns {Object}

Example

config.addTarget({src: '*.hbs', dest: 'templates/'});

Plugins

See the plugins documentation.

Docs

The unit tests have lots of good usage examples. You can visit the following libraries if you want to dive deeper into the API/features and options for each configuration type.

Tasks

Visit expand-task to see the docs and full range of options for task expansion.

Targets

Visit expand-target to see the docs and full range of options for target expansion.

Files

Visit expand-files to see the docs and full range of options for files expansion.

Related projects

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

Copyright © 2014-2016 Jon Schlinkert Released under the MIT license.


This file was generated by verb on January 06, 2016.