Parse directory files into a formated JSON tree.
I needed to build my static files with an appended md5. I wanted to get this:
// js.json
{
"base": "js/base.xxx.js",
"jquery": "js/jquery.xxx.js"
}
// or
{
"www-base": "www/js/base.xxx.js",
"mobile-base": "mobile/js/base.xxx.js"
}
// css.json
{
"base": "css/base.xxx.css"
}Now we have access to all the file paths, no matter what the environment is, development or production.
The best Grunt plugin ever.
This plugin requires Grunt >=0.4.0
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-tree --save-devOne the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-tree');In your project's Gruntfile, add a section named tree to the data object passed into grunt.initConfig().
grunt.initConfig({
tree: {
options: {
// md5: boolean or number [1-32] | default: false
// format: | boolean default: false
// ext: object
// ext.level: boolean or number [1-N] | default: false
// ext.hyphen: string | default: "-"
// base: string | default: ""
// uncpath: boolean | default: true
// prettify: boolean | default: true
},
your_target: {
src: ['relativePath/**'],
dest: 'saveTheResult/'
}
}
})Type: Boolean|Number
Default value: false
Get the md5 value of the file and append it onto the file name. If the value is number, then cut the full md5 value to the length.
Type: Boolean
Default value: false
A boolean value that what you want the format of result to be.
The Default result is the tree format like the command tree.
And if format set to true, then output a one-to-one mode. Becareful to set format to true, it will overwrite the same file name.
Type: Object
Default value: { level:0, hyphen: "-" }. Add in verison 0.4.4.
There is a new option for solve the problem of the same name in directory.
Note:
And the format option must be set to true.
The level option in options.ext means the subdirectory level.
If file relative path is 'www/css/base.css' and level set to 1, then the result will be: "www-base": "www/css/base.css".
And if level set to 2, then the result will be: "css-base": "www/css/base.css". But you set level to 3 in this condition, the result also is : "base": "www/css/base.css".
Type: String
Default value: ''.
Tree's root directory. This does not effect src files.
Type: Boolean
Default value: true. Add in version 0.4.5.
This is new option for some people run in the windows system and they need unix path rather than the default windows path.
So, if your project run in unix system, you can turn on it.
Type: Boolean
Default value: true. Add in version 0.4.5.
This is new option for output style, It is equivalent to JSON.stringify(json, null, prettify ? 2 : 0).
Anyway, see the examples.
This task now supports globbing and Building the files object dynamically.
grunt.initConfig({
tree: {
default: {
options: {},
expand: true,
cwd: 'test/',
src: ['**'],
dest: '/tmp/test.json'
}
}
});
// If the have files: "a.css", "js/b.js", "c" in the test directory,
// 1. run grunt, then the result will like:
{
"a": "a.css",
"js": {
"b": "js/b.js"
},
"c": "c"
}
// 2. change the options to: { md5 : 8 }, and result will be like:
{
"a": "a.e8dcfa25.css",
"js": {
"b": "js/b.59efd297.js"
},
"c": "c.a8e91771"
}
// 3. change the options to: { format: true }, and result will be like:
{
"a": "a.css",
"b": "js/b.js"
"c": "c"
}
// 6. change the options to : { format: true, ext: { level: 1, hyphen: "-" } }, and result will be like:
// Attention: if we use ext option, and the format must be set to true.
{
"a": "a.css",
"c":"c",
"js-b":"js/b.js"
}
// 7. try to mix the options, and have a look.
...var APP_NAME = 'imovie',
PATH_TMP = 'tmp/';
var deps = {};
function getVersion(filepath, jsonFile, grunt) {
grunt.log.writeln(filepath, jsonFile).ok();
if (!deps[jsonFile]) {
deps[jsonFile] = grunt.file.readJSON(jsonFile);
grunt.log.writeln('Loading file:', jsonFile);
grunt.log.writeln('Content is:', deps[jsonFile]);
}
var filename = filepath.match(/(?:^|\/)([^\/]+)\.(js|css|less)$/)[1];
return deps[jsonFile][filename];
}
module.exports = function(grunt) {
var config = {
pkg: grunt.file.readJSON('package.json'),
uglify: {
options: {
compress: true,
banner: '/*! ©<%= pkg.name %> <%= pkg.version %> */\n'
},
build: {
files: [
{
expand: true,
cwd: PATH_SRC,
src: [APP_NAME + '/*.js', APP_NAME + '/**/*.js'],
dest: PATH_DEST,
ext: '.js',
rename: function(dest, src) {
var version = getVersion(src, PATH_TMP + APP_NAME + '.json', grunt);
return version && (dest + version);
}
}
]
}
},
tree: {
options: {
base: APP_NAME,
format: true,
md5: 8
},
js: {
src: [PATH_SRC, '!js'],
dest: PATH_TMP + APP_NAME + '.json'
}
}
};
grunt.initConfig(config);
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-tree');
grunt.registerTask('builddeps', 'build static dependencies for mobile project base on freemarker', function() {
var jsContent = grunt.file.read(PATH_TMP + APP_NAME + '.json'),
cssContent = grunt.file.read(PATH_TMP + APP_NAME + 'css.json');
grunt.file.write(FILE_STATIC, '<#assign JS_FILE=' + jsContent + ' CSS_FILE=' + cssContent + '>');
});
grunt.registerTask('default', ['tree','uglify', 'builddeps']);
});// Gruntfile.js
var STATIC_PATH = 'static/',
BUILD_PATH = 'build/';
module.exports = function(grunt) {
var config = {
tree: {
js: {
options: {
base: STATIC_PATH,
md5: 8,
format: true,
ext: {
level: 1
}
},
src: ['**', '!js'],
dest: BUILD_PATH + 'data/js.json'
},
css: {
options: {
base: STATIC_PATH,
md5: 8,
format: true,
ext: {
level: 1
}
},
src: ['**', '!css'],
dest: BUILD_PATH + 'data/css.json'
}
},
genStaticConfig: {
build: []
}
};
// Project Configuration
grunt.initConfig(config);
// load grunt tree module.
grunt.loadNpmTasks('grunt-tree');
grunt.registerMultiTask('genStaticConfig', 'generate static config files with js.json and css.json', function() {
grunt.config('tree.css.options.md5', false);
var files = grunt.config('tree.css.files');
files[0].dest = 'data/css.json';
grunt.config('tree.css.files', files);
grunt.config('tree.js.options.md5', false);
files = grunt.config('tree.js.files');
files[0].dest = 'data/js.json';
grunt.config('tree.js.files', files);
});
// for production
grunt.registerTask('static', ['tree']);
// for development
grunt.registerTask('buildstatic', ['genStaticConfig', 'tree']);
};npm run-script test
# To setup, in your console run `npm install` then run the following to test:
# grunt test- Compatibility fix for node 0.10.x. [2013/04/12] => for 0.4.1
- Add nodeunit test case. [2013/04/12] => for 0.4.2
- Add
extoption for avoid the same name of key. [2013/06/03] => for 0.4.3 - Add
cwdoption for flexible configuration. [2013/07/23] => for 0.4.4 - Add
excludeoption for filter useless file. Anduncpath,prettifyoptions. [2014/03/19] => for 0.4.5. - Use
grunt.file.matchforexcludemethod. [2014/05/19] => for 0.4.6.