build: don't show import path if there is no primary export

[crisbeto]

Currently we show something like import {} from '@angular/cdk/coercion' for imports that don't have a primary export. These changes remove the line if there is no primary export.

[devversion]

I think this was intentionally displayed like that. Even if there is no primary export (which is usually a module or a test harness class), we'd want to show how the import to this entry-point would look like IMO.

[crisbeto]

The current behavior just looks broken IMO since you aren't importing anything. Alternatively it can be changed to something like import * as coercion from '@angular/cdk/coercion';, but I don't know if we have the name for the import alias.

[devversion]

Yeah, let's see what others think 👍

[jelbourn]

What if we make it something like

Import symbols from `@angular/cdk/coercion`

[crisbeto]

That's a good idea, but my only concern is that it would still be styled as code in the docs and people might think that it's valid syntax.

[jelbourn]

You could do something like

  {%- if doc.primaryExportName -%}
    <p>
      Import symbols from 
      <code  class="docs-api-module-import">
        import {{$ doc.primaryExportName $}} from '{$ doc.moduleImportPath $}';
      </code>
    </p>
  {%- endif -%}

(might require some tweaking, but with that general idea)

[crisbeto]

I don't follow how that would help. The problem this is trying to fix is when a doc.primaryExportName doesn't exist.

[devversion]

I was thinking @jelbourn meant something around that (even though the snippet shows something different though):

// If there a primary export, we show (highlighted)
import {<primaryExport>} from '@angular/cdk/coercion';

// If there is no primary export, we show (without highlighting)
// Using <code> for the import so that it can be copied better
Import symbols from <code>@angular/cdk/coercion</code>

[crisbeto]

Thank you for the explanation, that makes sense. I've pushed the change.

[jelbourn]

Yeah, that's what I meant, Paul is just smarter than me

[jelbourn]

lgtm

[angular-automatic-lock-bot]

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.}