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

@devmy/cypress-runner

v1.2.1

Published

CLI tool to launch frontend and backend servers and run Cypress tests

Downloads

12

Readme

Cypress Runner

Cypress Runner is a command-line interface (CLI) tool designed to launch specified frontend and backend servers before running Cypress tests. The CLI expects to find a .cypressrunnerrc configuration file in the current working directory (cwd).

Installation

To install Cypress Runner, you can use npm:

npm install -g @devmy/cypress-runner

Configuration

Cypress Runner requires a .cypressrunnerrc file in the directory where it is executed. This file should export a configuration object that matches the interface CypressRunnerConfig

Example .cypressrunnerrc File

{
  "debug": true,
  "startWebServerCommands": [
    { "command": "npm run start:frontend", "name": "frontend" },
    { "command": "npm run start:backend", "name": "backend" }
  ],
  "waitOn": {
    "resources": ["http://localhost:3000", "http://localhost:4000"],
    "delay": 1000,
    "timeout": 30000
  }
}

Example .cypressrunnerrc.json File

{
  "debug": true,
  "startWebServerCommands": [
    { "command": "npm run start:frontend", "name": "frontend" },
    { "command": "npm run start:backend", "name": "backend" }
  ],
  "waitOn": {
    "resources": ["http://localhost:3000", "http://localhost:4000"],
    "delay": 1000,
    "timeout": 30000
  }
}

Example .cypressrunnerrc.js File

/** @type import('@devmy/cypress-runner').CypressRunnerConfig*/
const config = {
  debug: true,
  startWebServerCommands: [
    { command: "npm run start:frontend", name: "frontend" },
    { command: "npm run start:backend", name: "backend" }
  ],
  waitOn: {
    resources: ["http://localhost:3000", "http://localhost:4000"],
    delay: 1000,
    timeout: 30000
  }
};

exports.default = config;

Example .cypressrunnerrc.ts File

import { CypressRunnerConfig } from '@devmy/cypress-runner';

const config: CypressRunnerConfig = {
  debug: true,
  startWebServerCommands: [
    { command: "npm run start:frontend", name: "frontend" },
    { command: "npm run start:backend", name: "backend" }
  ],
  waitOn: {
    resources: ["http://localhost:3000", "http://localhost:4000"],
    delay: 1000,
    timeout: 30000
  }
};

export default config;

Usage

After configuring your .cypressrunnerrc file, you can run Cypress Runner from your project’s root directory:

cypress-runner [cypress options]

All additional parameters passed to the CLI will be forwarded directly to Cypress.

Example

cypress-runner open

In this example, cypress-runner will:

  1. Start the frontend and backend servers as specified in the .cypressrunnerrc file.
  2. Wait until the servers are up and running based on the waitOn configuration.
  3. Launch the Cypress test runner with the open option.

Options

debug

  • Type: boolean
  • Description: Enables debug logging for the Cypress Runner.
  • Default: false

startWebServerCommands

  • Type: Array<ConcurrentlyCommandInput> | ConcurrentlyCommandInput
  • Description: Commands to start the frontend and backend servers. This uses the concurrently package to run multiple commands concurrently.

waitOn

  • Type: WaitOnOptions
  • Description: Configuration options for the wait-on package to wait for resources (such as HTTP endpoints) to become available before starting Cypress.

License

This project is licensed under the MIT License. See the LICENSE file for more details.