VerdiJS Project Layout Instance

The PLI (Project Layout Instance) is a javascript object model of the standard directory layout that all VerdiJS modules use. The standard layout enables users to instantly feel at home in any one of the VerdiJS modules.

The PLI is inspired by the Apache Maven Standard Directory Layout.

Directory Descriptions

The following directories are modeled by the PLI.

Source Directories

| Directory | Summary | |:--------------|:----------------------------------------------------------| | src/main/css | Entry level CSS module(s) are contained in this directory | | src/main/js | Javascript supporting dynamic demoes | | src/main/html | Dynamic demonstrations | | src/test/css | CSS test utilities | | src/test/js | Javascript supporting CSS unit tests | | src/test/html | Html pages for loading the unit tests |

Target Directories

| Directory | Summary | |:-----------------|:------------------------------| | target/main/css | Built CSS modules | | target/main/js | Built javascript | | target/main/html | Built dynamic demo html pages | | target/test/css | Built test CSS utilities | | target/test/js | Built test Javascript | | target/test/html | Built test html |

Usage

var PLI = require('verdijs-pli');
console.log(PLI.src.main.css);
//Logs `./src/main/css`

Extension

More directories can easily be added, and will naturally fit with the build methodology. For example:

| Directory | Summary | |:---------------------|:---------------| | src/main/coffescript | Coffescript | | src/main/jade | Jade templates |