1. module gulp-todo
   1. function gulp-todo (options)
   2. function gulp-todo.reporter (reporter, options)

module gulp-todo

function gulp-todo (options)

• description and source-code

  gulp-todo = function (options) {
      options = defaults(options || {}, {
          fileName: 'TODO.md',
          verbose: false,
          absolute: false,
          skipUnsupported: false,
          reporter: 'markdown'
      });
      var config = omit(options, ['fileName', 'verbose', 'absolute']);
      var firstFile;
      var comments = [];
  
      return through.obj(function collectTodos(file, enc, cb) {
              if (file.isNull()) {
                  cb(null, file);
                  return;
              }
  
              if (file.isStream()) {
                  cb(new PluginError(pluginName, 'Streaming not supported'));
                  return;
              }
              firstFile = firstFile || file;
              //get extension - assume .js as default
              var ext = path.extname(file.path) || '.js';
              //check if parser for filetype exists
              if (!leasot.isExtSupported(ext)) {
                  if (!options.skipUnsupported) {
                      var msg = ['File:', file.path, '- Extension', gutil.colors.red(ext),
                          'is not supported'
                      ].join(' ');
                      cb(new PluginError(pluginName, msg));
                      return;
                  } else if (options.verbose) {
                      var msg = ['Skipping file', file.path, 'with extension',
                                      gutil.colors.red(ext), 'as it is unsupported'].join(' ');
                      gutil.log(msg);
                  }
                  cb();
                  return;
              }
              var filePath;
              if (options.absolute) {
                  filePath = file.path;
              } else {
                  filePath = file.path && file.relative || file.path;
              }
              var _comments = leasot.parse({
                  ext: ext,
                  content: file.contents.toString('utf8'),
                  fileName: filePath,
                  customTags: config.customTags,
                  withInlineFiles: config.withInlineFiles
              });
              if (options.verbose) {
                  logCommentsToConsole(_comments);
              }
              comments = comments.concat(_comments);
              cb();
          },
          function reportTodos(cb) {
              if (!firstFile) {
                  cb();
                  return;
              }
              var newContents;
              try {
                  newContents = leasot.reporter(comments, config);
              } catch (e) {
                  cb(new gutil.PluginError(pluginName, e));
                  return;
              }
  
              var todoFile = new gutil.File({
                  cwd: firstFile.cwd,
                  base: firstFile.base,
                  path: path.join(firstFile.base, options.fileName),
                  contents: new Buffer(newContents)
              });
              // also pass along comments object for future reporters
              todoFile.todos = comments;
              this.push(todoFile);
              cb();
          });
  }

• example usage

  n/a

function gulp-todo.reporter (reporter, options)

• description and source-code

  reporter = function (reporter, options) {
      options = options || {};
      if (!reporter) {
          throw new PluginError('Reporter is required');
      }
      options.reporter = reporter;
      var fileName = options.fileName;
      delete options.fileName;
      return through.obj(function (file, enc, cb) {
          if (file.isNull()) {
              cb(null, file);
              return;
          }
  
          if (file.isStream()) {
              cb(new PluginError(pluginName, 'Streaming not supported'));
              return;
          }
  
          // replace contents with requested reporter contents
          if (file.todos && file.todos.length) {
              var newContents;
              try {
                  newContents = leasot.reporter(file.todos, options);
              } catch (e) {
                  cb(new gutil.PluginError(pluginName, e));
                  return;
              }
  
              if (fileName) {
                  file.path = path.join(file.base, fileName);
              }
              file.contents = new Buffer(newContents);
          }
  
          cb(null, file);
      });
  }

• example usage

  ...
  });
  
  // output once in markdown and then output a json file as well
  gulp.task('todo-reporters', function() {
      gulp.src('js/**/*.js')
          .pipe(todo())
          .pipe(gulp.dest('./')) //output todo.md as markdown
          .pipe(todo.reporter('json', {fileName: 'todo.json'}))
          .pipe(gulp.dest('./')) //output todo.json as json
  });
  
  
  // Delete the todo.md file if no todos were found
  var gulpIf = require('gulp-if');
  var del = require('del');
  ...