cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build(aio): compute stability and deprecate @stable tag (#22674)

Browse Source 
Closes #22635

PR Close #22674
This commit is contained in:
Pete Bacon Darwin
2018-03-09 08:26:11 +00:00
committed by Kara Erickson
parent bd9d4df735
commit 48636f3e85
4 changed files with 134 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
aio/tools/transforms/angular-api-package/index.js vendored
View File

@ -30,6 +30,24 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
.processor(require('./processors/filterPrivateDocs'))
.processor(require('./processors/computeSearchTitle'))
.processor(require('./processors/simplifyMemberAnchors'))
.processor(require('./processors/computeStability'))
/**
* These are the API doc types that will be rendered to actual files.
* This is a super set of the exported docs, since we convert some classes to
* more Angular specific API types, such as decorators and directives.
*/
.factory(function API_DOC_TYPES_TO_RENDER(EXPORT_DOC_TYPES) {
return EXPORT_DOC_TYPES.concat(['decorator', 'directive', 'pipe', 'module']);
})
/**
* These are the doc types that are API docs, including ones that will be merged into container docs,
* such as members and overloads.
*/
.factory(function API_DOC_TYPES(API_DOC_TYPES_TO_RENDER) {
return API_DOC_TYPES_TO_RENDER.concat(['member', 'function-overload']);
})
// Where do we get the source files?
.config(function(readTypeScriptModules, readFilesProcessor, collectExamples, tsParser) {
@ -92,9 +110,10 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
parseTagsProcessor.tagDefinitions.concat(getInjectables(requireFolder(__dirname, './tag-defs')));
})
.config(function(splitDescription, EXPORT_DOC_TYPES) {
.config(function(computeStability, splitDescription, EXPORT_DOC_TYPES, API_DOC_TYPES) {
computeStability.docTypes = EXPORT_DOC_TYPES;
// Only split the description on the API docs
splitDescription.docTypes = EXPORT_DOC_TYPES.concat(['member', 'function-overload']);
splitDescription.docTypes = API_DOC_TYPES;
})
.config(function(computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc) {
@ -124,12 +143,9 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
})
.config(function(convertToJsonProcessor, postProcessHtml, EXPORT_DOC_TYPES, autoLinkCode) {
const DOCS_TO_CONVERT = EXPORT_DOC_TYPES.concat([
'decorator', 'directive', 'pipe', 'module'
]);
convertToJsonProcessor.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
postProcessHtml.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
autoLinkCode.docTypes = DOCS_TO_CONVERT.concat(['member', 'function-overload']);
.config(function(convertToJsonProcessor, postProcessHtml, API_DOC_TYPES_TO_RENDER, API_DOC_TYPES, autoLinkCode) {
convertToJsonProcessor.docTypes = convertToJsonProcessor.docTypes.concat(API_DOC_TYPES_TO_RENDER);
postProcessHtml.docTypes = convertToJsonProcessor.docTypes.concat(API_DOC_TYPES_TO_RENDER);
autoLinkCode.docTypes = API_DOC_TYPES;
autoLinkCode.codeElements = ['code', 'code-example', 'code-pane'];
});