Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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.
https://github.com/dword-design/output-files

build create declarative directory file files-system fs generate json object recursive test tree write

Last synced: 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/dword-design/output-files
Owner: dword-design
License: other
Created: 2019-09-23T10:04:07.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-23T05:03:27.000Z (3 months ago)
Last Synced: 2024-10-17T19:23:44.134Z (3 months ago)
Topics: build, create, declarative, directory, file, files-system, fs, generate, json, object, recursive, test, tree, write
Language: JavaScript
Homepage:
Size: 2.46 MB
Stars: 5
Watchers: 2
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

# output-files

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](https://github.com/dword-design/output-files/issues) or a [pull request](https://github.com/dword-design/output-files/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

* [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.
* [mock-argv](https://github.com/dword-design/mock-argv): Temporarily overrides the command line arguments. This is useful for testing.

## License