iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build(aio): initialise `exampleMap` correctly (#22502) 

The `exampleMap` needs to hold an hash object for each
of the `collectExamples.exampleFolders` paths.

Previously these hash objects were only created if there
was actually an example file the hash's respective
example folder.  This could cause crashes during
`yarn docs-watch` (and so also `yarn sync-and-serve`)
if no examples were read in for a particular run of
the doc-gen.

PR Close #22502
This commit is contained in:
Pete Bacon Darwin 2018-02-28 20:10:14 +00:00 committed by Alex Eagle
parent 2f0ab7ee98
commit 94707fe795
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
aio/tools/transforms/examples-package/processors/collect-examples.js
View File

@ -27,6 +27,7 @@ module.exports = function collectExamples(exampleMap, regionParser, log, createD
}, },
$process(docs) { $process(docs) {
const exampleFolders = this.exampleFolders; const exampleFolders = this.exampleFolders;
exampleFolders.forEach(folder => exampleMap[folder] = exampleMap[folder] || {});
const regionDocs = []; const regionDocs = [];
docs = docs.filter((doc) => { docs = docs.filter((doc) => {
if (doc.docType === 'example-file') { if (doc.docType === 'example-file') {
@ -36,7 +37,6 @@ module.exports = function collectExamples(exampleMap, regionParser, log, createD
if (doc.fileInfo.relativePath.indexOf(folder) === 0) { if (doc.fileInfo.relativePath.indexOf(folder) === 0) {
const relativePath = const relativePath =
doc.fileInfo.relativePath.substr(folder.length).replace(/^\//, ''); doc.fileInfo.relativePath.substr(folder.length).replace(/^\//, '');
exampleMap[folder] = exampleMap[folder] || {};
exampleMap[folder][relativePath] = doc; exampleMap[folder][relativePath] = doc;
// We treat files that end in `.annotated` specially // We treat files that end in `.annotated` specially

6
aio/tools/transforms/examples-package/processors/collect-examples.spec.js
View File

@ -25,6 +25,12 @@ describe('collectExampleRegions processor', () => {
describe('$process', () => { describe('$process', () => {
it('should initialise the `exampleMap` even if there are no examples to collect', () => {
processor.$process([]);
expect(exampleMap['examples-1']).toEqual(jasmine.any(Object));
expect(exampleMap['examples-2']).toEqual(jasmine.any(Object));
});
it('should identify example files that are in the exampleFolders', () => { it('should identify example files that are in the exampleFolders', () => {
const docs = [ const docs = [
createDoc('A', 'examples-1/x/app.js'), createDoc('B', 'examples-1/y/index.html'), createDoc('A', 'examples-1/x/app.js'), createDoc('B', 'examples-1/y/index.html'),