From 0b35521d8ffe9ff851c49801900381ec043962f0 Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Thu, 13 Feb 2014 21:50:13 +0000 Subject: chore(doc-gen): move git info into its own processor --- docs/config/processors/git-data.js | 17 +++++++++++++++++ docs/config/processors/versions-data.js | 12 ++++-------- 2 files changed, 21 insertions(+), 8 deletions(-) create mode 100644 docs/config/processors/git-data.js (limited to 'docs/config/processors') diff --git a/docs/config/processors/git-data.js b/docs/config/processors/git-data.js new file mode 100644 index 00000000..229864bb --- /dev/null +++ b/docs/config/processors/git-data.js @@ -0,0 +1,17 @@ +var gruntUtils = require('../../../lib/grunt/utils'); + +module.exports = { + name: 'git-data', + runBefore: ['loading-files'], + description: 'This processor adds information from the local git repository to the extraData injectable', + init: function(config, injectables) { + injectables.value('gitData', { + version: gruntUtils.getVersion(), + versions: gruntUtils.getPreviousVersions(), + info: gruntUtils.getGitRepoInfo() + }); + }, + process: function(extraData, gitData) { + extraData.git = gitData; + } +}; \ No newline at end of file diff --git a/docs/config/processors/versions-data.js b/docs/config/processors/versions-data.js index eb158e79..14357fd7 100644 --- a/docs/config/processors/versions-data.js +++ b/docs/config/processors/versions-data.js @@ -1,17 +1,15 @@ var _ = require('lodash'); -var version; -var versions; - 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'], - init: function(config) { - version = config.source.currentVersion; - versions = config.source.previousVersions; + 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'); @@ -19,8 +17,6 @@ module.exports = { if ( !versions ) { throw new Error('Invalid configuration. Please provide a valid `source.previousVersions` property'); } - }, - process: function(docs) { var versionDoc = { docType: 'versions-data', -- cgit v1.2.3