https://github.com/dword-design/mock-argv

Temporarily overrides the command line arguments. This is useful for testing.
https://github.com/dword-design/mock-argv

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

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dword-design/mock-argv
• Owner: dword-design
• License: other
• Created: 2019-09-25T18:51:51.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-21T07:34:24.000Z (3 months ago)
• Last Synced: 2024-10-17T18:18:49.349Z (2 months ago)
• Topics: 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
• Language: JavaScript
• Homepage:
• Size: 2.2 MB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        

# mock-argv

  


    

      

    

      

    

      

    

      

    


      

    

      

    

      

    

      

    



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

## Install

```bash

# npm

$ npm install mock-argv

# Yarn

$ yarn add mock-argv

```

## Usage

```js

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](https://github.com/dword-design/mock-argv/issues) or a [pull request](https://github.com/dword-design/mock-argv/pulls)! ⚙️

## 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:



  

    

   If you want to send me a one time donation. The coffee is pretty good 😊.


  

    

   Also for one time donations if you like PayPal.


  

    

   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](https://github.com/dword-design/output-files): Output a tree of files and directories by providing an object. Especially useful for testing with real files.

* [with-local-tmp-dir](https://github.com/dword-design/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](https://github.com/dword-design/expect-mocha-image-snapshot): A wrapper around jest-image-snapshot that makes it compatible to Mocha.

* [jest-image-matcher](https://github.com/dword-design/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](https://github.com/dword-design/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](https://opensource.org/license/mit/) © [Sebastian Landwehr](https://sebastianlandwehr.com)