grunt.js 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. /*
  2. * grunt
  3. * http://gruntjs.com/
  4. *
  5. * Copyright (c) 2012 "Cowboy" Ben Alman
  6. * Licensed under the MIT license.
  7. * https://github.com/gruntjs/grunt/blob/master/LICENSE-MIT
  8. */
  9. 'use strict';
  10. // Nodejs libs.
  11. var path = require('path');
  12. // This allows grunt to require() .coffee files.
  13. require('coffee-script');
  14. // The module to be exported.
  15. var grunt = module.exports = {};
  16. // Expose internal grunt libs.
  17. function gRequire(name) {
  18. return grunt[name] = require('./grunt/' + name);
  19. }
  20. var util = gRequire('util');
  21. gRequire('template');
  22. gRequire('event');
  23. var fail = gRequire('fail');
  24. var file = gRequire('file');
  25. var option = gRequire('option');
  26. var config = gRequire('config');
  27. var task = gRequire('task');
  28. var log = gRequire('log');
  29. var help = gRequire('help');
  30. gRequire('cli');
  31. var verbose = grunt.verbose = log.verbose;
  32. // Expose some grunt metadata.
  33. grunt.package = file.readJSON(path.join(__dirname, '../package.json'));
  34. grunt.version = grunt.package.version;
  35. // Expose specific grunt lib methods on grunt.
  36. function gExpose(obj, methodName, newMethodName) {
  37. grunt[newMethodName || methodName] = obj[methodName].bind(obj);
  38. }
  39. gExpose(task, 'registerTask');
  40. gExpose(task, 'registerMultiTask');
  41. gExpose(task, 'registerInitTask');
  42. gExpose(task, 'renameTask');
  43. gExpose(task, 'loadTasks');
  44. gExpose(task, 'registerTask');
  45. gExpose(task, 'loadNpmTasks');
  46. gExpose(config, 'init', 'initConfig');
  47. gExpose(fail, 'warn');
  48. gExpose(fail, 'fatal');
  49. // Handle otherwise unhandleable (probably asynchronous) exceptions.
  50. process.on('uncaughtException', function (e) {
  51. fail.fatal(e, fail.code.TASK_FAILURE);
  52. });
  53. // Expose the task interface. I've never called this manually, and have no idea
  54. // how it will work. But it might.
  55. grunt.tasks = function(tasks, options, done) {
  56. // Update options with passed-in options.
  57. option.init(options);
  58. // Display the grunt version and quit if the user did --version.
  59. var _tasks, _options;
  60. if (option('version')) {
  61. // Not --verbose.
  62. log.writeln('grunt v' + grunt.version);
  63. if (option('verbose')) {
  64. // --verbose
  65. verbose.writeln('Install path: ' + path.resolve(__dirname, '..'));
  66. // Yes, this is a total hack, but we don't want to log all that verbose
  67. // task initialization stuff here.
  68. grunt.log.muted = true;
  69. // Initialize task system so that available tasks can be listed.
  70. grunt.task.init([], {help: true});
  71. // Re-enable logging.
  72. grunt.log.muted = false;
  73. // Display available tasks (for shell completion, etc).
  74. _tasks = Object.keys(grunt.task._tasks).sort();
  75. verbose.writeln('Available tasks: ' + _tasks.join(' '));
  76. // Display available options (for shell completion, etc).
  77. _options = [];
  78. Object.keys(grunt.cli.optlist).forEach(function(long) {
  79. var o = grunt.cli.optlist[long];
  80. _options.push('--' + (o.negate ? 'no-' : '') + long);
  81. if (o.short) { _options.push('-' + o.short); }
  82. });
  83. verbose.writeln('Available options: ' + _options.join(' '));
  84. }
  85. return;
  86. }
  87. // Init colors.
  88. log.initColors();
  89. // Display help and quit if the user did --help.
  90. if (option('help')) {
  91. help.display();
  92. return;
  93. }
  94. // A little header stuff.
  95. verbose.header('Initializing').writeflags(option.flags(), 'Command-line options');
  96. // Determine and output which tasks will be run.
  97. var tasksSpecified = tasks && tasks.length > 0;
  98. tasks = task.parseArgs([tasksSpecified ? tasks : 'default']);
  99. // Initialize tasks.
  100. task.init(tasks);
  101. verbose.writeln();
  102. if (!tasksSpecified) {
  103. verbose.writeln('No tasks specified, running default tasks.');
  104. }
  105. verbose.writeflags(tasks, 'Running tasks');
  106. // Report, etc when all tasks have completed.
  107. task.options({
  108. error: function(e) {
  109. fail.warn(e, fail.code.TASK_FAILURE);
  110. },
  111. done: function() {
  112. // Output a final fail / success report.
  113. fail.report();
  114. if (done) {
  115. // Execute "done" function when done (only if passed, of course).
  116. done();
  117. } else {
  118. // Otherwise, explicitly exit.
  119. util.exit(0);
  120. }
  121. }
  122. });
  123. // Execute all tasks, in order. Passing each task individually in a forEach
  124. // allows the error callback to execute multiple times.
  125. tasks.forEach(function(name) { task.run(name); });
  126. task.start();
  127. };