summaryrefslogtreecommitdiffstats
path: root/lib/parse/parseSummary.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/parse/parseSummary.js')
-rw-r--r--lib/parse/parseSummary.js44
1 files changed, 0 insertions, 44 deletions
diff --git a/lib/parse/parseSummary.js b/lib/parse/parseSummary.js
deleted file mode 100644
index 2c1e3b3..0000000
--- a/lib/parse/parseSummary.js
+++ /dev/null
@@ -1,44 +0,0 @@
-var parseStructureFile = require('./parseStructureFile');
-var Summary = require('../models/summary');
-var SummaryModifier = require('../modifiers').Summary;
-
-/**
- Parse summary in a book, the summary can only be parsed
- if the readme as be detected before.
-
- @param {Book} book
- @return {Promise<Book>}
-*/
-function parseSummary(book) {
- var readme = book.getReadme();
- var logger = book.getLogger();
- var readmeFile = readme.getFile();
-
- return parseStructureFile(book, 'summary')
- .spread(function(file, result) {
- var summary;
-
- if (!file) {
- logger.warn.ln('no summary file in this book');
- summary = Summary();
- } else {
- logger.debug.ln('summary file found at', file.getPath());
- summary = Summary.createFromParts(file, result.parts);
- }
-
- // Insert readme as first entry if not in SUMMARY.md
- var readmeArticle = summary.getByPath(readmeFile.getPath());
-
- if (readmeFile.exists() && !readmeArticle) {
- summary = SummaryModifier.unshiftArticle(summary, {
- title: 'Introduction',
- ref: readmeFile.getPath()
- });
- }
-
- // Set new summary
- return book.setSummary(summary);
- });
-}
-
-module.exports = parseSummary;