mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
Bob Watson
a6d953e145
This commit prepares the documentation directories for future tutorials organized by directory. Also, it moves the Angular Libraries topic from the Tutorials section to Developer Guides in TOC PR Close #48162
86 lines
3.3 KiB
JavaScript
86 lines
3.3 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/* eslint no-console: "off" */
|
|
|
|
function createPackage(changedFile) {
|
|
const marketingMatch = /^aio\/content\/(?:marketing\/|navigation\.json)/.exec(changedFile);
|
|
if (marketingMatch) {
|
|
console.log('Building marketing docs');
|
|
return require('./marketing-package').createPackage();
|
|
}
|
|
|
|
const tutorialMatch = /^aio\/content\/tutorial\/([^.]+)\.md/.exec(changedFile);
|
|
const tutorialExampleMatch = /^aio\/content\/examples\/(toh-[^/]+)\//.exec(changedFile);
|
|
let tutorialName = '';
|
|
if (tutorialMatch || tutorialExampleMatch) {
|
|
if (tutorialExampleMatch) {
|
|
tutorialName = 'tour-of-heroes/' + tutorialExampleMatch[1];
|
|
} else {
|
|
tutorialName = tutorialMatch[1];
|
|
}
|
|
console.log('Building tutorial docs for: ', tutorialName);
|
|
return require('./tutorial-package').createPackage(tutorialName);
|
|
}
|
|
|
|
const gettingStartedMatch = /^aio\/content\/start\/([^.]+)\.md/.exec(changedFile);
|
|
const gettingStartedExampleMatch = /^aio\/content\/examples\/getting-started\/([^/]+)\//.exec(changedFile);
|
|
if (gettingStartedMatch || gettingStartedExampleMatch) {
|
|
const gettingStartedName = gettingStartedMatch && gettingStartedMatch[1] || 'index';
|
|
console.log('Building getting started docs');
|
|
return require('./getting-started-package').createPackage(gettingStartedName);
|
|
}
|
|
|
|
const guideMatch = /^aio\/content\/guide\/([^.]+)\.md/.exec(changedFile);
|
|
const exampleMatch = /^aio\/content\/examples\/(?:cb-)?([^/]+)\//.exec(changedFile);
|
|
if (guideMatch || exampleMatch) {
|
|
const guideName = guideMatch && guideMatch[1] || exampleMatch[1];
|
|
console.log(`Building guide doc: ${guideName}.md`);
|
|
return require('./guide-package').createPackage(guideName);
|
|
}
|
|
|
|
const apiExamplesMatch = /^packages\/examples\/([^/]+)\//.exec(changedFile);
|
|
const apiMatch = /^packages\/([^/]+)\//.exec(changedFile);
|
|
if (apiExamplesMatch || apiMatch) {
|
|
const packageName = apiExamplesMatch && apiExamplesMatch[1] || apiMatch[1];
|
|
console.log('Building API docs for', packageName);
|
|
return require('./api-package').createPackage(packageName);
|
|
}
|
|
|
|
const errorsMatch = /^aio\/content\/error\/([^.]+)\.md/.exec(changedFile);
|
|
if (errorsMatch) {
|
|
console.log('Building errors docs');
|
|
return require('./errors-package').createPackage();
|
|
}
|
|
|
|
const diagnosticsMatch = /^aio\/content\/extended-diagnostics\/([^.]+)\.md/.exec(changedFile);
|
|
if (diagnosticsMatch) {
|
|
console.log('Building extended diagnostics docs');
|
|
return require('./extended-diagnostics-package').createPackage();
|
|
}
|
|
}
|
|
|
|
module.exports = {
|
|
generateDocs: function(changedFile, options = {}) {
|
|
const {Dgeni} = require('dgeni');
|
|
const package = createPackage(changedFile);
|
|
if (package === undefined) {
|
|
console.log('The changed file was not matched to a dgeni package - skipping doc-gen');
|
|
return Promise.resolve();
|
|
}
|
|
if (options.silent) {
|
|
package.config(function(log) { log.level = 'error'; });
|
|
}
|
|
var dgeni = new Dgeni([package]);
|
|
const start = Date.now();
|
|
return dgeni.generate()
|
|
.then(
|
|
() => console.log('Generated docs in ' + (Date.now() - start)/1000 + ' secs'),
|
|
err => console.log('Error generating docs', err));
|
|
}
|
|
};
|