Skip to content

docs: Show directive selector in generated API docs #4139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 21, 2017
Merged

docs: Show directive selector in generated API docs #4139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e04c18
Merge pull request #1 from angular/master
Apr 18, 2017
6375c5b
docs: Show directive selector in generated API docs
jbh Apr 20, 2017
ef1dbe2
Recover categorizer
jbh Apr 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion tools/dgeni/processors/categorizer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
/**
* 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[md-autosize]',
'[overlay-origin]',
'[connected-overlay]',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can make this a Set instead of an array:

const SELECTOR_BLACKLIST = new Set([
  '[portal]',
  '[portalHost]',
  'textarea[md-autosize]',
  '[overlay-origin]',
  '[connected-overlay]',
]);

And then use SELECTOR_BLACKLIST.has(...) instead of includes

Copy link
Author

@jbh jbh Apr 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taken care of. Let me know if it's all up to par. Also, thanks for the tip.

]);

/**
* Processor to add properties to docs objects.
*
Expand Down Expand Up @@ -29,11 +42,12 @@ module.exports = function categorizer() {
classDoc.properties.forEach(doc => decoratePropertyDoc(doc));

decoratePublicDoc(classDoc);

// Categorize the current visited classDoc into its Angular type.
if (isDirective(classDoc)) {
classDoc.isDirective = true;
classDoc.directiveExportAs = getDirectiveExportAs(classDoc);
classDoc.directiveSelectors = getDirectiveSelectors(classDoc);
} else if (isService(classDoc)) {
classDoc.isService = true;
} else if (isNgModule(classDoc)) {
Expand Down Expand Up @@ -171,6 +185,18 @@ function getDirectiveOutputAlias(doc) {
return isDirectiveOutput(doc) ? doc.decorators.find(d => d.name == 'Output').arguments[0] : '';
}

function getDirectiveSelectors(classDoc) {
let metadata = classDoc.decorators
.find(d => d.name === 'Component' || d.name === 'Directive').arguments[0];

let selectorMatches = /selector\s*:\s*(?:"|')([^']*?)(?:"|')/g.exec(metadata);
selectorMatches = selectorMatches && selectorMatches[1];

return selectorMatches ? selectorMatches.split(/\s*,\s*/)
.filter(s => s !== '' && !s.includes('mat') && !SELECTOR_BLACKLIST.has(s))
: selectorMatches;
}

function getDirectiveExportAs(doc) {
let metadata = doc.decorators
.find(d => d.name === 'Component' || d.name === 'Directive').arguments[0];
Expand Down
11 changes: 10 additions & 1 deletion tools/dgeni/templates/class.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@ <h4 class="docs-api-h4 docs-api-class-name">
</h4>
<p class="docs-api-class-description">{$ class.description $}</p>

{%- if class.directiveSelectors -%}
<div class="docs-api-directive-selectors">
<span class="docs-api-class-selector-label">selector:</span>
{% for s in class.directiveSelectors %}
<span class="docs-api-class-selector-name">{$ s $}</span>
{% endfor %}
</div>
{%- endif -%}

{%- if class.directiveExportAs -%}
<span class="docs-api-h4 docs-api-class-export-label">Exported as:</span>
<span class="docs-api-class-export-name">{$ class.directiveExportAs $}</span>
{%- endif -%}

{%- if class.isDeprecated -%}
<div class="docs-api-class-deprecated-marker">Deprecated</div>
{%- endif -%}
{%- endif -%}

{$ propertyList(class.properties) $}

Expand Down