build(aio): refactor dgeni packages

This is to tidy up the `author-packagse`, which currently duplicates a
lot of the configuration in the main packages. We need to
DRY this up so that we don't fall foul of a change in one being missed in
the other.
This commit is contained in:
Peter Bacon Darwin
2017-04-21 13:10:52 +01:00
committed by Pete Bacon Darwin
parent 7a8bd99ab1
commit 3cad5da5a4
66 changed files with 480 additions and 634 deletions

View File

@ -0,0 +1,118 @@
/**
* @license
* Copyright Google Inc. 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
*/
const Package = require('dgeni').Package;
const basePackage = require('../angular-base-package');
const typeScriptPackage = require('dgeni-packages/typescript');
const { API_SOURCE_PATH, requireFolder } = require('../config');
module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
// Register the processors
.processor(require('./processors/convertPrivateClassesToInterfaces'))
.processor(require('./processors/generateApiListDoc'))
.processor(require('./processors/addNotYetDocumentedProperty'))
.processor(require('./processors/mergeDecoratorDocs'))
.processor(require('./processors/extractDecoratedClasses'))
.processor(require('./processors/matchUpDirectiveDecorators'))
.processor(require('./processors/filterMemberDocs'))
.processor(require('./processors/markBarredODocsAsPrivate'))
.processor(require('./processors/filterPrivateDocs'))
.processor(require('./processors/filterIgnoredDocs'))
// Where do we get the source files?
.config(function(readTypeScriptModules, readFilesProcessor, collectExamples) {
// API files are typescript
readTypeScriptModules.basePath = API_SOURCE_PATH;
readTypeScriptModules.ignoreExportsMatching = [/^[_ɵ]/];
readTypeScriptModules.hidePrivateMembers = true;
readTypeScriptModules.sourceFiles = [
'common/index.ts',
'common/testing/index.ts',
'core/index.ts',
'core/testing/index.ts',
'forms/index.ts',
'http/index.ts',
'http/testing/index.ts',
'platform-browser/index.ts',
'platform-browser/testing/index.ts',
'platform-browser-dynamic/index.ts',
'platform-browser-dynamic/testing/index.ts',
'platform-server/index.ts',
'platform-server/testing/index.ts',
'platform-webworker/index.ts',
'platform-webworker-dynamic/index.ts',
'router/index.ts',
'router/testing/index.ts',
'upgrade/index.ts',
'upgrade/static.ts',
];
// API Examples
readFilesProcessor.sourceFiles = [
{
basePath: API_SOURCE_PATH,
include: API_SOURCE_PATH + '/examples/**/*',
fileReader: 'exampleFileReader'
}
];
collectExamples.exampleFolders.push('examples');
})
// Ignore certain problematic files
.config(function(filterIgnoredDocs) {
filterIgnoredDocs.ignore = [
/\/VERSION$/ // Ignore the `VERSION` const, since it would be written to the same file as the `Version` class
];
})
// Configure jsdoc-style tag parsing
.config(function(parseTagsProcessor, getInjectables) {
// Load up all the tag definitions in the tag-defs folder
parseTagsProcessor.tagDefinitions =
parseTagsProcessor.tagDefinitions.concat(getInjectables(requireFolder(__dirname, './tag-defs')));
// We actually don't want to parse param docs in this package as we are getting the data out using TS
// TODO: rewire the param docs to the params extracted from TS
parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
if (tagDef.name === 'param') {
tagDef.docProperty = 'paramData';
tagDef.transforms = [];
}
});
})
.config(function(computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc) {
const API_SEGMENT = 'api';
generateApiListDoc.outputFolder = API_SEGMENT;
computePathsProcessor.pathTemplates.push({
docTypes: ['module'],
getPath: function computeModulePath(doc) {
doc.moduleFolder = `${API_SEGMENT}/${doc.id.replace(/\/index$/, '')}`;
return doc.moduleFolder;
},
outputPathTemplate: '${moduleFolder}.json'
});
computePathsProcessor.pathTemplates.push({
docTypes: EXPORT_DOC_TYPES.concat(['decorator', 'directive', 'pipe']),
pathTemplate: '${moduleDoc.moduleFolder}/${name}',
outputPathTemplate: '${moduleDoc.moduleFolder}/${name}.json',
});
})
.config(function(convertToJsonProcessor, EXPORT_DOC_TYPES) {
const DOCS_TO_CONVERT = EXPORT_DOC_TYPES.concat([
'decorator', 'directive', 'pipe', 'module'
]);
convertToJsonProcessor.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
});

View File

