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

undertaker-task-provider-registry

v1.2.1

Published

extendible undertaker registry for task containers

Downloads

17

Readme

undertaker-task-provider-registry

Build Status David semantic-release

extendible undertaker registry for task containers

Install

npm install undertaker-task-provider-registry

Use Providers

  • A task Provider must implement a get method
  • The get method must return a function
  • This function is then registered as an undertaker task

This alone is simply over-engineering and misuse of the factory pattern. The power comes from combining this with plugins

const TaksProviderRegistry = require('undertaker-task-provider-registry');

undertaker.registry(new TaksProviderRegistry({
  plugins: [],
  providers: [{
    get() {
      return function foo() {
        console.log('bar');
      };
    }
  }]
}));

const task = undertaker.task('foo');

task();
// logs "bar"

NO_TASK provider

if for some reason a provider can not provide a task, return TaksProviderRegistry.NO_TASK in providers get method.

Use plugins

  • A plugin may implement any of the following hooks
    • init
    • validate
    • decorateProvider
    • decorateHelper
    • decorateTask
    • get
  • A plugin hook must return its argument
  • A plugin hook may mutate its argument
const TaksProviderRegistry = require('undertaker-task-provider-registry');

undertaker.registry(new TaksProviderRegistry({
  plugins: [{
    decorateHelper(args) {
      args.helper.logMe = 'Hello World';

      return args;
    }
  }],
  providers: [{
    get(helper) {
      return function foo() {
        console.log(helper.logMe || 'bar');
      };
    }
  }]
}));

const task = undertaker.task('foo');

task();
// logs "Hello World"

Plugin Hooks

init(store)

  • first hook available
  • the store contains:
    • tasks:Array<Function> future list of all provided tasks
    • takerInst

use for setup and keeping a reference to the store

validate(provider)

  • supposed to throw if provider is invalid

decorateProvider(provider)

use for provider specific preparations

decorateHelper({helper, provider})

  • helper holds takerInst.series and takerInst.parallel by default
  • helper will be passed into the providers get method

use to expose methods that should be available inside every task factory

decorateTask(task)

  • task.provider holds a reference of the tasks creator

use to add meta information to the task or wrap it somehow

get({name, arguments, task})

  • name the original task name that was inquired
  • arguments all arguments from the call on registries get method
  • task the located task or undefined

use to manipulate or compose tasks

License

The MIT License

Copyright (C) 2016 Hannes Diercks

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.