docs: Show directive selector in generated API docs #4139

jbh · 2017-04-18T14:57:56Z

Adds method to get directive selectors to categorizor.js
Adds selectors to class.template.html

Takes care of #3983

googlebot · 2017-04-18T14:57:59Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please let us know the company's name.

jbh · 2017-04-18T15:00:09Z

I signed it!

googlebot · 2017-04-18T15:00:12Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for the commit author(s). If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.

devversion · 2017-04-18T15:03:42Z

tools/dgeni/processors/categorizer.js

    // Categorize the current visited classDoc into its Angular type.
    if (isDirective(classDoc)) {
      classDoc.isDirective = true;
      classDoc.directiveExportAs = getDirectiveExportAs(classDoc);
+      classDoc.selectors = getDirectoveSelectors(classDoc);


directiveSelectors?

devversion · 2017-04-18T15:03:56Z

tools/dgeni/processors/categorizer.js

+    'textarea[md-autosize]',
+    '[overlay-origin]',
+    '[connected-overlay]',
+  ];


I think this should be a constant at the top of the file?

Good idea. I had thought of that, but decided to go with this since it seemed specific to this function. I'll make these changes once I get the CLA figured out.

devversion · 2017-04-18T15:06:24Z

tools/dgeni/processors/categorizer.js

+  if (selectorMatches) {
+    selectorMatches = selectorMatches.split(/\s*,\s*/);
+    selectorMatches = selectorMatches
+      .filter(match => match !== '' && !match.includes('mat') && blacklist.indexOf(match) === -1);


How about the following?

return selectorMatches.split(/\s*,\s*/) .filter(match => match && !match.includes('mat') && !blacklist.includes(match));

devversion · 2017-04-18T15:06:55Z

tools/dgeni/processors/categorizer.js

+      .filter(match => match !== '' && !match.includes('mat') && blacklist.indexOf(match) === -1);
+  }
+
+  return selectorMatches;


If you immediately return (as with comment above) then you can just remove that.

googlebot · 2017-04-18T16:30:48Z

CLAs look good, thanks!

Update from original

jelbourn · 2017-04-20T16:53:01Z

tools/dgeni/processors/categorizer.js

@@ -1,3 +1,11 @@
+const DIRECTIVE_SELECTOR_BLACKLIST = [


Add a comment like

/** * 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. */

jelbourn · 2017-04-20T17:01:04Z

tools/dgeni/processors/categorizer.js

+  '[portalHost]',
+  'textarea[md-autosize]',
+  '[overlay-origin]',
+  '[connected-overlay]',


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

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

jelbourn · 2017-04-20T17:03:13Z

tools/dgeni/processors/categorizer.js

+
+  return selectorMatches ? selectorMatches.split(/\s*,\s*/)
+    .filter(match => match !== '' && !match.includes('mat') && !DIRECTIVE_SELECTOR_BLACKLIST.includes(match))
+    : selectorMatches;


I'd shorten match to just s so that it's

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

jelbourn · 2017-04-20T17:05:44Z

tools/dgeni/templates/class.template.html

@@ -3,14 +3,21 @@ <h4 class="docs-api-h4 docs-api-class-name">
 </h4>
 <p class="docs-api-class-description">{$ class.description $}</p>

+{%- if class.directiveSelectors -%}
+<span class="docs-api-h4 docs-api-class-selector-label">Selectors:</span>


Selectors: -> selector:

I'd like it to match what's in the source

jelbourn · 2017-04-20T17:07:22Z

tools/dgeni/templates/class.template.html

@@ -3,14 +3,21 @@ <h4 class="docs-api-h4 docs-api-class-name">
 </h4>
 <p class="docs-api-class-description">{$ class.description $}</p>

+{%- if class.directiveSelectors -%}
+<span class="docs-api-h4 docs-api-class-selector-label">Selectors:</span>


Can you wrap the inside of this if block in a `<div class="docs-api-directive-selectors>"?

jelbourn · 2017-04-20T17:07:47Z

tools/dgeni/templates/class.template.html

@@ -3,14 +3,21 @@ <h4 class="docs-api-h4 docs-api-class-name">
 </h4>
 <p class="docs-api-class-description">{$ class.description $}</p>

+{%- if class.directiveSelectors -%}
+<span class="docs-api-h4 docs-api-class-selector-label">Selectors:</span>


This isn't an <h4> so you should omit docs-api-h4

jelbourn · 2017-04-20T18:44:42Z

tools/dgeni/templates/class.template.html

@@ -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 -%}
+<span class="docs-api-class-selector-label">selector:</span>
+<div class="docs-api-directive-selectors">


This div should be around the selector-label span as well

* Adds method to get directive selectors to categorizor.js * Adds selectors to class.template.html Takes care of #3983 Conflicts: tools/dgeni/templates/class.template.html

jelbourn · 2017-04-20T19:45:44Z

LGTM

angular-automatic-lock-bot · 2019-09-06T11:03:15Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

googlebot added the cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla label Apr 18, 2017

devversion reviewed Apr 18, 2017

View reviewed changes

googlebot added cla: yes PR author has agreed to Google's Contributor License Agreement and removed cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla labels Apr 18, 2017

Merge pull request #1 from angular/master

2e04c18

Update from original

jelbourn reviewed Apr 20, 2017

View reviewed changes

jbh added 2 commits April 20, 2017 14:02

docs: Show directive selector in generated API docs

6375c5b

* Adds method to get directive selectors to categorizor.js * Adds selectors to class.template.html Takes care of #3983 Conflicts: tools/dgeni/templates/class.template.html

Recover categorizer

ef1dbe2

jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Apr 20, 2017

kara merged commit 740381c into angular:master Apr 21, 2017

jbh deleted the 3983/show-directive-selectors branch April 21, 2017 13:22

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Show directive selector in generated API docs #4139

docs: Show directive selector in generated API docs #4139

jbh commented Apr 18, 2017

googlebot commented Apr 18, 2017

jbh commented Apr 18, 2017

googlebot commented Apr 18, 2017

devversion Apr 18, 2017

devversion Apr 18, 2017

jbh Apr 18, 2017

devversion Apr 18, 2017

devversion Apr 18, 2017

googlebot commented Apr 18, 2017

jelbourn Apr 20, 2017

jelbourn Apr 20, 2017

jbh Apr 20, 2017 •

edited

Loading

jelbourn Apr 20, 2017

jelbourn Apr 20, 2017

jelbourn Apr 20, 2017

jelbourn Apr 20, 2017

jelbourn Apr 20, 2017

jelbourn commented Apr 20, 2017

angular-automatic-lock-bot bot commented Sep 6, 2019

docs: Show directive selector in generated API docs #4139

docs: Show directive selector in generated API docs #4139

Conversation

jbh commented Apr 18, 2017

googlebot commented Apr 18, 2017

jbh commented Apr 18, 2017

googlebot commented Apr 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

googlebot commented Apr 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbh Apr 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jelbourn commented Apr 20, 2017

angular-automatic-lock-bot bot commented Sep 6, 2019

jbh Apr 20, 2017 •

edited

Loading