@ -5,7 +5,7 @@ describe('addNotYetDocumentedProperty', function() {
var dgeni, injector, processor; var dgeni, injector, processor;
beforeEach(function() { beforeEach(function() {
dgeni = new Dgeni([testPackage('angular.io-package')]); dgeni = new Dgeni([testPackage('angular-api-package')]);
injector = dgeni.configureInjector(); injector = dgeni.configureInjector();
processor = injector.get('addNotYetDocumentedProperty'); processor = injector.get('addNotYetDocumentedProperty');
}); });

View File

@ -5,7 +5,7 @@ describe('extractDecoratedClasses processor', function() {
var dgeni, injector, processor; var dgeni, injector, processor;
beforeEach(function() { beforeEach(function() {
dgeni = new Dgeni([testPackage('angular.io-package')]); dgeni = new Dgeni([testPackage('angular-api-package')]);
injector = dgeni.configureInjector(); injector = dgeni.configureInjector();
processor = injector.get('extractDecoratedClassesProcessor'); processor = injector.get('extractDecoratedClassesProcessor');
}); });

View File

@ -5,7 +5,7 @@ const Dgeni = require('dgeni');
describe('filterIgnoredDocs processor', () => { describe('filterIgnoredDocs processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular.io-package')]); const dgeni = new Dgeni([testPackage('angular-api-package')]);
const injector = dgeni.configureInjector(); const injector = dgeni.configureInjector();
const processor = injector.get('filterIgnoredDocs'); const processor = injector.get('filterIgnoredDocs');
expect(processor.$process).toBeDefined(); expect(processor.$process).toBeDefined();

View File

@ -5,7 +5,7 @@ const Dgeni = require('dgeni');
describe('filterPrivateDocs processor', () => { describe('filterPrivateDocs processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular.io-package')]); const dgeni = new Dgeni([testPackage('angular-api-package')]);
const injector = dgeni.configureInjector(); const injector = dgeni.configureInjector();
const processor = injector.get('filterPrivateDocs'); const processor = injector.get('filterPrivateDocs');
expect(processor.$process).toBeDefined(); expect(processor.$process).toBeDefined();

View File

@ -5,7 +5,7 @@ const Dgeni = require('dgeni');
describe('generateApiListDoc processor', () => { describe('generateApiListDoc processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular.io-package')]); const dgeni = new Dgeni([testPackage('angular-api-package')]);
const injector = dgeni.configureInjector(); const injector = dgeni.configureInjector();
const processor = injector.get('generateApiListDoc'); const processor = injector.get('generateApiListDoc');
expect(processor.$process).toBeDefined(); expect(processor.$process).toBeDefined();

View File

@ -5,7 +5,7 @@ const Dgeni = require('dgeni');
describe('generateApiListDoc processor', () => { describe('generateApiListDoc processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular.io-package')]); const dgeni = new Dgeni([testPackage('angular-api-package')]);
const injector = dgeni.configureInjector(); const injector = dgeni.configureInjector();
const processor = injector.get('markBarredODocsAsPrivate'); const processor = injector.get('markBarredODocsAsPrivate');
expect(processor.$process).toBeDefined(); expect(processor.$process).toBeDefined();

View File

@ -5,7 +5,7 @@ describe('mergeDecoratorDocs processor', function() {
var dgeni, injector, processor, decoratorDoc, decoratorDocWithTypeAssertion, otherDoc; var dgeni, injector, processor, decoratorDoc, decoratorDocWithTypeAssertion, otherDoc;
beforeEach(function() { beforeEach(function() {
dgeni = new Dgeni([testPackage('angular.io-package')]); dgeni = new Dgeni([testPackage('angular-api-package')]);
injector = dgeni.configureInjector(); injector = dgeni.configureInjector();
processor = injector.get('mergeDecoratorDocs'); processor = injector.get('mergeDecoratorDocs');

View File

@ -0,0 +1,116 @@
/**
* @license
* Copyright Google Inc. 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
*/
const path = require('path');
const Package = require('dgeni').Package;
const jsdocPackage = require('dgeni-packages/jsdoc');
const nunjucksPackage = require('dgeni-packages/nunjucks');
const linksPackage = require('../links-package');
const examplesPackage = require('../examples-package');
const targetPackage = require('../target-package');
const remarkPackage = require('../remark-package');
const { PROJECT_ROOT, DOCS_OUTPUT_PATH, TEMPLATES_PATH, requireFolder } = require('../config');
module.exports = new Package('angular-base', [
jsdocPackage, nunjucksPackage, linksPackage, examplesPackage, targetPackage, remarkPackage
])
// Register the processors
.processor(require('./processors/generateKeywords'))
.processor(require('./processors/createOverviewDump'))
.processor(require('./processors/checkUnbalancedBackTicks'))
.processor(require('./processors/convertToJson'))
.processor(require('./processors/fixInternalDocumentLinks'))
// overrides base packageInfo and returns the one for the 'angular/angular' repo.
.factory('packageInfo', function() { return require(path.resolve(PROJECT_ROOT, 'package.json')); })
.factory(require('./readers/json'))
.config(function(checkAnchorLinksProcessor) {
// TODO: re-enable
checkAnchorLinksProcessor.$enabled = false;
})
// Where do we get the source files?
.config(function(readFilesProcessor, collectExamples, generateKeywordsProcessor, jsonFileReader) {
readFilesProcessor.fileReaders.push(jsonFileReader);
readFilesProcessor.basePath = PROJECT_ROOT;
readFilesProcessor.sourceFiles = [];
collectExamples.exampleFolders = [];
generateKeywordsProcessor.ignoreWordsFile = path.resolve(__dirname, 'ignore.words');
generateKeywordsProcessor.docTypesToIgnore = ['example-region'];
})
// Where do we write the output files?
.config(function(writeFilesProcessor) { writeFilesProcessor.outputFolder = DOCS_OUTPUT_PATH; })
// Target environments
.config(function(targetEnvironments) {
const ALLOWED_LANGUAGES = ['ts', 'js', 'dart'];
const TARGET_LANGUAGE = 'ts';
ALLOWED_LANGUAGES.forEach(target => targetEnvironments.addAllowed(target));
targetEnvironments.activate(TARGET_LANGUAGE);
})
// Configure nunjucks rendering of docs via templates
.config(function(
renderDocsProcessor, templateFinder, templateEngine, getInjectables) {
// Where to find the templates for the doc rendering
templateFinder.templateFolders = [TEMPLATES_PATH];
// Standard patterns for matching docs to templates
templateFinder.templatePatterns = [
'${ doc.template }', '${ doc.id }.${ doc.docType }.template.html',
'${ doc.id }.template.html', '${ doc.docType }.template.html',
'${ doc.id }.${ doc.docType }.template.js', '${ doc.id }.template.js',
'${ doc.docType }.template.js', '${ doc.id }.${ doc.docType }.template.json',
'${ doc.id }.template.json', '${ doc.docType }.template.json', 'common.template.html'
];
// Nunjucks and Angular conflict in their template bindings so change Nunjucks
templateEngine.config.tags = {variableStart: '{$', variableEnd: '$}'};
templateEngine.filters =
templateEngine.filters.concat(getInjectables(requireFolder(__dirname, './rendering')));
// helpers are made available to the nunjucks templates
renderDocsProcessor.helpers.relativePath = function(from, to) {
return path.relative(from, to);
};
})
// We are not going to be relaxed about ambiguous links
.config(function(getLinkInfo) {
getLinkInfo.useFirstAmbiguousLink = false;
})
.config(function(computePathsProcessor, generateKeywordsProcessor) {
generateKeywordsProcessor.outputFolder = 'app';
// Replace any path templates inherited from other packages
// (we want full and transparent control)
computePathsProcessor.pathTemplates = [
{docTypes: ['example-region'], getOutputPath: function() {}},
];
})
.config(function(convertToJsonProcessor) {
convertToJsonProcessor.docTypes = [];
});

View File

@ -5,7 +5,7 @@ describe('checkUnbalancedBackTicks', function() {
var dgeni, injector, processor, log; var dgeni, injector, processor, log;
beforeEach(function() { beforeEach(function() {
dgeni = new Dgeni([testPackage('angular.io-package')]); dgeni = new Dgeni([testPackage('angular-base-package')]);
injector = dgeni.configureInjector(); injector = dgeni.configureInjector();
processor = injector.get('checkUnbalancedBackTicks'); processor = injector.get('checkUnbalancedBackTicks');
log = injector.get('log'); log = injector.get('log');

View File

@ -5,7 +5,7 @@ describe('convertToJson processor', () => {
var dgeni, injector, processor, log; var dgeni, injector, processor, log;
beforeAll(function() { beforeAll(function() {
dgeni = new Dgeni([testPackage('angular.io-package')]); dgeni = new Dgeni([testPackage('angular-base-package')]);
injector = dgeni.configureInjector(); injector = dgeni.configureInjector();
processor = injector.get('convertToJsonProcessor'); processor = injector.get('convertToJsonProcessor');
log = injector.get('log'); log = injector.get('log');

View File

@ -5,7 +5,7 @@ const Dgeni = require('dgeni');
describe('fixInternalDocumentLinks processor', () => { describe('fixInternalDocumentLinks processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular.io-package')]); const dgeni = new Dgeni([testPackage('angular-base-package')]);
const injector = dgeni.configureInjector(); const injector = dgeni.configureInjector();
const processor = injector.get('fixInternalDocumentLinks'); const processor = injector.get('fixInternalDocumentLinks');
expect(processor.$process).toBeDefined(); expect(processor.$process).toBeDefined();

View File

@ -10,7 +10,7 @@ const mockReadFilesProcessor = {
describe('generateKeywords processor', () => { describe('generateKeywords processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular.io-package')]); const dgeni = new Dgeni([testPackage('angular-base-package')]);
const injector = dgeni.configureInjector(); const injector = dgeni.configureInjector();
const processor = injector.get('generateKeywordsProcessor'); const processor = injector.get('generateKeywordsProcessor');
expect(processor.$process).toBeDefined(); expect(processor.$process).toBeDefined();

View File

@ -0,0 +1,117 @@
/**
* @license
* Copyright Google Inc. 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
*/
const path = require('path');
const Package = require('dgeni').Package;
const basePackage = require('../angular-base-package');
const contentPackage = require('../content-package');
const { CONTENTS_PATH, OUTPUT_PATH } = require('../config');
module.exports = new Package('angular-content', [basePackage, contentPackage])
// Register the processors
.processor(require('./processors/copyContentAssets'))
.factory(require('./services/copyFolder'))
// Where do we get the source files?
.config(function(readFilesProcessor, collectExamples, copyContentAssetsProcessor) {
readFilesProcessor.sourceFiles = readFilesProcessor.sourceFiles.concat([
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/{cookbook,guide,tutorial}/**/*.md',
fileReader: 'contentFileReader'
},
{
basePath: CONTENTS_PATH + '/marketing',
include: CONTENTS_PATH + '/marketing/**/*.{html,md}',
fileReader: 'contentFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/*.md',
exclude: [CONTENTS_PATH + '/index.md'],
fileReader: 'contentFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/examples/**/*',
exclude: [
'**/*plnkr.no-link.html',
'**/node_modules/**',
// boilerplate files
'**/*/src/systemjs-angular-loader.js',
'**/*/src/systemjs.config.js',
'**/*/src/tsconfig.json',
'**/*/bs-config.e2e.json',
'**/*/bs-config.json',
'**/*/package.json',
'**/*/tslint.json',
// example files
'**/_test-output',
'**/protractor-helpers.js',
'**/e2e-spec.js',
'**/ts/**/*.js',
'**/js-es6*/**/*.js',
'**/ts-snippets/**/*.js',
],
fileReader: 'exampleFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/navigation.json',
fileReader: 'jsonFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/marketing/contributors.json',
fileReader: 'jsonFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/marketing/resources.json',
fileReader: 'jsonFileReader'
},
]);
collectExamples.exampleFolders.push('examples');
copyContentAssetsProcessor.assetMappings.push(
{ from: path.resolve(CONTENTS_PATH, 'images'), to: path.resolve(OUTPUT_PATH, 'images') }
);
})
// Configure jsdoc-style tag parsing
.config(function(inlineTagProcessor) {
inlineTagProcessor.inlineTagDefinitions.push(require('./inline-tag-defs/anchor'));
})
.config(function(computePathsProcessor) {
// Replace any path templates inherited from other packages
// (we want full and transparent control)
computePathsProcessor.pathTemplates = computePathsProcessor.pathTemplates.concat([
{
docTypes: ['content'],
getPath: (doc) => `${doc.id.replace(/\/index$/, '')}`,
outputPathTemplate: '${path}.json'
},
{docTypes: ['navigation-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['contributors-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['resources-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'}
]);
})
// We want the content files to be converted
.config(function(convertToJsonProcessor) {
convertToJsonProcessor.docTypes.push('content');
});

View File

@ -6,7 +6,7 @@ describe('extractDecoratedClasses processor', function() {
let dgeni, injector, processor; let dgeni, injector, processor;
beforeEach(function() { beforeEach(function() {
dgeni = new Dgeni([testPackage('angular.io-package')]); dgeni = new Dgeni([testPackage('angular-content-package')]);
injector = dgeni.configureInjector(); injector = dgeni.configureInjector();
processor = injector.get('copyContentAssetsProcessor'); processor = injector.get('copyContentAssetsProcessor');
}); });

View File

@ -5,303 +5,20 @@
* Use of this source code is governed by an MIT-style license that can be * 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 * found in the LICENSE file at https://angular.io/license
*/ */
const path = require('path');
const fs = require('fs');
const Package = require('dgeni').Package; const Package = require('dgeni').Package;
const jsdocPackage = require('dgeni-packages/jsdoc');
const nunjucksPackage = require('dgeni-packages/nunjucks');
const typescriptPackage = require('dgeni-packages/typescript');
const gitPackage = require('dgeni-packages/git'); const gitPackage = require('dgeni-packages/git');
const linksPackage = require('../links-package'); const apiPackage = require('../angular-api-package');
const examplesPackage = require('../examples-package'); const contentPackage = require('../angular-content-package');
const targetPackage = require('../target-package');
const contentPackage = require('../content-package');
const remarkPackage = require('../remark-package');
const PROJECT_ROOT = path.resolve(__dirname, '../../../..'); module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPackage])
const API_SOURCE_PATH = path.resolve(PROJECT_ROOT, 'packages');
const AIO_PATH = path.resolve(PROJECT_ROOT, 'aio');
const CONTENTS_PATH = path.resolve(AIO_PATH, 'content');
const TEMPLATES_PATH = path.resolve(AIO_PATH, 'tools/transforms/templates');
const OUTPUT_PATH = path.resolve(AIO_PATH, 'src/content');
const DOCS_OUTPUT_PATH = path.resolve(OUTPUT_PATH, 'docs');
module.exports = // This processor relies upon the versionInfo. See below...
new Package( .processor(require('./processors/processNavigationMap'))
'angular.io', [
jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage, examplesPackage,
gitPackage, targetPackage, contentPackage, remarkPackage
])
// Register the processors // We don't include this in the angular-base package because the `versionInfo` stuff
.processor(require('./processors/convertPrivateClassesToInterfaces')) // accesses the file system and git, which is slow.
.processor(require('./processors/generateApiListDoc')) .config(function(renderDocsProcessor, versionInfo) {
.processor(require('./processors/generateKeywords')) // Add the version data to the renderer, for use in things like github links
.processor(require('./processors/createOverviewDump')) renderDocsProcessor.extraData.versionInfo = versionInfo;
.processor(require('./processors/checkUnbalancedBackTicks'))
.processor(require('./processors/addNotYetDocumentedProperty'))
.processor(require('./processors/mergeDecoratorDocs'))
.processor(require('./processors/extractDecoratedClasses'))
.processor(require('./processors/matchUpDirectiveDecorators'))
.processor(require('./processors/filterMemberDocs'))
.processor(require('./processors/convertToJson'))
.processor(require('./processors/markBarredODocsAsPrivate'))
.processor(require('./processors/filterPrivateDocs'))
.processor(require('./processors/filterIgnoredDocs'))
.processor(require('./processors/fixInternalDocumentLinks'))
.processor(require('./processors/processNavigationMap'))
.processor(require('./processors/copyContentAssets'))
// overrides base packageInfo and returns the one for the 'angular/angular' repo. });
.factory('packageInfo', function() { return require(path.resolve(PROJECT_ROOT, 'package.json')); })
.factory(require('./readers/json'))
.factory(require('./services/copyFolder'))
.config(function(checkAnchorLinksProcessor) {
// TODO: re-enable
checkAnchorLinksProcessor.$enabled = false;
})
// Where do we get the source files?
.config(function(
readTypeScriptModules, readFilesProcessor, collectExamples, generateKeywordsProcessor, jsonFileReader) {
// API files are typescript
readTypeScriptModules.basePath = API_SOURCE_PATH;
readTypeScriptModules.ignoreExportsMatching = [/^_/];
readTypeScriptModules.hidePrivateMembers = true;
readFilesProcessor.fileReaders.push(jsonFileReader);
readTypeScriptModules.sourceFiles = [
'common/index.ts',
'common/testing/index.ts',
'core/index.ts',
'core/testing/index.ts',
'forms/index.ts',
'http/index.ts',
'http/testing/index.ts',
'platform-browser/index.ts',
'platform-browser/testing/index.ts',
'platform-browser-dynamic/index.ts',
'platform-browser-dynamic/testing/index.ts',
'platform-server/index.ts',
'platform-server/testing/index.ts',
'platform-webworker/index.ts',
'platform-webworker-dynamic/index.ts',
'router/index.ts',
'router/testing/index.ts',
'upgrade/index.ts',
'upgrade/static.ts',
];
readFilesProcessor.basePath = PROJECT_ROOT;
readFilesProcessor.sourceFiles = [
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/{cookbook,guide,tutorial}/**/*.md',
fileReader: 'contentFileReader'
},
{
basePath: CONTENTS_PATH + '/marketing',
include: CONTENTS_PATH + '/marketing/**/*.{html,md}',
fileReader: 'contentFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/*.md',
exclude: [CONTENTS_PATH + '/index.md'],
fileReader: 'contentFileReader'
},
{
basePath: API_SOURCE_PATH,
include: API_SOURCE_PATH + '/examples/**/*',
fileReader: 'exampleFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/examples/**/*',
exclude: [
'**/*plnkr.no-link.html',
'**/node_modules/**',
// boilerplate files
'**/*/src/systemjs-angular-loader.js',
'**/*/src/systemjs.config.js',
'**/*/src/tsconfig.json',
'**/*/bs-config.e2e.json',
'**/*/bs-config.json',
'**/*/package.json',
'**/*/tslint.json',
// example files
'**/_test-output',
'**/protractor-helpers.js',
'**/e2e-spec.js',
'**/ts/**/*.js',
'**/js-es6*/**/*.js',
'**/ts-snippets/**/*.js',
],
fileReader: 'exampleFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/navigation.json',
fileReader: 'jsonFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/marketing/contributors.json',
fileReader: 'jsonFileReader'
},
{
basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/marketing/resources.json',
fileReader: 'jsonFileReader'
},
];
collectExamples.exampleFolders = ['examples', 'examples'];
generateKeywordsProcessor.ignoreWordsFile = 'aio/tools/transforms/angular.io-package/ignore.words';
generateKeywordsProcessor.docTypesToIgnore = ['example-region'];
})
// Ignore certain problematic files
.config(function(filterIgnoredDocs) {
filterIgnoredDocs.ignore = [
/\/VERSION$/ // Ignore the `VERSION` const, since it would be written to the same file as the `Version` class
];
})
// Where do we write the output files?
.config(function(writeFilesProcessor) { writeFilesProcessor.outputFolder = DOCS_OUTPUT_PATH; })
// Target environments
.config(function(targetEnvironments) {
const ALLOWED_LANGUAGES = ['ts', 'js', 'dart'];
const TARGET_LANGUAGE = 'ts';
ALLOWED_LANGUAGES.forEach(target => targetEnvironments.addAllowed(target));
targetEnvironments.activate(TARGET_LANGUAGE);
// TODO: we may need to do something with `linkDocsInlineTagDef`
})
// Configure jsdoc-style tag parsing
.config(function(parseTagsProcessor, getInjectables, inlineTagProcessor) {
// Load up all the tag definitions in the tag-defs folder
parseTagsProcessor.tagDefinitions =
parseTagsProcessor.tagDefinitions.concat(getInjectables(requireFolder('./tag-defs')));
// We actually don't want to parse param docs in this package as we are getting the data
// out using TS
// TODO: rewire the param docs to the params extracted from TS
parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
if (tagDef.name === 'param') {
tagDef.docProperty = 'paramData';
tagDef.transforms = [];
}
});
inlineTagProcessor.inlineTagDefinitions.push(require('./inline-tag-defs/anchor'));
})
// Configure nunjucks rendering of docs via templates
.config(function(
renderDocsProcessor, versionInfo, templateFinder, templateEngine, getInjectables) {
// Where to find the templates for the doc rendering
templateFinder.templateFolders = [TEMPLATES_PATH];
// Standard patterns for matching docs to templates
templateFinder.templatePatterns = [
'${ doc.template }', '${ doc.id }.${ doc.docType }.template.html',
'${ doc.id }.template.html', '${ doc.docType }.template.html',
'${ doc.id }.${ doc.docType }.template.js', '${ doc.id }.template.js',
'${ doc.docType }.template.js', '${ doc.id }.${ doc.docType }.template.json',
'${ doc.id }.template.json', '${ doc.docType }.template.json', 'common.template.html'
];
// Nunjucks and Angular conflict in their template bindings so change Nunjucks
templateEngine.config.tags = {variableStart: '{$', variableEnd: '$}'};
templateEngine.filters =
templateEngine.filters.concat(getInjectables(requireFolder('./rendering')));
// Add the version data to the renderer, for use in things like github links
renderDocsProcessor.extraData.versionInfo = versionInfo;
// helpers are made available to the nunjucks templates
renderDocsProcessor.helpers.relativePath = function(from, to) {
return path.relative(from, to);
};
})
// We are not going to be relaxed about ambiguous links
.config(function(getLinkInfo) {
getLinkInfo.useFirstAmbiguousLink = false;
})
.config(function(
computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc,
generateKeywordsProcessor) {
const API_SEGMENT = 'api';
const APP_SEGMENT = 'app';
generateApiListDoc.outputFolder = API_SEGMENT;
generateKeywordsProcessor.outputFolder = APP_SEGMENT;
// Replace any path templates inherited from other packages
// (we want full and transparent control)
computePathsProcessor.pathTemplates = [
{
docTypes: ['module'],
getPath: function computeModulePath(doc) {
doc.moduleFolder = `${API_SEGMENT}/${doc.id.replace(/\/index$/, '')}`;
return doc.moduleFolder;
},
outputPathTemplate: '${moduleFolder}.json'
},
{
docTypes: EXPORT_DOC_TYPES.concat(['decorator', 'directive', 'pipe']),
pathTemplate: '${moduleDoc.moduleFolder}/${name}',
outputPathTemplate: '${moduleDoc.moduleFolder}/${name}.json',
},
{docTypes: ['example-region'], getOutputPath: function() {}},
{
docTypes: ['content'],
getPath: (doc) => `${doc.id.replace(/\/index$/, '')}`,
outputPathTemplate: '${path}.json'
},
{docTypes: ['navigation-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['contributors-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['resources-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'}
];
})
.config(function(convertToJsonProcessor, EXPORT_DOC_TYPES) {
convertToJsonProcessor.docTypes = EXPORT_DOC_TYPES.concat([
'content', 'decorator', 'directive', 'pipe', 'module'
]);
})
.config(function(copyContentAssetsProcessor) {
copyContentAssetsProcessor.assetMappings.push(
{ from: path.resolve(CONTENTS_PATH, 'images'), to: path.resolve(OUTPUT_PATH, 'images') }
);
});
function requireFolder(folderPath) {
const absolutePath = path.resolve(__dirname, folderPath);
return fs.readdirSync(absolutePath)
.filter(p => !/[._]spec\.js$/.test(p)) // ignore spec files
.map(p => require(path.resolve(absolutePath, p)));
}

View File

@ -6,7 +6,9 @@
* found in the LICENSE file at https://angular.io/license * found in the LICENSE file at https://angular.io/license
*/ */
const Package = require('dgeni').Package; const Package = require('dgeni').Package;
const { basePackage, API_SOURCE_PATH } = require('./base-package'); const apiPackage = require('../angular-api-package');
const { API_SOURCE_PATH } = require('../config');
const packageMap = { const packageMap = {
common: ['common/index.ts', 'common/testing/index.ts'], common: ['common/index.ts', 'common/testing/index.ts'],
core: ['core/index.ts', 'core/testing/index.ts'], core: ['core/index.ts', 'core/testing/index.ts'],
@ -20,22 +22,12 @@ const packageMap = {
router: ['router/index.ts', 'router/testing/index.ts'], router: ['router/index.ts', 'router/testing/index.ts'],
upgrade: ['upgrade/index.ts', 'upgrade/static.ts'] upgrade: ['upgrade/index.ts', 'upgrade/static.ts']
}; };
function createPackage(packageName) { function createPackage(packageName) {
return new Package('author-api', [require('dgeni-packages/typescript'), basePackage]) return new Package('author-api', [apiPackage])
.processor(require('../angular.io-package/processors/convertPrivateClassesToInterfaces'))
.processor(require('../angular.io-package/processors/mergeDecoratorDocs'))
.processor(require('../angular.io-package/processors/extractDecoratedClasses'))
.processor(require('../angular.io-package/processors/matchUpDirectiveDecorators'))
.processor(require('../angular.io-package/processors/filterMemberDocs'))
.processor(require('../angular.io-package/processors/markBarredODocsAsPrivate'))
.processor(require('../angular.io-package/processors/filterPrivateDocs'))
.processor(require('../angular.io-package/processors/filterIgnoredDocs'))
.config(function(readTypeScriptModules) { .config(function(readTypeScriptModules) {
// API files are typescript
readTypeScriptModules.basePath = API_SOURCE_PATH;
readTypeScriptModules.ignoreExportsMatching = [/^_/];
readTypeScriptModules.hidePrivateMembers = true;
readTypeScriptModules.sourceFiles = packageMap[packageName]; readTypeScriptModules.sourceFiles = packageMap[packageName];
}) })
.config(function(readFilesProcessor) { .config(function(readFilesProcessor) {
@ -46,43 +38,6 @@ function createPackage(packageName) {
fileReader: 'exampleFileReader' fileReader: 'exampleFileReader'
} }
]; ];
})
.config(function(
computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) {
const API_SEGMENT = 'api';
// Replace any path templates inherited from other packages
// (we want full and transparent control)
computePathsProcessor.pathTemplates = [
{
docTypes: ['module'],
getPath: function computeModulePath(doc) {
doc.moduleFolder = `${API_SEGMENT}/${doc.id.replace(/\/index$/, '')}`;
return doc.moduleFolder;
},
outputPathTemplate: '${moduleFolder}.json'
},
{
docTypes: EXPORT_DOC_TYPES.concat(['decorator', 'directive', 'pipe']),
pathTemplate: '${moduleDoc.moduleFolder}/${name}',
outputPathTemplate: '${moduleDoc.moduleFolder}/${name}.json',
},
{docTypes: ['example-region'], getOutputPath: function() {}},
{
docTypes: ['content'],
getPath: (doc) => `${doc.id.replace(/\/index$/, '')}`,
outputPathTemplate: '${path}.json'
},
{docTypes: ['navigation-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['contributors-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'}
];
})
.config(function(convertToJsonProcessor, EXPORT_DOC_TYPES) {
convertToJsonProcessor.docTypes = EXPORT_DOC_TYPES.concat([
'content', 'decorator', 'directive', 'pipe', 'module'
]);
}); });
} }

View File

@ -1,194 +0,0 @@
/**
* @license
* Copyright Google Inc. 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" */
const path = require('path');
const fs = require('fs');
const Package = require('dgeni').Package;
const jsdocPackage = require('dgeni-packages/jsdoc');
const nunjucksPackage = require('dgeni-packages/nunjucks');
const linksPackage = require('../links-package');
const examplesPackage = require('../examples-package');
const targetPackage = require('../target-package');
const contentPackage = require('../content-package');
const remarkPackage = require('../remark-package');
const PROJECT_ROOT = path.resolve(__dirname, '../../../..');
const API_SOURCE_PATH = path.resolve(PROJECT_ROOT, 'packages');
const AIO_PATH = path.resolve(PROJECT_ROOT, 'aio');
const CONTENTS_PATH = path.resolve(AIO_PATH, 'content');
const TEMPLATES_PATH = path.resolve(AIO_PATH, 'tools/transforms/templates');
const OUTPUT_PATH = path.resolve(AIO_PATH, 'src/content');
const DOCS_OUTPUT_PATH = path.resolve(OUTPUT_PATH, 'docs');
const basePackage = new Package('authors-base', [
jsdocPackage, nunjucksPackage, linksPackage, examplesPackage,
targetPackage, contentPackage, remarkPackage
])
// Register the processors
.processor(require('../angular.io-package/processors/checkUnbalancedBackTicks'))
.processor(require('../angular.io-package/processors/convertToJson'))
.processor(require('../angular.io-package/processors/fixInternalDocumentLinks'))
.processor(require('../angular.io-package/processors/copyContentAssets'))
// overrides base packageInfo and returns the one for the 'angular/angular' repo.
.factory('packageInfo', function() { return require(path.resolve(PROJECT_ROOT, 'package.json')); })
.factory(require('../angular.io-package/readers/json'))
.factory(require('../angular.io-package/services/copyFolder'))
.config(function(checkAnchorLinksProcessor) {
// TODO: re-enable
checkAnchorLinksProcessor.$enabled = false;
})
// Where do we get the source files?
.config(function(readFilesProcessor, collectExamples, jsonFileReader) {
readFilesProcessor.basePath = PROJECT_ROOT;
readFilesProcessor.fileReaders.push(jsonFileReader);
collectExamples.exampleFolders = ['examples'];
})
// Where do we write the output files?
.config(function(writeFilesProcessor) { writeFilesProcessor.outputFolder = DOCS_OUTPUT_PATH; })
// Target environments
// TODO: remove this stuff when we have no more target inline tags
.config(function(targetEnvironments) {
const ALLOWED_LANGUAGES = ['ts', 'js', 'dart'];
const TARGET_LANGUAGE = 'ts';
ALLOWED_LANGUAGES.forEach(target => targetEnvironments.addAllowed(target));
targetEnvironments.activate(TARGET_LANGUAGE);
})
// Configure jsdoc-style tag parsing
.config(function(parseTagsProcessor, getInjectables, inlineTagProcessor) {
// Load up all the tag definitions in the tag-defs folder
parseTagsProcessor.tagDefinitions =
parseTagsProcessor.tagDefinitions.concat(getInjectables(requireFolder('../angular.io-package/tag-defs')));
// We actually don't want to parse param docs in this package as we are getting the data
// out using TS
// TODO: rewire the param docs to the params extracted from TS
parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
if (tagDef.name === 'param') {
tagDef.docProperty = 'paramData';
tagDef.transforms = [];
}
});
inlineTagProcessor.inlineTagDefinitions.push(require('../angular.io-package/inline-tag-defs/anchor'));
})
// Configure nunjucks rendering of docs via templates
.config(function(
renderDocsProcessor, templateFinder, templateEngine, getInjectables) {
// Where to find the templates for the doc rendering
templateFinder.templateFolders = [TEMPLATES_PATH];
// Standard patterns for matching docs to templates
templateFinder.templatePatterns = [
'${ doc.template }', '${ doc.id }.${ doc.docType }.template.html',
'${ doc.id }.template.html', '${ doc.docType }.template.html',
'${ doc.id }.${ doc.docType }.template.js', '${ doc.id }.template.js',
'${ doc.docType }.template.js', '${ doc.id }.${ doc.docType }.template.json',
'${ doc.id }.template.json', '${ doc.docType }.template.json', 'common.template.html'
];
// Nunjucks and Angular conflict in their template bindings so change Nunjucks
templateEngine.config.tags = {variableStart: '{$', variableEnd: '$}'};
templateEngine.filters =
templateEngine.filters.concat(getInjectables(requireFolder('../angular.io-package/rendering')));
// helpers are made available to the nunjucks templates
renderDocsProcessor.helpers.relativePath = function(from, to) {
return path.relative(from, to);
};
})
// We are not going to be relaxed about ambiguous links
.config(function(getLinkInfo) {
getLinkInfo.useFirstAmbiguousLink = false;
})
.config(function(computeIdsProcessor, computePathsProcessor) {
// Replace any path templates inherited from other packages
// (we want full and transparent control)
computePathsProcessor.pathTemplates = [
{docTypes: ['example-region'], getOutputPath: function() {}},
{
docTypes: ['content'],
getPath: (doc) => `${doc.id.replace(/\/index$/, '')}`,
outputPathTemplate: '${path}.json'
},
{docTypes: ['navigation-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['contributors-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'},
{docTypes: ['resources-json'], pathTemplate: '${id}', outputPathTemplate: '../${id}.json'}
];
})
.config(function(convertToJsonProcessor) {
convertToJsonProcessor.docTypes = ['content'];
})
.config(function(copyContentAssetsProcessor) {
copyContentAssetsProcessor.assetMappings.push(
{ from: path.resolve(CONTENTS_PATH, 'images'), to: path.resolve(OUTPUT_PATH, 'images') }
);
});
function requireFolder(folderPath) {
const absolutePath = path.resolve(__dirname, folderPath);
return fs.readdirSync(absolutePath)
.filter(p => !/[._]spec\.js$/.test(p)) // ignore spec files
.map(p => require(path.resolve(absolutePath, p)));
}
function getBoilerPlateExcludes() {
return [
'**/*plnkr.no-link.html',
'**/node_modules/**',
// _boilerplate files
'**/_boilerplate/**',
'**/*/src/styles.css',
'**/*/src/systemjs-angular-loader.js',
'**/*/src/systemjs.config.js',
'**/*/src/tsconfig.json',
'**/*/bs-config.e2e.json',
'**/*/bs-config.json',
'**/*/package.json',
'**/*/tslint.json',
// example files
'**/_test-output',
'**/protractor-helpers.js',
'**/e2e-spec.js',
'**/ts/**/*.js',
'**/js-es6*/**/*.js',
'**/ts-snippets/**/*.js',
];
}
module.exports = {
basePackage,
PROJECT_ROOT,
API_SOURCE_PATH,
AIO_PATH,
CONTENTS_PATH,
TEMPLATES_PATH,
OUTPUT_PATH,
DOCS_OUTPUT_PATH,
requireFolder,
getBoilerPlateExcludes
};

View File

@ -9,9 +9,10 @@
/* eslint no-console: "off" */ /* eslint no-console: "off" */
const Package = require('dgeni').Package; const Package = require('dgeni').Package;
const { basePackage, CONTENTS_PATH } = require('./base-package'); const contentPackage = require('../angular-content-package');
const { readFileSync } = require('fs'); const { readFileSync } = require('fs');
const { resolve } = require('canonical-path'); const { resolve } = require('canonical-path');
const { CONTENTS_PATH } = require('../config');
function createPackage(guideName) { function createPackage(guideName) {
@ -25,7 +26,7 @@ function createPackage(guideName) {
console.log(examples.map(example => ' - ' + example).join('\n')); console.log(examples.map(example => ' - ' + example).join('\n'));
} }
return new Package('author-guide', [basePackage]) return new Package('author-guide', [contentPackage])
.config(function(readFilesProcessor) { .config(function(readFilesProcessor) {
readFilesProcessor.sourceFiles = [ readFilesProcessor.sourceFiles = [
{ {
@ -42,5 +43,4 @@ function createPackage(guideName) {
}); });
} }
module.exports = { createPackage }; module.exports = { createPackage };

View File

@ -14,18 +14,20 @@ function createPackage(changedFile) {
return require('./marketing-package').createPackage(); return require('./marketing-package').createPackage();
} }
const tutorialMatch = /^aio\/content\/tutorial\/|^aio\/content\/examples\/toh-\d/.exec(changedFile); const tutorialMatch = /^aio\/content\/tutorial\/([^.]+)\.md/.exec(changedFile);
if (tutorialMatch) { const tutorialExampleMatch = /^aio\/content\/examples\/(toh-[^\/]+)\//.exec(changedFile);
if (tutorialMatch || tutorialExampleMatch) {
const tutorialName = tutorialMatch && tutorialMatch[1] || tutorialExampleMatch[1];
console.log('Building tutorial docs'); console.log('Building tutorial docs');
return require('./tutorial-package').createPackage(); return require('./tutorial-package').createPackage(tutorialName);
} }
const guideMatch = /^aio\/content\/guide\/([^\.]+)\.md/.exec(changedFile); const guideMatch = /^aio\/content\/guide\/([^.]+)\.md/.exec(changedFile);
const exampleMatch = /^aio\/content\/examples\/(?:cb-)?([^\/]+)\//.exec(changedFile); const exampleMatch = /^aio\/content\/examples\/(?:cb-)?([^\/]+)\//.exec(changedFile);
if (guideMatch || exampleMatch) { if (guideMatch || exampleMatch) {
const exampleName = guideMatch && guideMatch[1] || exampleMatch[1]; const guideName = guideMatch && guideMatch[1] || exampleMatch[1];
console.log(`Building guide doc: ${exampleName}.md`); console.log(`Building guide doc: ${guideName}.md`);
return require('./guide-package').createPackage(exampleName); return require('./guide-package').createPackage(guideName);
} }
const apiExamplesMatch = /^packages\/examples\/([^\/]+)\//.exec(changedFile); const apiExamplesMatch = /^packages\/examples\/([^\/]+)\//.exec(changedFile);
@ -38,9 +40,13 @@ function createPackage(changedFile) {
} }
module.exports = { module.exports = {
generateDocs: function(changedFile) { generateDocs: function(changedFile, options = {}) {
const {Dgeni} = require('dgeni'); const {Dgeni} = require('dgeni');
var dgeni = new Dgeni([createPackage(changedFile)]); const package = createPackage(changedFile);
if (options.silent) {
package.config(function(log) { log.level = 'error'; });
}
var dgeni = new Dgeni([package]);
const start = Date.now(); const start = Date.now();
return dgeni.generate() return dgeni.generate()
.then( .then(

View File

@ -16,7 +16,7 @@ describe('authors-package', () => {
}); });
it('should generate marketing docs if the "fileChanged" is a marketing doc', (done) => { it('should generate marketing docs if the "fileChanged" is a marketing doc', (done) => {
generateDocs('aio/content/marketing/about.html').then(() => { generateDocs('aio/content/marketing/about.html', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'about.json')); expect(files).toContain(resolve(outputPath, 'about.json'));
expect(files).toContain(resolve(outputPath, '../navigation.json')); expect(files).toContain(resolve(outputPath, '../navigation.json'));
@ -27,49 +27,31 @@ describe('authors-package', () => {
}, 4000); }, 4000);
it('should generate tutorial docs if the "fileChanged" is a tutorial doc', (done) => { it('should generate tutorial docs if the "fileChanged" is a tutorial doc', (done) => {
generateDocs('aio/content/tutorial/toh-pt5.md').then(() => { generateDocs('aio/content/tutorial/toh-pt5.md', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'tutorial.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt1.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt2.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt3.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt4.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt5.json')); expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt5.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt6.json'));
done(); done();
}); });
}, 4000); }, 4000);
it('should generate tutorial docs if the "fileChanged" is the tutorial index', (done) => { it('should generate tutorial docs if the "fileChanged" is the tutorial index', (done) => {
generateDocs('aio/content/tutorial/index.md').then(() => { generateDocs('aio/content/tutorial/index.md', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'tutorial.json')); expect(files).toContain(resolve(outputPath, 'tutorial.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt1.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt2.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt3.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt4.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt5.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt6.json'));
done(); done();
}); });
}, 4000); }, 4000);
it('should generate tutorial docs if the "fileChanged" is a tutorial example', (done) => { it('should generate tutorial docs if the "fileChanged" is a tutorial example', (done) => {
generateDocs('aio/content/examples/toh-3/app/app.component.1.html').then(() => { generateDocs('aio/content/examples/toh-pt3/app/app.component.1.html', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'tutorial.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt1.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt2.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt3.json')); expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt3.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt4.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt5.json'));
expect(files).toContain(resolve(outputPath, 'tutorial/toh-pt6.json'));
done(); done();
}); });
}, 4000); }, 4000);
it('should generate guide doc if the "fileChanged" is a guide doc', (done) => { it('should generate guide doc if the "fileChanged" is a guide doc', (done) => {
generateDocs('aio/content/guide/architecture.md').then(() => { generateDocs('aio/content/guide/architecture.md', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'guide/architecture.json')); expect(files).toContain(resolve(outputPath, 'guide/architecture.json'));
done(); done();
@ -77,7 +59,7 @@ describe('authors-package', () => {
}, 4000); }, 4000);
it('should generate guide doc if the "fileChanged" is a guide example', (done) => { it('should generate guide doc if the "fileChanged" is a guide example', (done) => {
generateDocs('aio/content/examples/architecture/src/app/app.module.ts').then(() => { generateDocs('aio/content/examples/architecture/src/app/app.module.ts', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'guide/architecture.json')); expect(files).toContain(resolve(outputPath, 'guide/architecture.json'));
done(); done();
@ -85,7 +67,7 @@ describe('authors-package', () => {
}, 4000); }, 4000);
it('should generate API doc if the "fileChanged" is an API doc', (done) => { it('should generate API doc if the "fileChanged" is an API doc', (done) => {
generateDocs('packages/forms/src/form_builder.ts').then(() => { generateDocs('packages/forms/src/form_builder.ts', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'api/forms/FormBuilder.json')); expect(files).toContain(resolve(outputPath, 'api/forms/FormBuilder.json'));
done(); done();
@ -93,7 +75,7 @@ describe('authors-package', () => {
}, 4000); }, 4000);
it('should generate API doc if the "fileChanged" is an API example', (done) => { it('should generate API doc if the "fileChanged" is an API example', (done) => {
generateDocs('packages/examples/forms/ts/formBuilder/form_builder_example.ts').then(() => { generateDocs('packages/examples/forms/ts/formBuilder/form_builder_example.ts', { silent: true }).then(() => {
expect(fs.writeFile).toHaveBeenCalled(); expect(fs.writeFile).toHaveBeenCalled();
expect(files).toContain(resolve(outputPath, 'api/forms/FormBuilder.json')); expect(files).toContain(resolve(outputPath, 'api/forms/FormBuilder.json'));
done(); done();

View File

@ -6,10 +6,11 @@
* found in the LICENSE file at https://angular.io/license * found in the LICENSE file at https://angular.io/license
*/ */
const Package = require('dgeni').Package; const Package = require('dgeni').Package;
const { basePackage, CONTENTS_PATH } = require('./base-package'); const contentPackage = require('../angular-content-package');
const { CONTENTS_PATH } = require('../config');
function createPackage() { function createPackage() {
return new Package('author-marketing', [basePackage]) return new Package('author-marketing', [contentPackage])
.config(function(readFilesProcessor) { .config(function(readFilesProcessor) {
readFilesProcessor.sourceFiles = [ readFilesProcessor.sourceFiles = [
{ {

View File

@ -5,22 +5,38 @@
* Use of this source code is governed by an MIT-style license that can be * 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 * found in the LICENSE file at https://angular.io/license
*/ */
const Package = require('dgeni').Package;
const { basePackage, CONTENTS_PATH, getBoilerPlateExcludes } = require('./base-package');
function createPackage() { const Package = require('dgeni').Package;
return new Package('author-tutorial', [basePackage]) const contentPackage = require('../angular-content-package');
const { readFileSync } = require('fs');
const { resolve } = require('canonical-path');
const { CONTENTS_PATH } = require('../config');
/* eslint no-console: "off" */
function createPackage(tutorialName) {
const tutorialFilePath = `${CONTENTS_PATH}/tutorial/${tutorialName}.md`;
const tutorialFile = readFileSync(tutorialFilePath, 'utf8');
const examples = [];
tutorialFile.replace(/<code-(?:pane|example) [^>]*path="([^"]+)"/g, (_, path) => examples.push('examples/' + path));
if (examples.length) {
console.log('The following example files are referenced in this tutorial:');
console.log(examples.map(example => ' - ' + example).join('\n'));
}
return new Package('author-tutorial', [contentPackage])
.config(function(readFilesProcessor) { .config(function(readFilesProcessor) {
readFilesProcessor.sourceFiles = [ readFilesProcessor.sourceFiles = [
{ {
basePath: CONTENTS_PATH, basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/tutorial/**/*.md', include: tutorialFilePath,
fileReader: 'contentFileReader' fileReader: 'contentFileReader'
}, },
{ {
basePath: CONTENTS_PATH, basePath: CONTENTS_PATH,
include: CONTENTS_PATH + '/examples/toh-*/**/*', include: examples.map(example => resolve(CONTENTS_PATH, example)),
exclude: getBoilerPlateExcludes(),
fileReader: 'exampleFileReader' fileReader: 'exampleFileReader'
} }
]; ];

View File

@ -0,0 +1,20 @@
const { resolve } = require('path');
const { readdirSync } = require('fs');
const PROJECT_ROOT = resolve(__dirname, '../../..');
const AIO_PATH = resolve(PROJECT_ROOT, 'aio');
const TEMPLATES_PATH = resolve(AIO_PATH, 'tools/transforms/templates');
const CONTENTS_PATH = resolve(AIO_PATH, 'content');
const OUTPUT_PATH = resolve(AIO_PATH, 'src/content');
const DOCS_OUTPUT_PATH = resolve(OUTPUT_PATH, 'docs');
const API_SOURCE_PATH = resolve(PROJECT_ROOT, 'packages');
function requireFolder(dirname, folderPath) {
const absolutePath = resolve(dirname, folderPath);
return readdirSync(absolutePath)
.filter(p => !/[._]spec\.js$/.test(p)) // ignore spec files
.map(p => require(resolve(absolutePath, p)));
}
module.exports = { PROJECT_ROOT, AIO_PATH, TEMPLATES_PATH, CONTENTS_PATH, OUTPUT_PATH, DOCS_OUTPUT_PATH, API_SOURCE_PATH, requireFolder };

View File

@ -1,47 +1,39 @@
var Package = require('dgeni').Package; var Package = require('dgeni').Package;
var jsdocPackage = require('dgeni-packages/jsdoc'); var jsdocPackage = require('dgeni-packages/jsdoc');
var linksPackage = require('../links-package'); var linksPackage = require('../links-package');
var path = require('canonical-path'); var { requireFolder } = require('../config');
var fs = require('fs');
// Define the dgeni package for generating the docs // Define the dgeni package for generating the docs
module.exports = new Package('content', [jsdocPackage, linksPackage]) module.exports = new Package('content', [jsdocPackage, linksPackage])
// Register the services and file readers // Register the services and file readers
.factory(require('./readers/content')) .factory(require('./readers/content'))
// Configure file reading // Configure file reading
.config(function(readFilesProcessor, contentFileReader) { .config(function(readFilesProcessor, contentFileReader) {
readFilesProcessor.fileReaders.push(contentFileReader); readFilesProcessor.fileReaders.push(contentFileReader);
}) })
.config(function(parseTagsProcessor, getInjectables) { .config(function(parseTagsProcessor, getInjectables) {
parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat( parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat(
getInjectables(requireFolder('./tag-defs'))); getInjectables(requireFolder(__dirname, './tag-defs')));
}) })
// Configure ids and paths // Configure ids and paths
.config(function(computeIdsProcessor) { .config(function(computeIdsProcessor) {
computeIdsProcessor.idTemplates.push({ computeIdsProcessor.idTemplates.push({
docTypes: ['content'], docTypes: ['content'],
getId: function(doc) { getId: function(doc) {
return doc.fileInfo return doc.fileInfo
.relativePath .relativePath
// path should be relative to `modules` folder // path should be relative to `modules` folder
.replace(/.*\/?modules\//, '') .replace(/.*\/?modules\//, '')
// path should not include `/docs/` // path should not include `/docs/`
.replace(/\/docs\//, '/') .replace(/\/docs\//, '/')
// path should not have a suffix // path should not have a suffix
.replace(/\.\w*$/, ''); .replace(/\.\w*$/, '');
}, },
getAliases: function(doc) { return [doc.id]; } getAliases: function(doc) { return [doc.id]; }
}); });
}); });
function requireFolder(folderPath) {
const absolutePath = path.resolve(__dirname, folderPath);
return fs.readdirSync(absolutePath)
.filter(p => !/[._]spec\.js$/.test(p)) // ignore spec files
.map(p => require(path.resolve(absolutePath, p)));
}