cypress-timestamps-lts

Add timestamps to Cypress tests, error screenshots, and Command Log

Read the blog post Add Timestamps To Cypress

Install

$ npm i -D cypress-timestamps-lts
# or if using Yarn
$ yarn add -D cypress-timestamps-lts

Use

Include the plugin from your support file

// cypress/support/e2e.ts

// https://github.com/AlexGerus/cypress-timestamps
// eslint-disable-next-line @typescript-eslint/no-var-requires
require('cypress-timestamps-lts/support')();

Include this plugin from your project's plugin file. This is optional and is needed only if you enable the option terminal: true (see below)

// cypress.config.ts

import { defineConfig } from 'cypress';

export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      require('cypress-timestamps-lts/plugin')(on);
      return config;
    },
    baseUrl: 'http://localhost:3000',
  },
});

Options

By default, this plugin adds the timestamps to the error message if a test fails, and to the parent commands in the Command Log. You can also enable printing the test start and end timestamps in the terminal by registering the plugin (see above) and enabling the option when registering the support file.

// cypress/support/e2e.ts

// https://github.com/AlexGerus/cypress-timestamps
require('cypress-timestamps-lts/support')({
  terminal: true,
  error: true,
  commandLog: true,
})

terminal

Prints timestamps around each test, prints a timestamp of the screenshot taken on test failure

error

Adds the timestamp to any error thrown by the test

commandLog

Adds timestamps before each parent command that starts a new chain of commands

elapsed

When printing the timestamps to the command log, you can print either the absolute timestamp (by default), or the time since the test has started.

// cypress/support/e2e.ts

// https://github.com/AlexGerus/cypress-timestamps
require('cypress-timestamps-lts/support')({
  commandLog: true,
  elapsed: true,
})

Stamp all commands

By default, only the parent and dual commands get a timestamp in the Command Log to avoid verbose clutter. You can enable stamping every command using the commandLog: "all" option.

// cypress/support/e2e.ts

// https://github.com/AlexGerus/cypress-timestamps
require('cypress-timestamps-lts/support')({
  commandLog: 'all',
  elapsed: true,
})

Tip: looking to slow down your Cypress tests? Use my cypress-slow-down plugin.

MIT License

Copyright (c) 2024 Alex Gerus <[email protected]>

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.