skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

build(docs): fix directive metadata not showing up in docs (#13057)

Browse Source 
* Due to the recent update to TypeScript 3.0.0, the new TS version conflicts with the internal TypeScript version from `dgeni-packages`. This causes the selector, exported-as to not show up in the docs.
* Removes the selector blacklist and `md-`prefix filter. All of the blacklisted selectors have been removed (except the autosize selector; but the whole class has been deprecated now)
This commit is contained in:
Paul Gschwendtner
2018-09-11 01:06:36 +02:00
committed by Jeremy Elbourn
parent 05563d95f8
commit e1b040d0e1
2 changed files with 11 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/dgeni/common/decorators.ts
+1 -16
View File
@@ -3,19 +3,6 @@ import {PropertyMemberDoc} from 'dgeni-packages/typescript/api-doc-types/Propert
import {MemberDoc} from 'dgeni-packages/typescript/api-doc-types/MemberDoc';
import {CategorizedClassDoc, DeprecationDoc, HasDecoratorsDoc} from './dgeni-definitions';
/**
* We want to avoid emitting selectors that are deprecated but don't have a way to mark
* them as such in the source code. Thus, we maintain a separate blacklist of selectors
* that should not be emitted in the documentation.
*/
const SELECTOR_BLACKLIST = new Set([
'[portal]',
'[portalHost]',
'textarea[mat-autosize]',
'[overlay-origin]',
'[connected-overlay]',
]);
export function isMethod(doc: MemberDoc) {
return doc.hasOwnProperty('parameters') && !doc.isGetAccessor && !doc.isSetAccessor;
}
@@ -62,9 +49,7 @@ export function getDirectiveSelectors(classDoc: CategorizedClassDoc) {
const directiveSelectors: string = classDoc.directiveMetadata.get('selector');
if (directiveSelectors) {
// Filter blacklisted selectors and remove line-breaks in resolved selectors.
return directiveSelectors.replace(/[\r\n]/g, '').split(/\s*,\s*/)
.filter(s => s !== '' && !s.includes('md') && !SELECTOR_BLACKLIST.has(s));
return directiveSelectors.replace(/[\r\n]/g, '').split(/\s*,\s*/).filter(s => s !== '');
}
}
tools/dgeni/common/directive-metadata.ts
+10 -14
View File
@@ -1,13 +1,14 @@
import {CategorizedClassDoc} from './dgeni-definitions';
import {
ArrayLiteralExpression,
CallExpression,
isCallExpression,
NodeArray,
ObjectLiteralExpression,
PropertyAssignment,
StringLiteral,
SyntaxKind,
NodeArray,
} from 'typescript';
} from 'dgeni-packages/node_modules/typescript';
import {CategorizedClassDoc} from './dgeni-definitions';
/**
* Determines the component or directive metadata from the specified Dgeni class doc. The resolved
@@ -31,21 +32,16 @@ export function getDirectiveMetadata(classDoc: CategorizedClassDoc): Map<string,
return null;
}
const directiveDecorator = declaration.decorators
.filter(decorator => decorator.expression)
// TODO(devversion): fix this cast
.filter(decorator => (decorator.expression.kind as any) === SyntaxKind.CallExpression)
.find(decorator => (decorator.expression as any).expression.getText() === 'Component' ||
(decorator.expression as any).expression.getText() === 'Directive');
const expression = declaration.decorators
.filter(decorator => decorator.expression && isCallExpression(decorator.expression))
.map(decorator => decorator.expression as CallExpression)
.find(callExpression => callExpression.expression.getText() === 'Component' ||
callExpression.expression.getText() === 'Directive');
if (!directiveDecorator) {
if (!expression) {
return null;
}
// Since the actual decorator expression is by default a LeftHandSideExpression, and TypeScript
// doesn't allow a casting it to a CallExpression, we have to cast it to "any" before.
const expression = (directiveDecorator.expression as any) as CallExpression;
// The argument length of the CallExpression needs to be exactly one, because it's the single
// JSON object in the @Component/@Directive decorator.
if (expression.arguments.length !== 1) {