0.0.2 • Published 9 years ago

commandjson v0.0.2

Weekly downloads
9
License
-
Repository
github
Last release
9 years ago

CommandJSON

A published requirement for hoarderless. It parses files in the folder you enter and returns a json object representing each files structure

install the package
    npm install commandjson
    var cmdjson = require('commandjson');
    var file = {};
    file.type = 'html'; ( the other option for type is css )
    file.paths = '/path/to/your/view/folder';  ( paths is plural here but right now is only one string. will become an array of strings )
    return cmdjson.getFiles(file)
	    .then(function(code){
	        console.log(code);
	    });

Require the module, and add the above code replacing /path/to/your/view/folder to a valid path. The function getFiles(file), shown in the above code snippet, expects an object with 2 properties for data.type, data.paths and it resolves a promise

returns an object in this form

    Object {
        selectors: Object,
        code: Array[],
        filenames: Array[],
        status: "success" || "error"
    }

the selectors object, from the object shown above, is used for most of the work while comparing the css with the view. It contains an array for attributes, classes, ids and viewcode

    selectors: Object {
	    attributes: Array[],
	    classes: Array[],
	    ids: Array[],
	    viewcode: Array[]
	}