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.

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

Consider JSDoc @import for non-exported types #5239

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Consider JSDoc @import for non-exported types #5239

wants to merge 7 commits into from

Commits on Nov 15, 2024

  1. Update JSDoc ESLint package with @import support

    @colinrotherham @romaricpascal
    colinrotherham authored and romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    df9b5bf View commit details
    Browse the repository at this point in the history

  2. Use @import for non-exported types

    @colinrotherham @romaricpascal
    colinrotherham authored and romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    6b5587e View commit details
    Browse the repository at this point in the history

  3. Use @import for Puppeteer types

    @colinrotherham @romaricpascal
    colinrotherham authored and romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    3502ffa View commit details
    Browse the repository at this point in the history

  4. Use @import for shared workspace 

    The one in `tasks/index.mjs` is left as it renames the import and there does not seem to be a syntax for that with the `@import` tag
    @romaricpascal
    romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    babea0e View commit details
    Browse the repository at this point in the history

  5. Use @import for govuk-frontend-review

    @romaricpascal
    romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    14e97c7 View commit details
    Browse the repository at this point in the history

  6. Use @import for GitHub workflows

    @romaricpascal
    romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    533815f View commit details
    Browse the repository at this point in the history

  7. Add @import to the tag making a JSDoc comment worth keeping 

    Without it, internal types like `AccordionConfig` will be unresolved in the built files as the `@import` comments are dropped
    @romaricpascal
    romaricpascal committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    bcdae6f View commit details
    Browse the repository at this point in the history