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

make-runnable

v1.4.1

Published

Call a module's exported functions directly from the command line, with arguments.

Downloads

91,614

Readme

Run Exported Functions Directly From The Command Line

What's the quickest way to trial a function you're exporting?

Doing this in your shell?

$node
>require('./your_file').addOneTo(3)
4

No. That's annoying. And you have to repeat it all every time you change your_file.js.

Rather insert the following at the end of your_file.js to expose its exports to the command line:

require('make-runnable');

That's it. Now you can do:

$node your_file.js addOneTo 3
4

Syntax

Call your function with several args:

node [your_file] [function_name] firstArg secondArg 

Or call it with a single object:

node [your_file] [function_name] --key1 value1 --key2 value2 

Full Example

Let's say you have the following file:

your_file.js

module.exports = {
    addTogether: function(x,y){
        return x + y
    }, doSomethingWithObject: function(object){
        object.newKey = "easy AF";
        return object;
    }, simpleValue: 'also works'
};
require('make-runnable');

You can now do the following:

$sh

node your_file.js addTogether 1 2
> 3
node your_file.js doSomethingWithObject --x 1 --y hello
> {x: 1, y: 'hello', newKey: 'easy AF'}
node your_file.js simpleValue
> also works

How does it work?

  1. require.main === module is used to check if the module is being run directly, or imported.
  2. If it's being run directly, then yargs is used to parse process.argv so that the target function may be called with the desired arguments.

What if you want to:

Run a function directly exported by a module, not nested inside an exported object

Just leave off the function name, like so:

say_hello.js

module.exports = function(){console.log('hello');};

$sh

node say_hello.js
> hello

View the output of a function that doesn't print anything

The output is automatically printed.

View the resolved value of a Promise returned by a function

That happens automatically.

Remove the --------make-runnable-output-------- frame from printed output

You can pass in a custom option to make-runnable to remove that, like this:

require('make-runnable/custom')({
    printOutputFrame: false
})

Remove printed output

You can pass in a custom option to make-runnable to hide the output message and frame generated by make-runnable:

require('make-runnable/custom')({
    printOutput: false
})

Remove printed errors

You can pass in a custom option to make-runnable to hide error messages and frames generated by make-runnable:

require('make-runnable/custom')({
    printErrorOutput: false
})

Pass in multiple objects to the function being called

While you can pass a single object, or multiple primitives, multiple objects are not currently supported. PRs welcome!