honkit 5.1.0 → 5.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/api/deprecate.js +2 -2
- package/lib/api/encodeConfig.js +1 -1
- package/lib/api/encodeNavigation.js +3 -3
- package/lib/api/encodePage.js +2 -2
- package/lib/api/encodeProgress.js +1 -1
- package/lib/api/encodeSummary.js +1 -1
- package/lib/api/index.js +1 -1
- package/lib/browser.js +1 -1
- package/lib/cli/build.js +2 -2
- package/lib/cli/buildEbook.js +2 -2
- package/lib/cli/init.js +1 -1
- package/lib/cli/options.js +5 -5
- package/lib/cli/parse.js +1 -1
- package/lib/cli/serve.d.ts.map +1 -1
- package/lib/cli/serve.js +28 -19
- package/lib/cli/server.js +1 -1
- package/lib/cli/watch.js +1 -1
- package/lib/constants/configSchema.js +50 -50
- package/lib/constants/defaultFilters.js +1 -1
- package/lib/fs/mock.js +5 -5
- package/lib/fs/node.js +1 -1
- package/lib/honkit.js +1 -1
- package/lib/index.js +1 -1
- package/lib/json/encodeBook.js +4 -4
- package/lib/json/encodeFile.js +1 -1
- package/lib/json/encodeGlossary.js +1 -1
- package/lib/json/encodeGlossaryEntry.js +1 -1
- package/lib/json/encodeLanguages.js +2 -2
- package/lib/json/encodeOutput.js +1 -1
- package/lib/json/encodeReadme.js +1 -1
- package/lib/json/encodeSummary.js +1 -1
- package/lib/json/encodeSummaryArticle.js +1 -1
- package/lib/json/encodeSummaryArticleWithCache.js +1 -1
- package/lib/json/encodeSummaryPart.js +1 -1
- package/lib/json/index.js +1 -1
- package/lib/models/book.js +4 -4
- package/lib/models/config.js +3 -3
- package/lib/models/fs.js +2 -2
- package/lib/models/glossaryEntry.js +1 -1
- package/lib/models/hash.js +1 -1
- package/lib/models/ignore.js +1 -1
- package/lib/models/language.js +1 -1
- package/lib/models/languages.js +3 -3
- package/lib/models/output.js +2 -2
- package/lib/models/page.js +4 -4
- package/lib/models/plugin.js +3 -3
- package/lib/models/pluginDependency.js +6 -6
- package/lib/models/readme.js +2 -2
- package/lib/models/summary.js +4 -4
- package/lib/models/summaryArticle.js +2 -2
- package/lib/models/summaryPart.js +2 -2
- package/lib/models/templateBlock.js +4 -4
- package/lib/models/templateEngine.js +4 -4
- package/lib/models/templateOutput.js +2 -2
- package/lib/modifiers/config/index.js +1 -1
- package/lib/modifiers/index.js +1 -1
- package/lib/modifiers/summary/editArticleRef.js +1 -1
- package/lib/modifiers/summary/editArticleTitle.js +1 -1
- package/lib/modifiers/summary/index.js +1 -1
- package/lib/modifiers/summary/indexArticleLevels.js +1 -1
- package/lib/modifiers/summary/indexPartLevels.js +1 -1
- package/lib/output/createTemplateEngine.js +1 -1
- package/lib/output/ebook/getConvertOptions.js +2 -2
- package/lib/output/ebook/getPDFTemplate.js +3 -3
- package/lib/output/ebook/index.js +1 -1
- package/lib/output/ebook/onFinish.js +2 -2
- package/lib/output/ebook/options.js +1 -1
- package/lib/output/generateBook.js +2 -2
- package/lib/output/getModifiers.js +3 -3
- package/lib/output/index.js +1 -1
- package/lib/output/json/index.js +1 -1
- package/lib/output/json/options.js +1 -1
- package/lib/output/modifiers/index.js +1 -1
- package/lib/output/preparePlugins.js +1 -1
- package/lib/output/testing/createMock.js +1 -1
- package/lib/output/testing/generateMock.js +2 -2
- package/lib/output/website/copyPluginAssets.js +2 -2
- package/lib/output/website/createTemplateEngine.js +4 -4
- package/lib/output/website/index.js +1 -1
- package/lib/output/website/onPage.js +4 -4
- package/lib/output/website/options.js +1 -1
- package/lib/output/website/prepareResources.js +2 -2
- package/lib/output/website/state.js +1 -1
- package/lib/parse/index.js +1 -1
- package/lib/parse/parseConfig.js +1 -1
- package/lib/parse/parseIgnore.js +1 -1
- package/lib/parse/parsePageFromString.js +1 -1
- package/lib/parse/parseSummary.js +1 -1
- package/lib/parse/validateConfig.js +1 -1
- package/lib/plugins/PluginResolver.js +1 -1
- package/lib/plugins/index.js +1 -1
- package/lib/plugins/listResources.js +2 -2
- package/lib/plugins/loadForBook.js +1 -1
- package/lib/plugins/loadPlugin.js +2 -2
- package/lib/plugins/validateConfig.js +1 -1
- package/lib/templating/index.js +1 -1
- package/lib/templating/render.js +1 -1
- package/lib/templating/renderFile.js +1 -1
- package/lib/templating/themesLoader.js +2 -2
- package/lib/utils/command.js +1 -1
- package/lib/utils/error.js +11 -11
- package/lib/utils/fs.d.ts.map +1 -1
- package/lib/utils/fs.js +1 -0
- package/lib/utils/git.js +1 -1
- package/lib/utils/images.js +1 -1
- package/lib/utils/location.js +1 -1
- package/lib/utils/logger.js +2 -2
- package/lib/utils/path.js +2 -2
- package/lib/utils/timing.js +2 -2
- package/package.json +7 -7
package/lib/honkit.js
CHANGED
package/lib/index.js
CHANGED
package/lib/json/encodeBook.js
CHANGED
|
@@ -27,15 +27,15 @@ function encodeBookToJson(book) {
|
|
|
27
27
|
languages: book.isMultilingual() ? (0, encodeLanguages_1.default)(book.getLanguages()) : undefined,
|
|
28
28
|
gitbook: {
|
|
29
29
|
version: honkit_1.default.version,
|
|
30
|
-
time: honkit_1.default.START_TIME
|
|
30
|
+
time: honkit_1.default.START_TIME
|
|
31
31
|
},
|
|
32
32
|
honkit: {
|
|
33
33
|
version: honkit_1.default.version,
|
|
34
|
-
time: honkit_1.default.START_TIME
|
|
34
|
+
time: honkit_1.default.START_TIME
|
|
35
35
|
},
|
|
36
36
|
book: (0, extend_1.default)({
|
|
37
|
-
language: language ? language : undefined
|
|
38
|
-
}, variables.toJS())
|
|
37
|
+
language: language ? language : undefined
|
|
38
|
+
}, variables.toJS())
|
|
39
39
|
};
|
|
40
40
|
}
|
|
41
41
|
exports.default = encodeBookToJson;
|
package/lib/json/encodeFile.js
CHANGED
|
@@ -16,7 +16,7 @@ function encodeGlossary(glossary) {
|
|
|
16
16
|
const entries = glossary.getEntries();
|
|
17
17
|
return {
|
|
18
18
|
file: (0, encodeFile_1.default)(file),
|
|
19
|
-
entries: entries.map(encodeGlossaryEntry_1.default).toJS()
|
|
19
|
+
entries: entries.map(encodeGlossaryEntry_1.default).toJS()
|
|
20
20
|
};
|
|
21
21
|
}
|
|
22
22
|
exports.default = encodeGlossary;
|
package/lib/json/encodeOutput.js
CHANGED
|
@@ -17,7 +17,7 @@ function encodeOutputToJson(output) {
|
|
|
17
17
|
const result = (0, encodeBook_1.default)(book);
|
|
18
18
|
// @ts-expect-error ts-migrate(2339) FIXME: Property 'output' does not exist on type '{ summar... Remove this comment to see the full error message
|
|
19
19
|
result.output = {
|
|
20
|
-
name: generator
|
|
20
|
+
name: generator
|
|
21
21
|
};
|
|
22
22
|
// @ts-expect-error ts-migrate(2339) FIXME: Property 'options' does not exist on type '{ summa... Remove this comment to see the full error message
|
|
23
23
|
result.options = options.toJS();
|
package/lib/json/encodeReadme.js
CHANGED
|
@@ -13,7 +13,7 @@ const encodeFile_1 = __importDefault(require("./encodeFile"));
|
|
|
13
13
|
function encodeReadme(readme) {
|
|
14
14
|
const file = readme.getFile();
|
|
15
15
|
return {
|
|
16
|
-
file: (0, encodeFile_1.default)(file)
|
|
16
|
+
file: (0, encodeFile_1.default)(file)
|
|
17
17
|
};
|
|
18
18
|
}
|
|
19
19
|
exports.default = encodeReadme;
|
|
@@ -16,7 +16,7 @@ function encodeSummary(summary) {
|
|
|
16
16
|
const parts = summary.getParts();
|
|
17
17
|
return {
|
|
18
18
|
file: (0, encodeFile_1.default)(file),
|
|
19
|
-
parts: parts.map(encodeSummaryPart_1.default).toJS()
|
|
19
|
+
parts: parts.map(encodeSummaryPart_1.default).toJS()
|
|
20
20
|
};
|
|
21
21
|
}
|
|
22
22
|
exports.default = encodeSummary;
|
|
@@ -28,7 +28,7 @@ function encodeSummaryArticleWithCache(article, recursive) {
|
|
|
28
28
|
url: article.getUrl(),
|
|
29
29
|
path: article.getPath(),
|
|
30
30
|
ref: article.getRef(),
|
|
31
|
-
articles: articles
|
|
31
|
+
articles: articles
|
|
32
32
|
};
|
|
33
33
|
articleCacheMap.set(article, encodedArticle);
|
|
34
34
|
return encodedArticle;
|
|
@@ -13,7 +13,7 @@ const encodeSummaryArticle_1 = __importDefault(require("./encodeSummaryArticle")
|
|
|
13
13
|
function encodeSummaryPart(part) {
|
|
14
14
|
return {
|
|
15
15
|
title: part.getTitle(),
|
|
16
|
-
articles: part.getArticles().map(encodeSummaryArticle_1.default).toJS()
|
|
16
|
+
articles: part.getArticles().map(encodeSummaryArticle_1.default).toJS()
|
|
17
17
|
};
|
|
18
18
|
}
|
|
19
19
|
exports.default = encodeSummaryPart;
|
package/lib/json/index.js
CHANGED
package/lib/models/book.js
CHANGED
|
@@ -14,7 +14,7 @@ const glossary_1 = __importDefault(require("./glossary"));
|
|
|
14
14
|
const languages_1 = __importDefault(require("./languages"));
|
|
15
15
|
const ignore_1 = __importDefault(require("./ignore"));
|
|
16
16
|
class Book extends immutable_1.default.Record({
|
|
17
|
-
// Logger for
|
|
17
|
+
// Logger for outptut message
|
|
18
18
|
// @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 0.
|
|
19
19
|
logger: (0, logger_1.default)(),
|
|
20
20
|
// Filesystem binded to the book scope to read files/directories
|
|
@@ -30,7 +30,7 @@ class Book extends immutable_1.default.Record({
|
|
|
30
30
|
// ID of the language for language books
|
|
31
31
|
language: String(),
|
|
32
32
|
// List of children, if multilingual (String -> Book)
|
|
33
|
-
books: immutable_1.default.OrderedMap()
|
|
33
|
+
books: immutable_1.default.OrderedMap()
|
|
34
34
|
}) {
|
|
35
35
|
getLogger() {
|
|
36
36
|
return this.get("logger");
|
|
@@ -215,7 +215,7 @@ class Book extends immutable_1.default.Record({
|
|
|
215
215
|
*/
|
|
216
216
|
static createForFS(fs) {
|
|
217
217
|
return new Book({
|
|
218
|
-
fs: fs
|
|
218
|
+
fs: fs
|
|
219
219
|
});
|
|
220
220
|
}
|
|
221
221
|
/**
|
|
@@ -305,7 +305,7 @@ class Book extends immutable_1.default.Record({
|
|
|
305
305
|
config: config,
|
|
306
306
|
ignore: ignore,
|
|
307
307
|
language: language,
|
|
308
|
-
fs: fs_1.default.reduceScope(parent.getContentFS(), language)
|
|
308
|
+
fs: fs_1.default.reduceScope(parent.getContentFS(), language)
|
|
309
309
|
});
|
|
310
310
|
}
|
|
311
311
|
}
|
package/lib/models/config.js
CHANGED
|
@@ -10,7 +10,7 @@ const configDefault_1 = __importDefault(require("../constants/configDefault"));
|
|
|
10
10
|
const reducedObject_1 = __importDefault(require("../utils/reducedObject"));
|
|
11
11
|
class Config extends immutable_1.default.Record({
|
|
12
12
|
file: new file_1.default(),
|
|
13
|
-
values: configDefault_1.default
|
|
13
|
+
values: configDefault_1.default
|
|
14
14
|
}, "Config") {
|
|
15
15
|
getFile() {
|
|
16
16
|
return this.get("file");
|
|
@@ -126,7 +126,7 @@ class Config extends immutable_1.default.Record({
|
|
|
126
126
|
static create(file, values) {
|
|
127
127
|
return new Config({
|
|
128
128
|
file: file,
|
|
129
|
-
values: immutable_1.default.fromJS(values)
|
|
129
|
+
values: immutable_1.default.fromJS(values)
|
|
130
130
|
});
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
@@ -136,7 +136,7 @@ class Config extends immutable_1.default.Record({
|
|
|
136
136
|
*/
|
|
137
137
|
static createWithValues(values) {
|
|
138
138
|
return new Config({
|
|
139
|
-
values: immutable_1.default.fromJS(values)
|
|
139
|
+
values: immutable_1.default.fromJS(values)
|
|
140
140
|
});
|
|
141
141
|
}
|
|
142
142
|
/**
|
package/lib/models/fs.js
CHANGED
|
@@ -17,7 +17,7 @@ class FS extends immutable_1.default.Record({
|
|
|
17
17
|
fsStatFile: Function(),
|
|
18
18
|
fsReadDir: Function(),
|
|
19
19
|
fsLoadObject: null,
|
|
20
|
-
fsReadAsStream: null
|
|
20
|
+
fsReadAsStream: null
|
|
21
21
|
}) {
|
|
22
22
|
/**
|
|
23
23
|
Return path to the root
|
|
@@ -49,7 +49,7 @@ class FS extends immutable_1.default.Record({
|
|
|
49
49
|
if (!this.isInScope(filename)) {
|
|
50
50
|
throw error_1.default.FileOutOfScopeError({
|
|
51
51
|
filename: filename,
|
|
52
|
-
root: rootPath
|
|
52
|
+
root: rootPath
|
|
53
53
|
});
|
|
54
54
|
}
|
|
55
55
|
return filename;
|
package/lib/models/hash.js
CHANGED
package/lib/models/ignore.js
CHANGED
|
@@ -9,7 +9,7 @@ const ignore_1 = __importDefault(require("ignore"));
|
|
|
9
9
|
Immutable version of node-ignore
|
|
10
10
|
*/
|
|
11
11
|
class Ignore extends immutable_1.default.Record({
|
|
12
|
-
ignore: (0, ignore_1.default)()
|
|
12
|
+
ignore: (0, ignore_1.default)()
|
|
13
13
|
}, "Ignore") {
|
|
14
14
|
getIgnore() {
|
|
15
15
|
return this.get("ignore");
|
package/lib/models/language.js
CHANGED
|
@@ -7,7 +7,7 @@ const path_1 = __importDefault(require("path"));
|
|
|
7
7
|
const immutable_1 = __importDefault(require("immutable"));
|
|
8
8
|
class Language extends immutable_1.default.Record({
|
|
9
9
|
title: String(),
|
|
10
|
-
path: String()
|
|
10
|
+
path: String()
|
|
11
11
|
}) {
|
|
12
12
|
getTitle() {
|
|
13
13
|
return this.get("title");
|
package/lib/models/languages.js
CHANGED
|
@@ -8,7 +8,7 @@ const file_1 = __importDefault(require("./file"));
|
|
|
8
8
|
const language_1 = __importDefault(require("./language"));
|
|
9
9
|
class Languages extends immutable_1.default.Record({
|
|
10
10
|
file: new file_1.default(),
|
|
11
|
-
list: immutable_1.default.OrderedMap()
|
|
11
|
+
list: immutable_1.default.OrderedMap()
|
|
12
12
|
}) {
|
|
13
13
|
getFile() {
|
|
14
14
|
return this.get("file");
|
|
@@ -51,13 +51,13 @@ class Languages extends immutable_1.default.Record({
|
|
|
51
51
|
langs.forEach((lang) => {
|
|
52
52
|
lang = new language_1.default({
|
|
53
53
|
title: lang.title,
|
|
54
|
-
path: lang.ref
|
|
54
|
+
path: lang.ref
|
|
55
55
|
});
|
|
56
56
|
list = list.set(lang.getID(), lang);
|
|
57
57
|
});
|
|
58
58
|
return new Languages({
|
|
59
59
|
file: file,
|
|
60
|
-
list: list
|
|
60
|
+
list: list
|
|
61
61
|
});
|
|
62
62
|
}
|
|
63
63
|
}
|
package/lib/models/output.js
CHANGED
|
@@ -25,7 +25,7 @@ class Output extends immutable_1.default.Record({
|
|
|
25
25
|
state: immutable_1.default.Map(),
|
|
26
26
|
// incrementalChangeFileSet for incremental building
|
|
27
27
|
// If it is empty, should build all
|
|
28
|
-
incrementalChangeFileSet: immutable_1.default.Set()
|
|
28
|
+
incrementalChangeFileSet: immutable_1.default.Set()
|
|
29
29
|
}) {
|
|
30
30
|
getBook() {
|
|
31
31
|
return this.get("book");
|
|
@@ -68,7 +68,7 @@ class Output extends immutable_1.default.Record({
|
|
|
68
68
|
}
|
|
69
69
|
const newPage = (0, parsePageFromString_1.default)(page, fs_1.default.readFileSync(filePath, "utf-8"));
|
|
70
70
|
return this.merge({
|
|
71
|
-
pages: pages.set(relativePath, newPage)
|
|
71
|
+
pages: pages.set(relativePath, newPage)
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
package/lib/models/page.js
CHANGED
|
@@ -14,7 +14,7 @@ class Page extends immutable_1.default.Record({
|
|
|
14
14
|
// Content of the page
|
|
15
15
|
content: String(),
|
|
16
16
|
// Direction of the text
|
|
17
|
-
dir: String("ltr")
|
|
17
|
+
dir: String("ltr")
|
|
18
18
|
}) {
|
|
19
19
|
getFile() {
|
|
20
20
|
return this.get("file");
|
|
@@ -55,7 +55,7 @@ class Page extends immutable_1.default.Record({
|
|
|
55
55
|
*/
|
|
56
56
|
static createForFile(file) {
|
|
57
57
|
return new Page({
|
|
58
|
-
file: file
|
|
58
|
+
file: file
|
|
59
59
|
});
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
@@ -67,7 +67,7 @@ class Page extends immutable_1.default.Record({
|
|
|
67
67
|
static loadFile(file, content) {
|
|
68
68
|
return new Page({
|
|
69
69
|
file: file,
|
|
70
|
-
content: content
|
|
70
|
+
content: content
|
|
71
71
|
});
|
|
72
72
|
}
|
|
73
73
|
static fromJSON(json) {
|
|
@@ -78,7 +78,7 @@ class Page extends immutable_1.default.Record({
|
|
|
78
78
|
// Content of the page
|
|
79
79
|
content: json.content,
|
|
80
80
|
// Direction of the text
|
|
81
|
-
dir: json.dir
|
|
81
|
+
dir: json.dir
|
|
82
82
|
});
|
|
83
83
|
}
|
|
84
84
|
static toJSON(page) {
|
package/lib/models/plugin.js
CHANGED
|
@@ -20,7 +20,7 @@ class Plugin extends immutable_1.default.Record({
|
|
|
20
20
|
// Content of the "package.json"
|
|
21
21
|
package: immutable_1.default.Map(),
|
|
22
22
|
// Content of the package itself
|
|
23
|
-
content: immutable_1.default.Map()
|
|
23
|
+
content: immutable_1.default.Map()
|
|
24
24
|
}, "Plugin") {
|
|
25
25
|
getName() {
|
|
26
26
|
return this.get("name");
|
|
@@ -125,7 +125,7 @@ class Plugin extends immutable_1.default.Record({
|
|
|
125
125
|
const version = parts.slice(1).join("@");
|
|
126
126
|
return new Plugin({
|
|
127
127
|
name: name,
|
|
128
|
-
version: version || DEFAULT_VERSION
|
|
128
|
+
version: version || DEFAULT_VERSION
|
|
129
129
|
});
|
|
130
130
|
}
|
|
131
131
|
/**
|
|
@@ -135,7 +135,7 @@ class Plugin extends immutable_1.default.Record({
|
|
|
135
135
|
static createFromDep(dep) {
|
|
136
136
|
return new Plugin({
|
|
137
137
|
name: dep.getName(),
|
|
138
|
-
version: dep.getVersion()
|
|
138
|
+
version: dep.getVersion()
|
|
139
139
|
});
|
|
140
140
|
}
|
|
141
141
|
}
|
|
@@ -18,7 +18,7 @@ class PluginDependency extends immutable_1.default.Record({
|
|
|
18
18
|
// path to package
|
|
19
19
|
path: String(),
|
|
20
20
|
// Is this plugin enabled or disabled?
|
|
21
|
-
enabled: Boolean(true)
|
|
21
|
+
enabled: Boolean(true)
|
|
22
22
|
}, "PluginDependency") {
|
|
23
23
|
getName() {
|
|
24
24
|
return this.get("name");
|
|
@@ -60,7 +60,7 @@ class PluginDependency extends immutable_1.default.Record({
|
|
|
60
60
|
return new PluginDependency({
|
|
61
61
|
name: name,
|
|
62
62
|
version: version || DEFAULT_VERSION,
|
|
63
|
-
enabled: Boolean(enabled)
|
|
63
|
+
enabled: Boolean(enabled)
|
|
64
64
|
});
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
@@ -84,7 +84,7 @@ class PluginDependency extends immutable_1.default.Record({
|
|
|
84
84
|
return new PluginDependency({
|
|
85
85
|
name: match.groups.name,
|
|
86
86
|
version: DEFAULT_VERSION,
|
|
87
|
-
enabled: enabled
|
|
87
|
+
enabled: enabled
|
|
88
88
|
});
|
|
89
89
|
}
|
|
90
90
|
else if (scopedPackagePattern.test(s)) {
|
|
@@ -93,7 +93,7 @@ class PluginDependency extends immutable_1.default.Record({
|
|
|
93
93
|
return new PluginDependency({
|
|
94
94
|
name: match.groups.name,
|
|
95
95
|
version: DEFAULT_VERSION,
|
|
96
|
-
enabled: enabled
|
|
96
|
+
enabled: enabled
|
|
97
97
|
});
|
|
98
98
|
}
|
|
99
99
|
else {
|
|
@@ -118,7 +118,7 @@ class PluginDependency extends immutable_1.default.Record({
|
|
|
118
118
|
return new PluginDependency({
|
|
119
119
|
name: name,
|
|
120
120
|
version: version || DEFAULT_VERSION,
|
|
121
|
-
enabled: enabled
|
|
121
|
+
enabled: enabled
|
|
122
122
|
});
|
|
123
123
|
}
|
|
124
124
|
}
|
|
@@ -143,7 +143,7 @@ class PluginDependency extends immutable_1.default.Record({
|
|
|
143
143
|
else {
|
|
144
144
|
return new PluginDependency({
|
|
145
145
|
name: entry.get("name"),
|
|
146
|
-
version: entry.get("version")
|
|
146
|
+
version: entry.get("version")
|
|
147
147
|
});
|
|
148
148
|
}
|
|
149
149
|
})
|
package/lib/models/readme.js
CHANGED
|
@@ -8,7 +8,7 @@ const file_1 = __importDefault(require("./file"));
|
|
|
8
8
|
class Readme extends immutable_1.default.Record({
|
|
9
9
|
file: new file_1.default(),
|
|
10
10
|
title: String(),
|
|
11
|
-
description: String()
|
|
11
|
+
description: String()
|
|
12
12
|
}) {
|
|
13
13
|
getFile() {
|
|
14
14
|
return this.get("file");
|
|
@@ -31,7 +31,7 @@ class Readme extends immutable_1.default.Record({
|
|
|
31
31
|
return new Readme({
|
|
32
32
|
file: file,
|
|
33
33
|
title: def.title || "",
|
|
34
|
-
description: def.description || ""
|
|
34
|
+
description: def.description || ""
|
|
35
35
|
});
|
|
36
36
|
}
|
|
37
37
|
}
|
package/lib/models/summary.js
CHANGED
|
@@ -13,7 +13,7 @@ const summaryArticle_1 = __importDefault(require("./summaryArticle"));
|
|
|
13
13
|
const parsers_1 = __importDefault(require("../parsers"));
|
|
14
14
|
class Summary extends immutable_1.default.Record({
|
|
15
15
|
file: new file_1.default(),
|
|
16
|
-
parts: immutable_1.default.List()
|
|
16
|
+
parts: immutable_1.default.List()
|
|
17
17
|
}, "Summary") {
|
|
18
18
|
getFile() {
|
|
19
19
|
return this.get("file");
|
|
@@ -147,11 +147,11 @@ class Summary extends immutable_1.default.Record({
|
|
|
147
147
|
const parser = parseExt ? parsers_1.default.getByExt(parseExt) : file.getParser();
|
|
148
148
|
if (!parser) {
|
|
149
149
|
throw error_1.default.FileNotParsableError({
|
|
150
|
-
filename: file.getPath()
|
|
150
|
+
filename: file.getPath()
|
|
151
151
|
});
|
|
152
152
|
}
|
|
153
153
|
return parser.renderSummary({
|
|
154
|
-
parts: parts.toJS()
|
|
154
|
+
parts: parts.toJS()
|
|
155
155
|
});
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
@@ -182,7 +182,7 @@ class Summary extends immutable_1.default.Record({
|
|
|
182
182
|
return new Summary({
|
|
183
183
|
file: file,
|
|
184
184
|
// @ts-expect-error ts-migrate(2350) FIXME: Only a void function can be called with the 'new' ... Remove this comment to see the full error message
|
|
185
|
-
parts: new immutable_1.default.List(parts)
|
|
185
|
+
parts: new immutable_1.default.List(parts)
|
|
186
186
|
});
|
|
187
187
|
}
|
|
188
188
|
}
|
|
@@ -9,7 +9,7 @@ class SummaryArticle extends immutable_1.default.Record({
|
|
|
9
9
|
level: String(),
|
|
10
10
|
title: String(),
|
|
11
11
|
ref: String(),
|
|
12
|
-
articles: immutable_1.default.List()
|
|
12
|
+
articles: immutable_1.default.List()
|
|
13
13
|
}, "SummaryArticle") {
|
|
14
14
|
getLevel() {
|
|
15
15
|
return this.get("level");
|
|
@@ -135,7 +135,7 @@ class SummaryArticle extends immutable_1.default.Record({
|
|
|
135
135
|
level: level,
|
|
136
136
|
title: def.title,
|
|
137
137
|
ref: def.ref || def.path || "",
|
|
138
|
-
articles: immutable_1.default.List(articles)
|
|
138
|
+
articles: immutable_1.default.List(articles)
|
|
139
139
|
});
|
|
140
140
|
}
|
|
141
141
|
/**
|
|
@@ -8,7 +8,7 @@ const summaryArticle_1 = __importDefault(require("./summaryArticle"));
|
|
|
8
8
|
class SummaryPart extends immutable_1.default.Record({
|
|
9
9
|
level: String(),
|
|
10
10
|
title: String(),
|
|
11
|
-
articles: immutable_1.default.List()
|
|
11
|
+
articles: immutable_1.default.List()
|
|
12
12
|
}) {
|
|
13
13
|
getLevel() {
|
|
14
14
|
return this.get("level");
|
|
@@ -46,7 +46,7 @@ class SummaryPart extends immutable_1.default.Record({
|
|
|
46
46
|
return new SummaryPart({
|
|
47
47
|
level: String(level),
|
|
48
48
|
title: def.title,
|
|
49
|
-
articles: immutable_1.default.List(articles)
|
|
49
|
+
articles: immutable_1.default.List(articles)
|
|
50
50
|
});
|
|
51
51
|
}
|
|
52
52
|
}
|
|
@@ -20,7 +20,7 @@ class TemplateBlock extends immutable_1.default.Record({
|
|
|
20
20
|
// List of String, for inner block tags
|
|
21
21
|
blocks: immutable_1.default.List(),
|
|
22
22
|
// List of shortcuts to replace with this block
|
|
23
|
-
shortcuts: immutable_1.default.Map()
|
|
23
|
+
shortcuts: immutable_1.default.Map()
|
|
24
24
|
}, "TemplateBlock") {
|
|
25
25
|
getName() {
|
|
26
26
|
return this.get("name");
|
|
@@ -127,7 +127,7 @@ class TemplateBlock extends immutable_1.default.Record({
|
|
|
127
127
|
name: name,
|
|
128
128
|
body: blockBody(),
|
|
129
129
|
args: blockArgs,
|
|
130
|
-
kwargs: blockKwargs
|
|
130
|
+
kwargs: blockKwargs
|
|
131
131
|
});
|
|
132
132
|
});
|
|
133
133
|
const mainBlock = blocks.shift();
|
|
@@ -135,7 +135,7 @@ class TemplateBlock extends immutable_1.default.Record({
|
|
|
135
135
|
(0, promise_1.default)()
|
|
136
136
|
.then(() => {
|
|
137
137
|
const ctx = (0, extend_1.default)({
|
|
138
|
-
ctx: context
|
|
138
|
+
ctx: context
|
|
139
139
|
}, mainContext || {});
|
|
140
140
|
return that.applyBlock(mainBlock, ctx);
|
|
141
141
|
})
|
|
@@ -210,7 +210,7 @@ class TemplateBlock extends immutable_1.default.Record({
|
|
|
210
210
|
if (is_1.default.fn(block)) {
|
|
211
211
|
// @ts-expect-error ts-migrate(2350) FIXME: Only a void function can be called with the 'new' ... Remove this comment to see the full error message
|
|
212
212
|
block = new immutable_1.default.Map({
|
|
213
|
-
process: block
|
|
213
|
+
process: block
|
|
214
214
|
});
|
|
215
215
|
}
|
|
216
216
|
block = new TemplateBlock(block);
|
|
@@ -17,7 +17,7 @@ class TemplateEngine extends immutable_1.default.Record({
|
|
|
17
17
|
// Context for filters / blocks
|
|
18
18
|
context: Object(),
|
|
19
19
|
// Nunjucks loader
|
|
20
|
-
loader: new nunjucks_1.default.FileSystemLoader("views")
|
|
20
|
+
loader: new nunjucks_1.default.FileSystemLoader("views")
|
|
21
21
|
}, "TemplateEngine") {
|
|
22
22
|
getBlocks() {
|
|
23
23
|
return this.get("blocks");
|
|
@@ -72,8 +72,8 @@ class TemplateEngine extends immutable_1.default.Record({
|
|
|
72
72
|
variableStart: "{{",
|
|
73
73
|
variableEnd: "}}",
|
|
74
74
|
commentStart: "{###",
|
|
75
|
-
commentEnd: "###}"
|
|
76
|
-
}
|
|
75
|
+
commentEnd: "###}"
|
|
76
|
+
}
|
|
77
77
|
});
|
|
78
78
|
// Add filters
|
|
79
79
|
filters.forEach((filterFn, filterName) => {
|
|
@@ -108,7 +108,7 @@ class TemplateEngine extends immutable_1.default.Record({
|
|
|
108
108
|
filters: immutable_1.default.Map(def.filters || {}),
|
|
109
109
|
globals: immutable_1.default.Map(def.globals || {}),
|
|
110
110
|
context: def.context,
|
|
111
|
-
loader: def.loader
|
|
111
|
+
loader: def.loader
|
|
112
112
|
});
|
|
113
113
|
}
|
|
114
114
|
}
|
|
@@ -8,7 +8,7 @@ class TemplateOutput extends immutable_1.default.Record({
|
|
|
8
8
|
// Text content of the template
|
|
9
9
|
content: String(),
|
|
10
10
|
// Map of blocks to replace / post process
|
|
11
|
-
blocks: immutable_1.default.Map()
|
|
11
|
+
blocks: immutable_1.default.Map()
|
|
12
12
|
}, "TemplateOutput") {
|
|
13
13
|
getContent() {
|
|
14
14
|
return this.get("content");
|
|
@@ -29,7 +29,7 @@ class TemplateOutput extends immutable_1.default.Record({
|
|
|
29
29
|
static create(content, blocks) {
|
|
30
30
|
return new TemplateOutput({
|
|
31
31
|
content: content,
|
|
32
|
-
blocks: immutable_1.default.fromJS(blocks)
|
|
32
|
+
blocks: immutable_1.default.fromJS(blocks)
|
|
33
33
|
});
|
|
34
34
|
}
|
|
35
35
|
}
|
package/lib/modifiers/index.js
CHANGED
|
@@ -14,7 +14,7 @@ const mergeAtLevel_1 = __importDefault(require("./mergeAtLevel"));
|
|
|
14
14
|
*/
|
|
15
15
|
function editArticleRef(summary, level, newRef) {
|
|
16
16
|
return (0, mergeAtLevel_1.default)(summary, level, {
|
|
17
|
-
ref: newRef
|
|
17
|
+
ref: newRef
|
|
18
18
|
});
|
|
19
19
|
}
|
|
20
20
|
exports.default = editArticleRef;
|
|
@@ -14,7 +14,7 @@ const mergeAtLevel_1 = __importDefault(require("./mergeAtLevel"));
|
|
|
14
14
|
*/
|
|
15
15
|
function editArticleTitle(summary, level, newTitle) {
|
|
16
16
|
return (0, mergeAtLevel_1.default)(summary, level, {
|
|
17
|
-
title: newTitle
|
|
17
|
+
title: newTitle
|
|
18
18
|
});
|
|
19
19
|
}
|
|
20
20
|
exports.default = editArticleTitle;
|