Skip to content

bug: Angular Output global @deprecated JsDoc transport missing #628

Open
@dutscher

Description

@dutscher

Prerequisites

Stencil Version

4.22.3

Stencil Framework Output Target

Angular

Stencil Framework Output Target Version

0.10.2

Current Behavior

this backdrop component with jsdoc for the complete component and prop jsdoc:

/**
 * @deprecated Diese Komponente ist ab 1.9.0 deprecated und wird ab 2.0 komplett entfernt
 */
@Component({
  tag: 's-backdrop',
  styleUrl: 's-backdrop.scss',
})
export class SBackdrop {
  /** @deprecated Orientierung an Parent Komponente */
  @Prop() absolute: boolean = true;
}

will render in this proxy components.ts:

@ProxyCmp({
  inputs: ['absolute']
})
@Component({
  selector: 's-backdrop',
  changeDetection: ChangeDetectionStrategy.OnPush,
  template: '<ng-content></ng-content>',
  // eslint-disable-next-line @angular-eslint/no-inputs-metadata-property
  inputs: ['absolute'],
})
export class SBackdrop {
  protected el: HTMLSBackdropElement;
    /**
   *  @deprecated Orientierung an Parent Komponente
   */
  set absolute(_: Components.SBackdrop['absolute']) {};
...

Now we can see the @deprecated of the prop ist transported but the global component jsdoc isnt.
This will have the effect when i use the component in an angular template:

    <s-backdrop></s-backdrop>
    <s-backdrop absolute></s-backdrop>

it doesn't show that the complete component is deprecated but the property is marked as deprecated.

Image

if i put manually the @deprecated jsdoc into the generated component.ts then my IDE shows the deprecation.
Image

cheers

Expected Behavior

the global @deprecated will transported to the proxy component

Steps to Reproduce

Add a @deprecated to the global jsdoc of a stencil component

Code Reproduction URL

https://codesandbox.io/p/devbox/stencil-component-custom-autofill-detection-forked-cnpqsv?file=%2Fstencil-generated%2Fcomponents.ts

Additional Information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wanteda good issue for the communitytype: bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions