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

cli-mocker

v1.0.4

Published

Quickly mock CLI commands for testing purposes

Downloads

106

Readme

CLI Mocker

This mini utility is used to help mock your CLI tools when writing tests in frameworks like Mocha or Jest. It will spawn your CLI tool, and synchronously execute an array of predefined commands you provide like arrow/enter keys, text inputs, etc.

Install

yarn add cli-mocker --dev
or
npm install cli-mocker --save-dev

Usage

import { run } from 'cli-mocker';

const { output, lastOutput } = await run('npx my-cli-command', [/* COMMANDS */]);

Available Inputs and Commands

Commands run synchronously, so the order of the commands that you use matters. Currently, this library supports the following inputs:

Up arrow key

import { UP } from 'cli-mocker';

Down arrow key

import { DOWN } from 'cli-mocker';

Enter key

import { ENTER } from 'cli-mocker';

Shut down CLI

import { EXIT } from 'cli-mocker';

String inputs

You can pass any string argument to your cli. For example, filling in an input prompt with "hello, world!".

Example with Mocha

import chai from 'chai';
import {
  run,
  UP,
  DOWN,
  ENTER,
  EXIT
} from 'cli-mocker';

const { expect } = chai;

describe('Test CLI', function() {
  it('Runs', async () => {
    const { output, lastOutput } = await run('npx my-cli-command', [
      // Press down arrow key
      DOWN,
      // Press enter
      ENTER,
      // Press up arrow key
      UP,
      // Type something
      'Hello, world!',
      ENTER,
      // Shut down CLI tool
      EXIT
    ]);
    
    return expect(lastOutput).to.equal(`Some value from your CLI tool's console.log() output`);
  });
})

Contributing

Pull requests and feature requests are welcomed!

Husky is set up to run linting and formatting before commits.