|
| 1 | +var path = require('canonical-path'); |
| 2 | +var log = require('winston'); |
| 3 | +var _ = require('lodash'); |
| 4 | + |
| 5 | +var currentVersion; |
| 6 | +var contentsFolder; |
| 7 | +module.exports = { |
| 8 | + name: 'demos', |
| 9 | + runAfter: ['api-docs'], |
| 10 | + runBefore: ['index-page'], |
| 11 | + description: 'Create demos', |
| 12 | + init: function(config) { |
| 13 | + currentVersion = config.get('currentVersion'); |
| 14 | + contentsFolder = config.get('rendering.contentsFolder'); |
| 15 | + }, |
| 16 | + process: function(docs, config, extraData) { |
| 17 | + var demoTags = [ |
| 18 | + 'javascript', |
| 19 | + 'html', |
| 20 | + 'css', |
| 21 | + 'spec', |
| 22 | + 'scenario' |
| 23 | + ]; |
| 24 | + var extensions = { |
| 25 | + javascript: 'js', |
| 26 | + html: 'html', |
| 27 | + css: 'css', |
| 28 | + spec: 'js', |
| 29 | + scenario: 'js' |
| 30 | + }; |
| 31 | + |
| 32 | + var demoFolder = path.join(config.get('versionData.current.folder'), |
| 33 | + '${docType}/${name}'); |
| 34 | + var demoPath = '${name}/${filename}.${extension}'; |
| 35 | + var templatePath = 'demo/${filename}.template.${extension}'; |
| 36 | + |
| 37 | + var allDemos = []; |
| 38 | + _(docs) |
| 39 | + .filter(function(doc) { return doc.demos; }) |
| 40 | + .forEach(function(doc) { |
| 41 | + var outputFolder = _.template(demoFolder,doc); |
| 42 | + |
| 43 | + doc.demos.forEach(function(demo) { |
| 44 | + var demoData = {}; |
| 45 | + allDemos.push(demoData); |
| 46 | + |
| 47 | + var outputFolder = _.template(demoFolder, doc); |
| 48 | + demoData.module = demo.module; |
| 49 | + demoData.name = demo.name; |
| 50 | + demoData.docName = doc.name; |
| 51 | + demoData.href = '/' + outputFolder + '/' + demo.name; |
| 52 | + |
| 53 | + demoTags.forEach(function(tagName) { |
| 54 | + var data = demo.tags.tagsByName[tagName]; |
| 55 | + |
| 56 | + if (data && data.length) { |
| 57 | + var content = data.map(function(d) { |
| 58 | + return d.description; |
| 59 | + }).join('\n'); |
| 60 | + var filename = tagName; |
| 61 | + var ext = extensions[tagName]; |
| 62 | + var outputPath = outputFolder + '/' + _.template(demoPath, { |
| 63 | + name: demo.name, |
| 64 | + filename: filename, |
| 65 | + extension: ext |
| 66 | + }); |
| 67 | + var template = _.template(templatePath, { |
| 68 | + filename: filename, |
| 69 | + extension: ext |
| 70 | + }); |
| 71 | + |
| 72 | + demoData[tagName] = { |
| 73 | + path: outputPath, |
| 74 | + content: content |
| 75 | + }; |
| 76 | + |
| 77 | + //Write all the files for this demo (html, css, js) |
| 78 | + docs.push({ |
| 79 | + docType: 'demo', |
| 80 | + id: doc.name + '/' + demo.name, |
| 81 | + outputPath: config.get('demos.outputFolder') + '/' + outputPath, |
| 82 | + template: template, |
| 83 | + contents: content |
| 84 | + }); |
| 85 | + } |
| 86 | + |
| 87 | + }); |
| 88 | + var outputPath = outputFolder + '/' + _.template(demoPath, { |
| 89 | + name: demo.name, |
| 90 | + filename: 'index', |
| 91 | + extension: 'html' |
| 92 | + }); |
| 93 | + |
| 94 | + //Write this specific demo's index page |
| 95 | + docs.push({ |
| 96 | + docType: 'demo', |
| 97 | + outputPath: path.join(config.get('demos.outputFolder'), outputPath), |
| 98 | + template: 'demo_index.template.html', |
| 99 | + demoData: demoData, |
| 100 | + name: doc.name |
| 101 | + }); |
| 102 | + }); |
| 103 | + }) |
| 104 | + .value(); |
| 105 | + |
| 106 | + //Write the demo page for this whole version (eg at /nightly) |
| 107 | + docs.push({ |
| 108 | + docType: 'demo', |
| 109 | + template: 'demo_index.template.html', |
| 110 | + outputPath: path.join( |
| 111 | + config.get('demos.outputFolder'), |
| 112 | + config.get('versionData.current.folder'), |
| 113 | + 'index.html' |
| 114 | + ) |
| 115 | + }); |
| 116 | + |
| 117 | + extraData.demos = allDemos; |
| 118 | + } |
| 119 | +}; |
0 commit comments