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

macalino

v0.1.0-alpha

Published

Javascript task runner full optionals

Downloads

5

Readme

macalino

NPM Version NPM Downloads JS Standard Style Build Status 100% code coverage

JavaScript task runner full optional

Purpose

As developer, I want to:

  • run any kind of task (sync/async, Promises/callback) mixing parallel and serial
  • run tasks with dependencies tree
  • listen to tasks events (start, stop)
  • have task options like only, skip, timeout
  • start/stop/pause/resume/restart the batch
  • do all above easily

Inspired by orchestrator, undertaker and jest

Installing

npm i macalino

Quick start

minimal example

const m = require('macalino')

const run = async function () {
  const runner = new m.Runner()

  runner.add('task#1', async () => { await deelay(200); return 'task 1 done' })
  runner.add('task#1.1', async () => { await deelay(100); return 'task 1.1 done' })

  runner.add('task#2', async () => { await deelay(50); return 'task 2 done' })

  runner.add('task#3', async () => { await deelay(50); return 'task 3 done' }, { wait: ['task#1', 'task#2'] })

  const result = await runner.run()

  console.log(result)
}

run()

(@todo output)

full optional example

@todo

Features

@todo

  • task
    • [x] single
    • [x] series
    • [x] parallel
    • [x] wait option
      • [x] wait for multiple tasks
      • note: circularity is prevented because task can wait only for already existing tasks - it's a tree
    • Promise interface
      • [X] wrapper for callback and events: macalino.promise.event, macalino.promise.callback
      • [x] collect results > results = await runner.run()
  • settings
    • [x] settings.running : SERIES | PARALLEL (default PARALLEL)
    • [x] settings.trace > track time (default false)
  • events on run
    • [x] on, once, off
    • [x] run:start
    • [x] run:end({result: {outputs, errors}})
    • [x] task:start({id})
    • [x] task:end({id, output, error?})
  • play
    • [x] start
    • [x] stop
    • [x] restart
    • [x] pause
    • [x] resume
  • skip option
    • [x] in .add
    • [x] override in .run options
  • only option
    • [x] in .add
    • [x] override in .run options
  • error
    • default behavior: continue
  • timeout
    • timeout for each task execution
    • [x] in .add
    • [x] override in .run options
  • log
    • [x] each instance of Runner has its own log settings
  • [x] draw tree in console
  • [x] test coverage 100%

Logging

macalino use peppino as logger, see peppino doc

API

@todo (jsdoc + examples)


TODO

  • [ ] jsdoc
  • [ ] standard-release, conventional-commit

NEXT

  • [ ] strategy on error: continue, stop/pause after N errors
  • [ ] execution limit: running concurrent tasks
  • [ ] test with 1k tasks, 10k, 100k >>> get stack overflow error
  • [ ] benchmarks
  • [ ] experiment: workers as classic thread
    • notes https://www.codewall.co.uk/how-to-implement-worker-threads-in-node-js/
  • [ ] visual run (http)

License

The MIT License (MIT)

Copyright (c) 2020 Simone Sanfratello

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.