diff options
| -rw-r--r-- | packages/gitbook/src/models/readme.js | 16 | ||||
| -rw-r--r-- | packages/gitbook/src/parse/__tests__/parseReadme.js | 2 | ||||
| -rw-r--r-- | packages/gitbook/src/parse/__tests__/readmeFromDocument.js | 24 | ||||
| -rw-r--r-- | packages/gitbook/src/parse/parseReadme.js | 11 | ||||
| -rw-r--r-- | packages/gitbook/src/parse/readmeFromDocument.js | 21 |
5 files changed, 5 insertions, 69 deletions
diff --git a/packages/gitbook/src/models/readme.js b/packages/gitbook/src/models/readme.js index 59eea22..5b7654e 100644 --- a/packages/gitbook/src/models/readme.js +++ b/packages/gitbook/src/models/readme.js @@ -2,9 +2,7 @@ const { Record } = require('immutable'); const File = require('./file'); const DEFAULTS = { - file: new File(), - title: String(), - description: String() + file: new File() }; class Readme extends Record(DEFAULTS) { @@ -12,14 +10,6 @@ class Readme extends Record(DEFAULTS) { return this.get('file'); } - getTitle() { - return this.get('title'); - } - - getDescription() { - return this.get('description'); - } - /** * Set file linked to the readme. * @param {File} file @@ -32,7 +22,6 @@ class Readme extends Record(DEFAULTS) { /** * Create a new readme * - * @param {File} file * @param {Object} def * @return {Readme} */ @@ -40,8 +29,7 @@ class Readme extends Record(DEFAULTS) { def = def || {}; return new Readme({ - title: def.title || '', - description: def.description || '' + file: def.file || '' }); } } diff --git a/packages/gitbook/src/parse/__tests__/parseReadme.js b/packages/gitbook/src/parse/__tests__/parseReadme.js index 77207a2..4cd105c 100644 --- a/packages/gitbook/src/parse/__tests__/parseReadme.js +++ b/packages/gitbook/src/parse/__tests__/parseReadme.js @@ -16,8 +16,6 @@ describe('parseReadme', () => { const file = readme.getFile(); expect(file.exists()).toBeTruthy(); - expect(readme.title).toBe('Hello'); - expect(readme.description).toBe('And here is the description.'); }); }); diff --git a/packages/gitbook/src/parse/__tests__/readmeFromDocument.js b/packages/gitbook/src/parse/__tests__/readmeFromDocument.js deleted file mode 100644 index 6027fe5..0000000 --- a/packages/gitbook/src/parse/__tests__/readmeFromDocument.js +++ /dev/null @@ -1,24 +0,0 @@ -const expect = require('expect'); -const readDocument = require('./utils/readDocument'); -const readmeFromDocument = require('../readmeFromDocument'); - -function readReadme(filename) { - const document = readDocument(filename); - return readmeFromDocument(document); -} - -describe('readmeFromDocument', () => { - - it('should parse only title', () => { - const readme = readReadme('readme/only-title.yaml'); - expect(readme.title).toBe('Hello World'); - expect(readme.description).toBe(''); - }); - - it('should parse title and description', () => { - const readme = readReadme('readme/normal.yaml'); - expect(readme.title).toBe('Hello World'); - expect(readme.description).toBe('This is a description'); - }); - -}); diff --git a/packages/gitbook/src/parse/parseReadme.js b/packages/gitbook/src/parse/parseReadme.js index ce5cd82..0cf4d3a 100644 --- a/packages/gitbook/src/parse/parseReadme.js +++ b/packages/gitbook/src/parse/parseReadme.js @@ -1,5 +1,5 @@ const lookupStructureFile = require('./lookupStructureFile'); -const readmeFromDocument = require('./readmeFromDocument'); +const Readme = require('../models/readme'); const error = require('../utils/error'); /** @@ -10,7 +10,6 @@ const error = require('../utils/error'); */ function parseReadme(book) { const { logger } = book; - const fs = book.getContentFS(); return lookupStructureFile(book, 'readme') .then((file) => { @@ -19,12 +18,8 @@ function parseReadme(book) { } logger.debug.ln(`readme found at ${file.path}`); - return file.parse(fs) - .then((document) => { - let readme = readmeFromDocument(document); - readme = readme.setFile(file); - return book.set('readme', readme); - }); + + return book.set('readme', Readme.create({ file })); }); } diff --git a/packages/gitbook/src/parse/readmeFromDocument.js b/packages/gitbook/src/parse/readmeFromDocument.js deleted file mode 100644 index a1f67b8..0000000 --- a/packages/gitbook/src/parse/readmeFromDocument.js +++ /dev/null @@ -1,21 +0,0 @@ -const { BLOCKS } = require('markup-it'); -const Readme = require('../models/readme'); - -/** - * Parse a readme from a document. - * @param {Document} document - * @return {Readme} readme - */ -function readmeFromDocument(document) { - const { nodes } = document; - - const first = nodes.first(); - const second = nodes.get(1); - - return Readme.create({ - title: first && first.type == BLOCKS.HEADING_1 ? first.text : '', - description: second && second.type == BLOCKS.PARAGRAPH ? second.text : '' - }); -} - -module.exports = readmeFromDocument; |