Package detail

output-files

dword-design2.3kMIT2.0.32

Output a tree of files and directories by providing an object. Especially useful for testing with real files.

build, create, declarative, directory

readme

output-files

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

Output a tree of files and directories by providing an object. Especially useful for testing with real files. ## Install bash # npm $ npm install output-files # Yarn $ yarn add output-files ## Usage js const outputFiles = require('output-files') // outputs files in process.cwd() await outputFiles({ 'example1.md': 'Donec id elit non mi porta gravida at eget.', 'example2.md': 'Aenean eu leo quam. Pellentesque ornare.', someFolder: { 'content.md': 'Vivamus sagittis lacus vel augue laoreet.', 'README.md': '# This needs to be filled', }, }) // outputs files in example subdirectory await outputFiles('example', { 'foo.md': 'This is an interesting file', 'example2.md': 'This is another interesting file', }) // you can also define subdirectories without nesting the object await outputFiles({ 'folder1/folder2': { 'foo.md': 'This is an interesting file', }, 'foo/bar/example2.md': 'This is another interesting file', }) ## 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

  • 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.
  • mock-argv: Temporarily overrides the command line arguments. This is useful for testing.

License

MIT License © Sebastian Landwehr