docs/config/processors/versions-data.js


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

var _ = require('lodash');

module.exports = {
  name: 'versions-data',
  description: 'This plugin will create a new doc that will be rendered as an angularjs module ' +
               'which will contain meta information about the versions of angular',
  runAfter: ['adding-extra-docs', 'pages-data'],
  runBefore: ['extra-docs-added'],
  process: function(docs, gitData) {

    var version = gitData.version;
    var versions = gitData.versions;

    if ( !version ) {
      throw new Error('Invalid configuration.  Please provide a valid `source.currentVersion` property');
    }
    if ( !versions ) {
      throw new Error('Invalid configuration.  Please provide a valid `source.previousVersions` property');
    }

    var versionDoc = {
      docType: 'versions-data',
      id: 'versions-data',
      template: 'versions-data.template.js',
      outputPath: 'js/versions-data.js',
    };

    versionDoc.currentVersion = version;

    versionDoc.versions = _(versions)
      .filter(function(version) { return version.major > 0; })
      .push(version)
      .reverse()
      .value();

    docs.push(versionDoc);
  }
};