Skip to content
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.

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

Remove needless @default JSDoc tags #10657

Open
1 of 5 tasks
maxpatiiuk opened this issue Oct 31, 2024 · 0 comments
Open
1 of 5 tasks

Remove needless @default JSDoc tags #10657

maxpatiiuk opened this issue Oct 31, 2024 · 0 comments
Labels
0 - new New issues that need assignment. blocked This issue is blocked by another issue. calcite-components Issues specific to the @esri/calcite-components package. estimate - 2 Small fix or update, may require updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - low Issue is non core or affecting less that 10% of people using the library refactor Issues tied to code that needs to be significantly reworked.

Comments

@maxpatiiuk
Copy link
Member

Description

Blocked by #10310

In several places Calcite uses @default JSDoc tag to describe the property's default value:

  /**
   * Specifies the placement of the `calcite-date-picker` relative to the component.
   *
   * @default "bottom-start"
   */
  @property({ reflect: true }) placement: MenuPlacement = defaultMenuPlacement;

Doing so in Lumina is not necessary - if default value is coming from a const variable (like in the above case), Lumina infers the default value correctly, without need for manual annotations.

It looks like Calcite has 11 @default annotations, and all of them are needless in Lumina

Proposed Advantages

Remove redundancy and reduce chance of things getting out of date

Which Component

11 places

Relevant Info

No response

Calcite package

  • @esri/calcite-components
  • @esri/calcite-components-angular
  • @esri/calcite-components-react
  • @esri/calcite-design-tokens
  • @esri/eslint-plugin-calcite-components
@maxpatiiuk maxpatiiuk added refactor Issues tied to code that needs to be significantly reworked. 0 - new New issues that need assignment. blocked This issue is blocked by another issue. needs triage Planning workflow - pending design/dev review. labels Oct 31, 2024
@github-actions github-actions bot added the calcite-components Issues specific to the @esri/calcite-components package. label Oct 31, 2024
@driskull driskull added p - low Issue is non core or affecting less that 10% of people using the library estimate - 2 Small fix or update, may require updates to tests. labels Feb 25, 2025
@DitwanP DitwanP added needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. and removed needs triage Planning workflow - pending design/dev review. labels Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - new New issues that need assignment. blocked This issue is blocked by another issue. calcite-components Issues specific to the @esri/calcite-components package. estimate - 2 Small fix or update, may require updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - low Issue is non core or affecting less that 10% of people using the library refactor Issues tied to code that needs to be significantly reworked.
Projects
None yet
Development

No branches or pull requests

3 participants