Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-13 22:41:32 -05:00
Code Issues Activity

Merge pull request #1274 from nschonni/grunt-task-names

Browse source 
Move JS comments to task descriptions
This commit is contained in:
Hannah Wolfe 2013-10-25 04:43:01 -07:00
commit fb199fd588
1 changed files with 70 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

141
Gruntfile.js
View file

@ -3,7 +3,7 @@ var path = require('path'),
semver = require('semver'), semver = require('semver'),
fs = require('fs'), fs = require('fs'),
_ = require('underscore'), _ = require('underscore'),
spawn = require("child_process").spawn, spawn = require('child_process').spawn,
buildDirectory = path.resolve(process.cwd(), '.build'), buildDirectory = path.resolve(process.cwd(), '.build'),
distDirectory = path.resolve(process.cwd(), '.dist'), distDirectory = path.resolve(process.cwd(), '.dist'),
configLoader = require('./core/config-loader.js'), configLoader = require('./core/config-loader.js'),
@ -111,7 +111,7 @@ var path = require('path'),
dev: { dev: {
options: { options: {
//output: "Express server listening on address:.*$" //output: 'Express server listening on address:.*$'
} }
}, },
test: { test: {
@ -497,8 +497,7 @@ var path = require('path'),
grunt.initConfig(cfg); grunt.initConfig(cfg);
grunt.registerTask('setTestEnv', function () { grunt.registerTask('setTestEnv', 'Use "testing" Ghost config; unless we are running on travis (then show queries for debugging)', function () {
// Use 'testing' Ghost config; unless we are running on travis (then show queries for debugging)
process.env.NODE_ENV = process.env.TRAVIS ? 'travis' : 'testing'; process.env.NODE_ENV = process.env.TRAVIS ? 'travis' : 'testing';
}); });
@ -509,8 +508,7 @@ var path = require('path'),
}); });
}); });
// Update the package information after changes grunt.registerTask('updateCurrentPackageInfo', 'Update the package information after changes', function () {
grunt.registerTask('updateCurrentPackageInfo', function () {
cfg.pkg = grunt.file.readJSON('package.json'); cfg.pkg = grunt.file.readJSON('package.json');
}); });
@ -552,7 +550,7 @@ var path = require('path'),
* - Pulls changelog from git, excluding merges. * - Pulls changelog from git, excluding merges.
* - Uses first line of commit message. Includes committer name. * - Uses first line of commit message. Includes committer name.
*/ */
grunt.registerTask("changelog", "Generate changelog from Git", function () { grunt.registerTask('changelog', 'Generate changelog from Git', function () {
// TODO: Break the contents of this task out into a separate module, // TODO: Break the contents of this task out into a separate module,
// put on npm. (@cgiffard) // put on npm. (@cgiffard)
@ -727,12 +725,12 @@ var path = require('path'),
// Use the comparison with HEAD to remove commits which // Use the comparison with HEAD to remove commits which
// haven't been included in a build/release yet. // haven't been included in a build/release yet.
if (tag.tag === "HEAD") { if (tag.tag === 'HEAD') {
commits.forEach(function (commit) { commits.forEach(function (commit) {
commitCache[commit.hash] = true; commitCache[commit.hash] = true;
}); });
return callback(""); return callback('');
} }
buffer += '## Release ' + tag.tag + '\n'; buffer += '## Release ' + tag.tag + '\n';
@ -753,7 +751,7 @@ var path = require('path'),
}); });
if (!commits.length) { if (!commits.length) {
buffer += "\nNo changes were made in this build.\n"; buffer += '\nNo changes were made in this build.\n';
} }
callback(buffer + '\n'); callback(buffer + '\n');
@ -792,52 +790,52 @@ var path = require('path'),
}); });
}); });
/* Nightly builds grunt.registerTask('nightly',
* - Do our standard build steps (sass, handlebars, etc) 'Nightly builds\n' +
* - Bump patch version in package.json, commit, tag and push ' - Do our standard build steps (sass, handlebars, etc)\n' +
* - Generate changelog for the past 14 releases ' - Bump patch version in package.json, commit, tag and push\n' +
* - Copy files to build-folder/#/#{version} directory ' - Generate changelog for the past 14 releases\n' +
* - Clean out unnecessary files (travis, .git*, .af*, .groc*) ' - Copy files to build-folder/#/#{version} directory\n' +
* - Zip files in build folder to dist-folder/#{version} directory ' - Clean out unnecessary files (travis, .git*, .af*, .groc*)\n' +
*/ ' - Zip files in build folder to dist-folder/#{version} directory',
grunt.registerTask("nightly", [ [
"setCurrentBuildType:Nightly", 'setCurrentBuildType:Nightly',
"shell:bourbon", 'shell:bourbon',
"sass:compress", 'sass:compress',
"handlebars", 'handlebars',
"concat", 'concat',
"uglify", 'uglify',
"bump:build", 'bump:build',
"updateCurrentPackageInfo", 'updateCurrentPackageInfo',
"changelog", 'changelog',
"copy:nightly", 'copy:nightly',
"compress:nightly" 'compress:nightly'
]); ]);
grunt.registerTask("weekly", [ grunt.registerTask('weekly', [
"setCurrentBuildType:Weekly", 'setCurrentBuildType:Weekly',
"shell:bourbon", 'shell:bourbon',
"sass:compress", 'sass:compress',
"handlebars", 'handlebars',
"concat", 'concat',
"uglify", 'uglify',
"bump:build", 'bump:build',
"updateCurrentPackageInfo", 'updateCurrentPackageInfo',
"changelog", 'changelog',
"copy:weekly", 'copy:weekly',
"compress:weekly" 'compress:weekly'
]); ]);
grunt.registerTask("build", [ grunt.registerTask('build', [
"shell:bourbon", 'shell:bourbon',
"sass:compress", 'sass:compress',
"handlebars", 'handlebars',
"concat", 'concat',
"uglify", 'uglify',
"changelog", 'changelog',
"clean:build", 'clean:build',
"copy:build", 'copy:build',
"compress:build" 'compress:build'
]); ]);
grunt.registerTask('release', [ grunt.registerTask('release', [
@ -852,38 +850,33 @@ var path = require('path'),
'compress:release' 'compress:release'
]); ]);
// Dev Mode; watch files and restart server on changes grunt.registerTask('dev',
grunt.registerTask("dev", [ 'Dev Mode; watch files and restart server on changes',
"sass:admin", [
"handlebars", 'sass:admin',
"concat", 'handlebars',
"express:dev", 'concat',
"open", 'express:dev',
"watch" 'open',
'watch'
]); ]);
// Prepare the project for development
// TODO: Git submodule init/update (https://github.com/jaubourg/grunt-update-submodules)? // TODO: Git submodule init/update (https://github.com/jaubourg/grunt-update-submodules)?
grunt.registerTask('init', ['shell:bourbon', 'default']); grunt.registerTask('init', 'Prepare the project for development', ['shell:bourbon', 'default']);
// Run unit tests grunt.registerTask('test-unit', 'Run unit tests', ['clean:test', 'setTestEnv', 'loadConfig', 'express:test', 'mochacli:all']);
grunt.registerTask('test-unit', ['clean:test', 'setTestEnv', 'loadConfig', 'express:test', 'mochacli:all']);
// Run casperjs tests only grunt.registerTask('test-functional', 'Run casperjs tests only', ['clean:test', 'setTestEnv', 'express:test', 'spawn-casperjs']);
grunt.registerTask('test-functional', ['clean:test', 'setTestEnv', 'express:test', 'spawn-casperjs']);
// Run tests and lint code grunt.registerTask('validate', 'Run tests and lint code', ['jslint', 'test-unit', 'test-functional']);
grunt.registerTask('validate', ['jslint', 'test-unit', 'test-functional']);
// Generate Docs grunt.registerTask('docs', 'Generate Docs', ['groc']);
grunt.registerTask('docs', ['groc']);
// TODO: Production build task that minifies with uglify:prod // TODO: Production build task that minifies with uglify:prod
grunt.registerTask('prod', ['sass:compress', 'handlebars', 'concat', 'uglify']);
grunt.registerTask("prod", ['sass:compress', 'handlebars', 'concat', "uglify"]); // When you just say 'grunt'
grunt.registerTask('default', ['sass:compress', 'handlebars', 'concat']);
// When you just say "grunt"
grunt.registerTask("default", ['sass:compress', 'handlebars', 'concat']);
}; };
module.exports = configureGrunt; module.exports = configureGrunt;