mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-27 20:48:47 +00:00
Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ebe845d46c | |||
| edee8d2fc5 | |||
| 5f3de0876f | |||
| 2ceab04d01 | |||
| de37de44e8 | |||
| ccb87d5a13 | |||
| e2e0ca3f05 | |||
| b33a79704b | |||
| 6def174b84 | |||
| 346a18b444 | |||
| b32685c698 | |||
| 09b3618da8 | |||
| 901328f247 | |||
| b47ebaa9d9 | |||
| 465e8d6c0a | |||
| ecd86ec877 | |||
| 5d7864154c | |||
| 7b915428f7 |
@@ -2,6 +2,12 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
This project adheres to [Semantic Versioning](http://semver.org/).
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
||||||
|
|
||||||
|
## 3.0.3
|
||||||
|
- Fix redirection in `gitbook serve` when accessing a folder without trailing slash
|
||||||
|
- Fix links/annotations for glossary not being correctly resolved
|
||||||
|
- Fix regression for supporting uppercase filenames in structure files
|
||||||
|
- Fix `gitbook install` when using Git URLs for plugins
|
||||||
|
|
||||||
## 3.0.2
|
## 3.0.2
|
||||||
- Fix crash for anchor links
|
- Fix crash for anchor links
|
||||||
|
|
||||||
|
|||||||
+21
-2
@@ -71,11 +71,18 @@ Server.prototype.start = function(dir, port) {
|
|||||||
|
|
||||||
// Redirect to directory's index.html
|
// Redirect to directory's index.html
|
||||||
function redirect() {
|
function redirect() {
|
||||||
|
var resultURL = urlTransform(req.url, function(parsed) {
|
||||||
|
parsed.pathname += '/';
|
||||||
|
return parsed;
|
||||||
|
});
|
||||||
|
|
||||||
res.statusCode = 301;
|
res.statusCode = 301;
|
||||||
res.setHeader('Location', req.url + '/');
|
res.setHeader('Location', resultURL);
|
||||||
res.end('Redirecting to ' + req.url + '/');
|
res.end('Redirecting to ' + resultURL);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
res.setHeader('X-Current-Location', req.url);
|
||||||
|
|
||||||
// Send file
|
// Send file
|
||||||
send(req, url.parse(req.url).pathname, {
|
send(req, url.parse(req.url).pathname, {
|
||||||
root: dir
|
root: dir
|
||||||
@@ -106,4 +113,16 @@ Server.prototype.start = function(dir, port) {
|
|||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
urlTransform is a helper function that allows a function to transform
|
||||||
|
a url string in it's parsed form and returns the new url as a string
|
||||||
|
|
||||||
|
@param {String} uri
|
||||||
|
@param {Function} fn
|
||||||
|
@return {String}
|
||||||
|
*/
|
||||||
|
function urlTransform(uri, fn) {
|
||||||
|
return url.format(fn(url.parse(uri)));
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = Server;
|
module.exports = Server;
|
||||||
|
|||||||
@@ -22,6 +22,16 @@ describe('configSchema', function() {
|
|||||||
expect(result.errors.length).toBe(0);
|
expect(result.errors.length).toBe(0);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should accept uppercase in filename', function() {
|
||||||
|
var result = validate({
|
||||||
|
structure: {
|
||||||
|
readme: 'BOOK.adoc'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result.errors.length).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
it('should not accept filepath', function() {
|
it('should not accept filepath', function() {
|
||||||
var result = validate({
|
var result = validate({
|
||||||
structure: {
|
structure: {
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
var FILENAME_REGEX = '^[a-z-._\d,\s]+$';
|
var FILENAME_REGEX = '^[a-zA-Z-._\d,\s]+$';
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
'$schema': 'http://json-schema.org/schema#',
|
'$schema': 'http://json-schema.org/schema#',
|
||||||
|
|||||||
@@ -42,21 +42,39 @@ describe('PluginDependency', function() {
|
|||||||
expect(plugin.getVersion()).toBe('git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
|
expect(plugin.getVersion()).toBe('git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
|
||||||
|
|
||||||
describe('listToArray', function() {
|
describe('listToArray', function() {
|
||||||
var list = PluginDependency.listToArray(Immutable.List([
|
it('must create an array from a list of plugin dependencies', function() {
|
||||||
PluginDependency.createFromString('hello@1.0.0'),
|
var list = PluginDependency.listToArray(Immutable.List([
|
||||||
PluginDependency.createFromString('noversion'),
|
PluginDependency.createFromString('hello@1.0.0'),
|
||||||
PluginDependency.createFromString('-disabled')
|
PluginDependency.createFromString('noversion'),
|
||||||
]));
|
PluginDependency.createFromString('-disabled')
|
||||||
|
]));
|
||||||
|
|
||||||
expect(list).toEqual([
|
expect(list).toEqual([
|
||||||
'hello@1.0.0',
|
'hello@1.0.0',
|
||||||
'noversion',
|
'noversion',
|
||||||
'-disabled'
|
'-disabled'
|
||||||
]);
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('listFromArray', function() {
|
||||||
|
it('must create an array from a list of plugin dependencies', function() {
|
||||||
|
var arr = Immutable.fromJS([
|
||||||
|
'hello@1.0.0',
|
||||||
|
{
|
||||||
|
'name': 'plugin-ga',
|
||||||
|
'version': 'git+ssh://samy@github.com/GitbookIO/plugin-ga.git'
|
||||||
|
}
|
||||||
|
]);
|
||||||
|
var list = PluginDependency.listFromArray(arr);
|
||||||
|
|
||||||
|
expect(list.first().getName()).toBe('hello');
|
||||||
|
expect(list.first().getVersion()).toBe('1.0.0');
|
||||||
|
expect(list.last().getName()).toBe('plugin-ga');
|
||||||
|
expect(list.last().getVersion()).toBe('git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+4
-11
@@ -1,9 +1,10 @@
|
|||||||
var Immutable = require('immutable');
|
var Immutable = require('immutable');
|
||||||
|
|
||||||
var TemplateBlock = require('./templateBlock');
|
var TemplateBlock = require('./templateBlock');
|
||||||
var PREFIX = require('../constants/pluginPrefix');
|
|
||||||
var DEFAULT_VERSION = '*';
|
var DEFAULT_VERSION = '*';
|
||||||
|
|
||||||
|
var PluginDependency = require('./pluginDependency');
|
||||||
|
|
||||||
var Plugin = Immutable.Record({
|
var Plugin = Immutable.Record({
|
||||||
name: String(),
|
name: String(),
|
||||||
|
|
||||||
@@ -53,7 +54,7 @@ Plugin.prototype.getDepth = function() {
|
|||||||
@return {String}
|
@return {String}
|
||||||
*/
|
*/
|
||||||
Plugin.prototype.getNpmID = function() {
|
Plugin.prototype.getNpmID = function() {
|
||||||
return Plugin.nameToNpmID(this.getName());
|
return PluginDependency.nameToNpmID(this.getName());
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -152,14 +153,6 @@ Plugin.createFromDep = function(dep) {
|
|||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
Plugin.nameToNpmID = PluginDependency.nameToNpmID;
|
||||||
Return NPM id for a plugin name
|
|
||||||
|
|
||||||
@param {String}
|
|
||||||
@return {String}
|
|
||||||
*/
|
|
||||||
Plugin.nameToNpmID = function(s) {
|
|
||||||
return PREFIX + s;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports = Plugin;
|
module.exports = Plugin;
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
var is = require('is');
|
var is = require('is');
|
||||||
|
var semver = require('semver');
|
||||||
var Immutable = require('immutable');
|
var Immutable = require('immutable');
|
||||||
|
|
||||||
|
var PREFIX = require('../constants/pluginPrefix');
|
||||||
var DEFAULT_VERSION = '*';
|
var DEFAULT_VERSION = '*';
|
||||||
|
|
||||||
/*
|
/*
|
||||||
@@ -29,6 +31,24 @@ PluginDependency.prototype.isEnabled = function() {
|
|||||||
return this.get('enabled');
|
return this.get('enabled');
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
Return NPM ID for the dependency
|
||||||
|
|
||||||
|
@return {String}
|
||||||
|
*/
|
||||||
|
PluginDependency.prototype.getNpmID = function() {
|
||||||
|
return PluginDependency.nameToNpmID(this.getName());
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
Is the plugin using a git dependency
|
||||||
|
|
||||||
|
@return {Boolean}
|
||||||
|
*/
|
||||||
|
PluginDependency.prototype.isGitDependency = function() {
|
||||||
|
return !semver.validRange(this.getVersion());
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Create a plugin with a name and a plugin
|
Create a plugin with a name and a plugin
|
||||||
|
|
||||||
@@ -95,8 +115,8 @@ PluginDependency.listFromArray = function(arr) {
|
|||||||
return PluginDependency.createFromString(entry);
|
return PluginDependency.createFromString(entry);
|
||||||
} else {
|
} else {
|
||||||
return PluginDependency({
|
return PluginDependency({
|
||||||
name: entry.name,
|
name: entry.get('name'),
|
||||||
version: entry.version
|
version: entry.get('version')
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -130,4 +150,14 @@ PluginDependency.listToArray = function(list) {
|
|||||||
.toJS();
|
.toJS();
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
Return NPM id for a plugin name
|
||||||
|
|
||||||
|
@param {String}
|
||||||
|
@return {String}
|
||||||
|
*/
|
||||||
|
PluginDependency.nameToNpmID = function(s) {
|
||||||
|
return PREFIX + s;
|
||||||
|
};
|
||||||
|
|
||||||
module.exports = PluginDependency;
|
module.exports = PluginDependency;
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
var fs = require('fs');
|
||||||
var generateMock = require('../generateMock');
|
var generateMock = require('../generateMock');
|
||||||
var WebsiteGenerator = require('../website');
|
var WebsiteGenerator = require('../website');
|
||||||
|
|
||||||
@@ -12,6 +13,54 @@ describe('WebsiteGenerator', function() {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('Glossary', function() {
|
||||||
|
var folder;
|
||||||
|
|
||||||
|
before(function() {
|
||||||
|
return generateMock(WebsiteGenerator, {
|
||||||
|
'README.md': 'Hello World',
|
||||||
|
'SUMMARY.md': '* [Deep](folder/page.md)',
|
||||||
|
'folder': {
|
||||||
|
'page.md': 'Hello World'
|
||||||
|
},
|
||||||
|
'GLOSSARY.md': '# Glossary\n\n## Hello\n\nHello World'
|
||||||
|
})
|
||||||
|
.then(function(_folder) {
|
||||||
|
folder = _folder;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should generate a GLOSSARY.html', function() {
|
||||||
|
expect(folder).toHaveFile('GLOSSARY.html');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly resolve glossary links in README', function() {
|
||||||
|
var html = fs.readFileSync(folder + '/index.html', 'utf8');
|
||||||
|
expect(html).toHaveDOMElement('.page-inner a[href="GLOSSARY.html#hello"]');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly resolve glossary links in directory', function() {
|
||||||
|
var html = fs.readFileSync(folder + '/folder/page.html', 'utf8');
|
||||||
|
expect(html).toHaveDOMElement('.page-inner a[href="../GLOSSARY.html#hello"]');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should accept a custom glossary file', function() {
|
||||||
|
return generateMock(WebsiteGenerator, {
|
||||||
|
'README.md': 'Hello World',
|
||||||
|
'book.json': '{ "structure": { "glossary": "custom.md" } }',
|
||||||
|
'custom.md': '# Glossary\n\n## Hello\n\nHello World'
|
||||||
|
})
|
||||||
|
.then(function(folder) {
|
||||||
|
expect(folder).toHaveFile('custom.html');
|
||||||
|
expect(folder).toNotHaveFile('GLOSSARY.html');
|
||||||
|
|
||||||
|
var html = fs.readFileSync(folder + '/index.html', 'utf8');
|
||||||
|
expect(html).toHaveDOMElement('.page-inner a[href="custom.html#hello"]');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
it('should copy asset files', function() {
|
it('should copy asset files', function() {
|
||||||
return generateMock(WebsiteGenerator, {
|
return generateMock(WebsiteGenerator, {
|
||||||
'README.md': 'Hello World',
|
'README.md': 'Hello World',
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ var Api = require('../api');
|
|||||||
var Plugins = require('../plugins');
|
var Plugins = require('../plugins');
|
||||||
var Promise = require('../utils/promise');
|
var Promise = require('../utils/promise');
|
||||||
var defaultBlocks = require('../constants/defaultBlocks');
|
var defaultBlocks = require('../constants/defaultBlocks');
|
||||||
|
var fileToOutput = require('./helper/fileToOutput');
|
||||||
|
|
||||||
var CODEBLOCK = 'code';
|
var CODEBLOCK = 'code';
|
||||||
|
|
||||||
@@ -17,9 +18,13 @@ function getModifiers(output, page) {
|
|||||||
var book = output.getBook();
|
var book = output.getBook();
|
||||||
var plugins = output.getPlugins();
|
var plugins = output.getPlugins();
|
||||||
var glossary = book.getGlossary();
|
var glossary = book.getGlossary();
|
||||||
var entries = glossary.getEntries();
|
|
||||||
var file = page.getFile();
|
var file = page.getFile();
|
||||||
|
|
||||||
|
// Glossary entries
|
||||||
|
var entries = glossary.getEntries();
|
||||||
|
var glossaryFile = glossary.getFile();
|
||||||
|
var glossaryFilename = fileToOutput(output, glossaryFile.getPath());
|
||||||
|
|
||||||
// Current file path
|
// Current file path
|
||||||
var currentFilePath = file.getPath();
|
var currentFilePath = file.getPath();
|
||||||
|
|
||||||
@@ -34,18 +39,18 @@ function getModifiers(output, page) {
|
|||||||
// Normalize IDs on headings
|
// Normalize IDs on headings
|
||||||
Modifiers.addHeadingId,
|
Modifiers.addHeadingId,
|
||||||
|
|
||||||
|
// Annotate text with glossary entries
|
||||||
|
Modifiers.annotateText.bind(null, entries, glossaryFilename),
|
||||||
|
|
||||||
|
// Resolve images
|
||||||
|
Modifiers.resolveImages.bind(null, currentFilePath),
|
||||||
|
|
||||||
// Resolve links (.md -> .html)
|
// Resolve links (.md -> .html)
|
||||||
Modifiers.resolveLinks.bind(null,
|
Modifiers.resolveLinks.bind(null,
|
||||||
currentFilePath,
|
currentFilePath,
|
||||||
resolveFileToURL.bind(null, output)
|
resolveFileToURL.bind(null, output)
|
||||||
),
|
),
|
||||||
|
|
||||||
// Resolve images
|
|
||||||
Modifiers.resolveImages.bind(null, currentFilePath),
|
|
||||||
|
|
||||||
// Annotate text with glossary entries
|
|
||||||
Modifiers.annotateText.bind(null, entries),
|
|
||||||
|
|
||||||
// Highlight code blocks using "code" block
|
// Highlight code blocks using "code" block
|
||||||
Modifiers.highlightCode.bind(null, function(lang, source) {
|
Modifiers.highlightCode.bind(null, function(lang, source) {
|
||||||
return Promise(code.applyBlock({
|
return Promise(code.applyBlock({
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ describe('annotateText', function() {
|
|||||||
it('should annotate text', function() {
|
it('should annotate text', function() {
|
||||||
var $ = cheerio.load('<p>This is a word, and multiple words</p>');
|
var $ = cheerio.load('<p>This is a word, and multiple words</p>');
|
||||||
|
|
||||||
annotateText(entries, $);
|
annotateText(entries, 'GLOSSARY.md', $);
|
||||||
|
|
||||||
var links = $('a');
|
var links = $('a');
|
||||||
expect(links.length).toBe(2);
|
expect(links.length).toBe(2);
|
||||||
@@ -31,14 +31,14 @@ describe('annotateText', function() {
|
|||||||
it('should not annotate scripts', function() {
|
it('should not annotate scripts', function() {
|
||||||
var $ = cheerio.load('<script>This is a word, and multiple words</script>');
|
var $ = cheerio.load('<script>This is a word, and multiple words</script>');
|
||||||
|
|
||||||
annotateText(entries, $);
|
annotateText(entries, 'GLOSSARY.md', $);
|
||||||
expect($('a').length).toBe(0);
|
expect($('a').length).toBe(0);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should not annotate when has class "no-glossary"', function() {
|
it('should not annotate when has class "no-glossary"', function() {
|
||||||
var $ = cheerio.load('<p class="no-glossary">This is a word, and multiple words</p>');
|
var $ = cheerio.load('<p class="no-glossary">This is a word, and multiple words</p>');
|
||||||
|
|
||||||
annotateText(entries, $);
|
annotateText(entries, 'GLOSSARY.md', $);
|
||||||
expect($('a').length).toBe(0);
|
expect($('a').length).toBe(0);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -62,9 +62,10 @@ function replaceText($, el, search, replace, text_only ) {
|
|||||||
Annotate text using a list of GlossaryEntry
|
Annotate text using a list of GlossaryEntry
|
||||||
|
|
||||||
@param {List<GlossaryEntry>}
|
@param {List<GlossaryEntry>}
|
||||||
|
@param {String} glossaryFilePath
|
||||||
@param {HTMLDom} $
|
@param {HTMLDom} $
|
||||||
*/
|
*/
|
||||||
function annotateText(entries, $) {
|
function annotateText(entries, glossaryFilePath, $) {
|
||||||
entries.forEach(function(entry) {
|
entries.forEach(function(entry) {
|
||||||
var entryId = entry.getID();
|
var entryId = entry.getID();
|
||||||
var name = entry.getName();
|
var name = entry.getName();
|
||||||
@@ -81,7 +82,7 @@ function annotateText(entries, $) {
|
|||||||
) return;
|
) return;
|
||||||
|
|
||||||
replaceText($, this, searchRegex, function(match) {
|
replaceText($, this, searchRegex, function(match) {
|
||||||
return '<a href="/GLOSSARY.md#' + entryId + '" '
|
return '<a href="/' + glossaryFilePath + '#' + entryId + '" '
|
||||||
+ 'class="glossary-term" title="' + escape(description) + '">'
|
+ 'class="glossary-term" title="' + escape(description) + '">'
|
||||||
+ match
|
+ match
|
||||||
+ '</a>';
|
+ '</a>';
|
||||||
|
|||||||
+41
-10
@@ -5,6 +5,25 @@ var Page = require('../models/page');
|
|||||||
var walkSummary = require('./walkSummary');
|
var walkSummary = require('./walkSummary');
|
||||||
var parsePage = require('./parsePage');
|
var parsePage = require('./parsePage');
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
Parse a page from a path
|
||||||
|
|
||||||
|
@param {Book} book
|
||||||
|
@param {String} filePath
|
||||||
|
@return {Page}
|
||||||
|
*/
|
||||||
|
function parseFilePage(book, filePath) {
|
||||||
|
var fs = book.getContentFS();
|
||||||
|
|
||||||
|
return fs.statFile(filePath)
|
||||||
|
.then(function(file) {
|
||||||
|
var page = Page.createForFile(file);
|
||||||
|
return parsePage(book, page);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Parse all pages from a book as an OrderedMap
|
Parse all pages from a book as an OrderedMap
|
||||||
|
|
||||||
@@ -12,10 +31,11 @@ var parsePage = require('./parsePage');
|
|||||||
@return {Promise<OrderedMap<Page>>}
|
@return {Promise<OrderedMap<Page>>}
|
||||||
*/
|
*/
|
||||||
function parsePagesList(book) {
|
function parsePagesList(book) {
|
||||||
var fs = book.getContentFS();
|
|
||||||
var summary = book.getSummary();
|
var summary = book.getSummary();
|
||||||
|
var glossary = book.getGlossary();
|
||||||
var map = Immutable.OrderedMap();
|
var map = Immutable.OrderedMap();
|
||||||
|
|
||||||
|
// Parse pages from summary
|
||||||
return timing.measure(
|
return timing.measure(
|
||||||
'parse.listPages',
|
'parse.listPages',
|
||||||
walkSummary(summary, function(article) {
|
walkSummary(summary, function(article) {
|
||||||
@@ -26,21 +46,32 @@ function parsePagesList(book) {
|
|||||||
// Is the page ignored?
|
// Is the page ignored?
|
||||||
if (book.isContentFileIgnored(filepath)) return;
|
if (book.isContentFileIgnored(filepath)) return;
|
||||||
|
|
||||||
return fs.statFile(filepath)
|
return parseFilePage(book, filepath)
|
||||||
.then(function(file) {
|
|
||||||
var page = Page.createForFile(file);
|
|
||||||
return parsePage(book, page);
|
|
||||||
})
|
|
||||||
.then(function(page) {
|
.then(function(page) {
|
||||||
map = map.set(filepath, page);
|
map = map.set(filepath, page);
|
||||||
}, function() {
|
}, function() {
|
||||||
// file doesn't exist
|
// file doesn't exist
|
||||||
});
|
});
|
||||||
})
|
})
|
||||||
.then(function() {
|
)
|
||||||
return map;
|
|
||||||
})
|
// Parse glossary
|
||||||
);
|
.then(function() {
|
||||||
|
var file = glossary.getFile();
|
||||||
|
|
||||||
|
if (!file.exists()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseFilePage(book, file.getPath())
|
||||||
|
.then(function(page) {
|
||||||
|
map = map.set(file.getPath(), page);
|
||||||
|
});
|
||||||
|
})
|
||||||
|
|
||||||
|
.then(function() {
|
||||||
|
return map;
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
var path = require('path');
|
||||||
|
|
||||||
|
var PluginDependency = require('../../models/pluginDependency');
|
||||||
|
var Book = require('../../models/book');
|
||||||
|
var NodeFS = require('../../fs/node');
|
||||||
|
var installPlugin = require('../installPlugin');
|
||||||
|
|
||||||
|
var Parse = require('../../parse');
|
||||||
|
|
||||||
|
describe('installPlugin', function() {
|
||||||
|
var book;
|
||||||
|
|
||||||
|
this.timeout(30000);
|
||||||
|
|
||||||
|
before(function() {
|
||||||
|
var fs = NodeFS(path.resolve(__dirname, '../../../'));
|
||||||
|
var baseBook = Book.createForFS(fs);
|
||||||
|
|
||||||
|
return Parse.parseConfig(baseBook)
|
||||||
|
.then(function(_book) {
|
||||||
|
book = _book;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('must install a plugin from NPM', function() {
|
||||||
|
var dep = PluginDependency.createFromString('ga');
|
||||||
|
return installPlugin(book, dep);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
var path = require('path');
|
||||||
|
|
||||||
|
var Book = require('../../models/book');
|
||||||
|
var NodeFS = require('../../fs/node');
|
||||||
|
var installPlugins = require('../installPlugins');
|
||||||
|
|
||||||
|
var Parse = require('../../parse');
|
||||||
|
|
||||||
|
describe('installPlugins', function() {
|
||||||
|
var book;
|
||||||
|
|
||||||
|
this.timeout(30000);
|
||||||
|
|
||||||
|
before(function() {
|
||||||
|
var fs = NodeFS(path.resolve(__dirname, '../../../'));
|
||||||
|
var baseBook = Book.createForFS(fs);
|
||||||
|
|
||||||
|
return Parse.parseConfig(baseBook)
|
||||||
|
.then(function(_book) {
|
||||||
|
book = _book;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('must install all plugins from NPM', function() {
|
||||||
|
return installPlugins(book)
|
||||||
|
.then(function(n) {
|
||||||
|
expect(n).toBe(2);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
var PluginDependency = require('../../models/pluginDependency');
|
||||||
|
var resolveVersion = require('../resolveVersion');
|
||||||
|
|
||||||
|
describe('resolveVersion', function() {
|
||||||
|
it('must skip resolving and return non-semver versions', function() {
|
||||||
|
var plugin = PluginDependency.createFromString('ga@git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
|
||||||
|
|
||||||
|
return resolveVersion(plugin)
|
||||||
|
.then(function(version) {
|
||||||
|
expect(version).toBe('git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('must resolve a normal plugin dependency', function() {
|
||||||
|
var plugin = PluginDependency.createFromString('ga@>0.9.0 < 1.0.1');
|
||||||
|
|
||||||
|
return resolveVersion(plugin)
|
||||||
|
.then(function(version) {
|
||||||
|
expect(version).toBe('1.0.0');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
var npmi = require('npmi');
|
||||||
|
|
||||||
|
var Promise = require('../utils/promise');
|
||||||
|
var resolveVersion = require('./resolveVersion');
|
||||||
|
|
||||||
|
/**
|
||||||
|
Install a plugin for a book
|
||||||
|
|
||||||
|
@param {Book}
|
||||||
|
@param {PluginDependency}
|
||||||
|
@return {Promise}
|
||||||
|
*/
|
||||||
|
function installPlugin(book, plugin) {
|
||||||
|
var logger = book.getLogger();
|
||||||
|
|
||||||
|
var installFolder = book.getRoot();
|
||||||
|
var name = plugin.getName();
|
||||||
|
var requirement = plugin.getVersion();
|
||||||
|
|
||||||
|
logger.info.ln('');
|
||||||
|
logger.info.ln('installing plugin "' + name + '"');
|
||||||
|
|
||||||
|
// Find a version to install
|
||||||
|
return resolveVersion(plugin)
|
||||||
|
.then(function(version) {
|
||||||
|
if (!version) {
|
||||||
|
throw new Error('Found no satisfactory version for plugin "' + name + '" with requirement "' + requirement + '"');
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.info.ln('install plugin "' + name +'" (' + requirement + ') from NPM with version', version);
|
||||||
|
return Promise.nfcall(npmi, {
|
||||||
|
'name': plugin.getNpmID(),
|
||||||
|
'version': version,
|
||||||
|
'path': installFolder,
|
||||||
|
'npmLoad': {
|
||||||
|
'loglevel': 'silent',
|
||||||
|
'loaded': true,
|
||||||
|
'prefix': installFolder
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.then(function() {
|
||||||
|
logger.info.ok('plugin "' + name + '" installed with success');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = installPlugin;
|
||||||
+12
-113
@@ -1,134 +1,32 @@
|
|||||||
var npm = require('npm');
|
|
||||||
var npmi = require('npmi');
|
var npmi = require('npmi');
|
||||||
var semver = require('semver');
|
|
||||||
var Immutable = require('immutable');
|
|
||||||
|
|
||||||
var pkg = require('../../package.json');
|
var pkg = require('../../package.json');
|
||||||
var DEFAULT_PLUGINS = require('../constants/defaultPlugins');
|
var DEFAULT_PLUGINS = require('../constants/defaultPlugins');
|
||||||
var Promise = require('../utils/promise');
|
var Promise = require('../utils/promise');
|
||||||
var Plugin = require('../models/plugin');
|
var installPlugin = require('./installPlugin');
|
||||||
var gitbook = require('../gitbook');
|
|
||||||
var listForBook = require('./listForBook');
|
|
||||||
|
|
||||||
var npmIsReady;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Initialize and prepare NPM
|
|
||||||
|
|
||||||
@return {Promise}
|
|
||||||
*/
|
|
||||||
function initNPM() {
|
|
||||||
if (npmIsReady) return npmIsReady;
|
|
||||||
|
|
||||||
npmIsReady = Promise.nfcall(npm.load, {
|
|
||||||
silent: true,
|
|
||||||
loglevel: 'silent'
|
|
||||||
});
|
|
||||||
|
|
||||||
return npmIsReady;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Resolve a plugin to a version
|
|
||||||
|
|
||||||
@param {Plugin}
|
|
||||||
@return {Promise<String>}
|
|
||||||
*/
|
|
||||||
function resolveVersion(plugin) {
|
|
||||||
var npmId = Plugin.nameToNpmID(plugin.getName());
|
|
||||||
var requiredVersion = plugin.getVersion();
|
|
||||||
|
|
||||||
return initNPM()
|
|
||||||
.then(function() {
|
|
||||||
return Promise.nfcall(npm.commands.view, [npmId + '@' + requiredVersion, 'engines'], true);
|
|
||||||
})
|
|
||||||
.then(function(versions) {
|
|
||||||
versions = Immutable.Map(versions).entrySeq();
|
|
||||||
|
|
||||||
var result = versions
|
|
||||||
.map(function(entry) {
|
|
||||||
return {
|
|
||||||
version: entry[0],
|
|
||||||
gitbook: (entry[1].engines || {}).gitbook
|
|
||||||
};
|
|
||||||
})
|
|
||||||
.filter(function(v) {
|
|
||||||
return v.gitbook && gitbook.satisfies(v.gitbook);
|
|
||||||
})
|
|
||||||
.sort(function(v1, v2) {
|
|
||||||
return semver.lt(v1.version, v2.version)? 1 : -1;
|
|
||||||
})
|
|
||||||
.get(0);
|
|
||||||
|
|
||||||
if (!result) {
|
|
||||||
return undefined;
|
|
||||||
} else {
|
|
||||||
return result.version;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Install a plugin for a book
|
|
||||||
|
|
||||||
@param {Book}
|
|
||||||
@param {Plugin}
|
|
||||||
@return {Promise}
|
|
||||||
*/
|
|
||||||
function installPlugin(book, plugin) {
|
|
||||||
var logger = book.getLogger();
|
|
||||||
|
|
||||||
var installFolder = book.getRoot();
|
|
||||||
var name = plugin.getName();
|
|
||||||
var requirement = plugin.getVersion();
|
|
||||||
|
|
||||||
logger.info.ln('');
|
|
||||||
logger.info.ln('installing plugin "' + name + '"');
|
|
||||||
|
|
||||||
// Find a version to install
|
|
||||||
return resolveVersion(plugin)
|
|
||||||
.then(function(version) {
|
|
||||||
if (!version) {
|
|
||||||
throw new Error('Found no satisfactory version for plugin "' + name + '" with requirement "' + requirement + '"');
|
|
||||||
}
|
|
||||||
|
|
||||||
logger.info.ln('install plugin "' + name +'" (' + requirement + ') from NPM with version', version);
|
|
||||||
return Promise.nfcall(npmi, {
|
|
||||||
'name': plugin.getNpmID(),
|
|
||||||
'version': version,
|
|
||||||
'path': installFolder,
|
|
||||||
'npmLoad': {
|
|
||||||
'loglevel': 'silent',
|
|
||||||
'loaded': true,
|
|
||||||
'prefix': installFolder
|
|
||||||
}
|
|
||||||
});
|
|
||||||
})
|
|
||||||
.then(function() {
|
|
||||||
logger.info.ok('plugin "' + name + '" installed with success');
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Install plugin requirements for a book
|
Install plugin requirements for a book
|
||||||
|
|
||||||
@param {Book}
|
@param {Book}
|
||||||
@return {Promise}
|
@return {Promise<Number>}
|
||||||
*/
|
*/
|
||||||
function installPlugins(book) {
|
function installPlugins(book) {
|
||||||
var logger = book.getLogger();
|
var logger = book.getLogger();
|
||||||
var plugins = listForBook(book);
|
var config = book.getConfig();
|
||||||
|
var plugins = config.getPluginDependencies();
|
||||||
|
|
||||||
// Remove default plugins
|
// Remove default plugins
|
||||||
// (only if version is same as installed)
|
// (only if version is same as installed)
|
||||||
plugins = plugins.filterNot(function(plugin) {
|
plugins = plugins.filterNot(function(plugin) {
|
||||||
return (
|
return (
|
||||||
DEFAULT_PLUGINS.includes(plugin.getName()) &&
|
// Disabled plugin
|
||||||
plugin.getVersion() === pkg.dependencies[plugin.getNpmID()]
|
!plugin.isEnabled() ||
|
||||||
|
|
||||||
|
// Or default one installed in GitBook itself
|
||||||
|
(DEFAULT_PLUGINS.includes(plugin.getName()) &&
|
||||||
|
plugin.getVersion() === pkg.dependencies[plugin.getNpmID()])
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -141,7 +39,8 @@ function installPlugins(book) {
|
|||||||
|
|
||||||
return Promise.forEach(plugins, function(plugin) {
|
return Promise.forEach(plugins, function(plugin) {
|
||||||
return installPlugin(book, plugin);
|
return installPlugin(book, plugin);
|
||||||
});
|
})
|
||||||
|
.thenResolve(plugins.size);
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = installPlugins;
|
module.exports = installPlugins;
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
var npm = require('npm');
|
||||||
|
var semver = require('semver');
|
||||||
|
var Immutable = require('immutable');
|
||||||
|
|
||||||
|
var Promise = require('../utils/promise');
|
||||||
|
var Plugin = require('../models/plugin');
|
||||||
|
var gitbook = require('../gitbook');
|
||||||
|
|
||||||
|
var npmIsReady;
|
||||||
|
|
||||||
|
/**
|
||||||
|
Initialize and prepare NPM
|
||||||
|
|
||||||
|
@return {Promise}
|
||||||
|
*/
|
||||||
|
function initNPM() {
|
||||||
|
if (npmIsReady) return npmIsReady;
|
||||||
|
|
||||||
|
npmIsReady = Promise.nfcall(npm.load, {
|
||||||
|
silent: true,
|
||||||
|
loglevel: 'silent'
|
||||||
|
});
|
||||||
|
|
||||||
|
return npmIsReady;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
Resolve a plugin dependency to a version
|
||||||
|
|
||||||
|
@param {PluginDependency} plugin
|
||||||
|
@return {Promise<String>}
|
||||||
|
*/
|
||||||
|
function resolveVersion(plugin) {
|
||||||
|
var npmId = Plugin.nameToNpmID(plugin.getName());
|
||||||
|
var requiredVersion = plugin.getVersion();
|
||||||
|
|
||||||
|
if (plugin.isGitDependency()) {
|
||||||
|
return Promise.resolve(requiredVersion);
|
||||||
|
}
|
||||||
|
|
||||||
|
return initNPM()
|
||||||
|
.then(function() {
|
||||||
|
return Promise.nfcall(npm.commands.view, [npmId + '@' + requiredVersion, 'engines'], true);
|
||||||
|
})
|
||||||
|
.then(function(versions) {
|
||||||
|
versions = Immutable.Map(versions).entrySeq();
|
||||||
|
|
||||||
|
var result = versions
|
||||||
|
.map(function(entry) {
|
||||||
|
return {
|
||||||
|
version: entry[0],
|
||||||
|
gitbook: (entry[1].engines || {}).gitbook
|
||||||
|
};
|
||||||
|
})
|
||||||
|
.filter(function(v) {
|
||||||
|
return v.gitbook && gitbook.satisfies(v.gitbook);
|
||||||
|
})
|
||||||
|
.sort(function(v1, v2) {
|
||||||
|
return semver.lt(v1.version, v2.version)? 1 : -1;
|
||||||
|
})
|
||||||
|
.get(0);
|
||||||
|
|
||||||
|
if (!result) {
|
||||||
|
return undefined;
|
||||||
|
} else {
|
||||||
|
return result.version;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = resolveVersion;
|
||||||
+2
-2
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "gitbook",
|
"name": "gitbook",
|
||||||
"version": "3.0.2",
|
"version": "3.0.3",
|
||||||
"homepage": "https://www.gitbook.com",
|
"homepage": "https://www.gitbook.com",
|
||||||
"description": "Library and cmd utility to generate GitBooks",
|
"description": "Library and cmd utility to generate GitBooks",
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
@@ -29,7 +29,7 @@
|
|||||||
"gitbook-plugin-lunr": "1.1.0",
|
"gitbook-plugin-lunr": "1.1.0",
|
||||||
"gitbook-plugin-search": "2.2.1",
|
"gitbook-plugin-search": "2.2.1",
|
||||||
"gitbook-plugin-sharing": "1.0.2",
|
"gitbook-plugin-sharing": "1.0.2",
|
||||||
"gitbook-plugin-theme-default": "1.0.2",
|
"gitbook-plugin-theme-default": "1.0.3",
|
||||||
"github-slugid": "1.0.1",
|
"github-slugid": "1.0.1",
|
||||||
"graceful-fs": "4.1.4",
|
"graceful-fs": "4.1.4",
|
||||||
"i18n-t": "1.0.0",
|
"i18n-t": "1.0.0",
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ var is = require('is');
|
|||||||
var path = require('path');
|
var path = require('path');
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var expect = require('expect');
|
var expect = require('expect');
|
||||||
|
var cheerio = require('cheerio');
|
||||||
|
|
||||||
expect.extend({
|
expect.extend({
|
||||||
/**
|
/**
|
||||||
@@ -43,6 +44,18 @@ expect.extend({
|
|||||||
'expected to be defined'
|
'expected to be defined'
|
||||||
);
|
);
|
||||||
return this;
|
return this;
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
Check that a dom element exists in HTML
|
||||||
|
|
||||||
|
@param {String} selector
|
||||||
|
*/
|
||||||
|
toHaveDOMElement: function(selector) {
|
||||||
|
var $ = cheerio.load(this.actual);
|
||||||
|
var $el = $(selector);
|
||||||
|
|
||||||
|
expect.assert($el.length > 0, 'expected HTML to contains %s', selector);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user