Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

mock-argv

dword-design4.4kMIT4.0.0TypeScript support: included

Temporarily overrides the command line arguments. This is useful for testing.

args, argument-parser, arguments, argv, cli, command-line, command-line-tool, coverage, javascript, jest, mocha, mock, node, nodejs, npm, npm-package, replace, restore, test, testing

readme

mock-argv

npm version Linux macOS Windows compatible Build status Coverage status Dependency status Renovate enabled
Open in Gitpod Buy Me a Coffee PayPal Patreon

Temporarily overrides the command line arguments. This is useful for testing.

Install

# npm
$ npm install mock-argv

# Yarn
$ yarn add mock-argv

Usage

const mockArgv = require('mock-argv')

test('works', async () => {

  mockArgv(['foo', 'bar'], () => {
    //> process.argv = [
    //>   'path-to-node',
    //>   'path-to-current-script',
    //>   'foo',
    //>   'bar',
    //> ]
  })

  //> process.argv = ['path-to-node', 'path-to-current-script', '...other-params']

  // Also works for async functions
})

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

Buy Me a Coffee  If you want to send me a one time donation. The coffee is pretty good 😊.
PayPal  Also for one time donations if you like PayPal.
Patreon  Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

See also

  • output-files: Output a tree of files and directories by providing an object. Especially useful for testing with real files.
  • with-local-tmp-dir: Creates a temporary folder inside cwd, cds inside the folder, runs a function, and removes the folder. Especially useful for testing.
  • expect-mocha-image-snapshot: A wrapper around jest-image-snapshot that makes it compatible to Mocha.
  • jest-image-matcher: A Jest matcher for image comparisons based on pixelmatch. Can also be used with Mocha. Useful for visual regression testing.
  • unify-mocha-output: Adjusts a Mocha output so that it is consistent across platforms and can be used for snapshot testing. Basically adjusts the checkmark symbol and removes time values.

License

MIT License © Sebastian Landwehr

changelog

4.0.0 (2024-03-04)

Bug Fixes

BREAKING CHANGES

  • node.js >= 18

3.0.0 (2023-01-08)

Bug Fixes

BREAKING CHANGES

  • drop node 12 support, move to esm

2.0.8 (2022-01-12)

Bug Fixes

2.0.7 (2021-12-28)

Bug Fixes

2.0.6 (2021-07-20)

Bug Fixes

2.0.5 (2021-07-05)

Bug Fixes

2.0.4 (2021-06-29)

Bug Fixes

2.0.3 (2021-06-14)

Bug Fixes

2.0.2 (2021-06-08)

Bug Fixes

2.0.1 (2021-05-28)

Bug Fixes

2.0.0 (2021-05-03)

Bug Fixes

  • update dependency @dword-design/base to v8 (#44) (cd266b7)

BREAKING CHANGES

  • require Node.js >= 12

Co-authored-by: Renovate Bot bot@renovateapp.com Co-authored-by: Sebastian Landwehr info@dword-design.de Co-authored-by: GitHub Actions actions@github.com

1.1.15 (2021-04-20)

Bug Fixes

1.1.14 (2021-04-13)

Bug Fixes

1.1.13 (2021-03-22)

Bug Fixes

1.1.12 (2021-03-17)

Bug Fixes

1.1.11 (2021-02-17)

Bug Fixes

1.1.10 (2020-12-12)

Bug Fixes

  • Add TypeScript declaration (9a6222d)

1.1.9 (2020-12-02)

Bug Fixes

  • config: Update changed files (c21aedf)

1.1.8 (2020-08-26)

Bug Fixes

1.1.7 (2020-07-04)

Bug Fixes

1.1.6 (2020-02-18)

Bug Fixes

1.0.0 (2020-02-18)

Bug Fixes