directory-layout

Directory Layout Verifier

Project builds can be complex, and the size and structure of the final build directory may be equally complex. While unit testing helps to ascertain if code is intact, "Directory Layout Verifier" tests that the build has resulted in correct creation of files / directories at respective positions, which otherwise takes unnecessary time to debug in case the build failed partially.

Creation of directory structure is also automated, thus you don't need to create it by yourself. Checkout our tests folder for further understanding.

We've used markdown syntax to store the directory structure, easy for you to verify visually (if possible).

Usage:

For directory layout generation:

var LayoutGenerator = require('../lib/generate.js');

LayoutGenerator.generate('test/fixtures/', {
	output: './test/output/layout.md',
	ignore: [
		'.DS_Store'
	]
});

For layout verification:

var LayoutVerifier = require('../lib/verify.js');

LayoutVerifier.verify('test/output/layout.md', {
	root: './test/fixtures'
});

Coming soon:

• Grunt and Gulp tasks