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

Many interfaces are missing in the auto-generated docs #957

Open
nicolo-ribaudo opened this issue Feb 12, 2025 · 2 comments
Open

Many interfaces are missing in the auto-generated docs #957

nicolo-ribaudo opened this issue Feb 12, 2025 · 2 comments

Comments

@nicolo-ribaudo
Copy link
Contributor

nicolo-ribaudo commented Feb 12, 2025

In this package: https://jsr.io/@babel-test-6ae45912/[email protected]

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Feb 12, 2025
@nicolo-ribaudo nicolo-ribaudo changed the title Re-exported interfaces are missing in the auto-generated docs Many interfaces are missing in the auto-generated docs Feb 12, 2025
@nicolo-ribaudo
Copy link
Contributor Author

nicolo-ribaudo commented Feb 12, 2025

Found the cause of the bug, I think. I have:

  1. arrayExpression function (in https://jsr.io/@babel-test-6ae45912/types/0.0.7-8.0.0-alpha.15/lib/builders/generated/index.ts)
  2. the function arrayExpression is also re-exported as ArrayExpression (in https://jsr.io/@babel-test-6ae45912/types/0.0.7-8.0.0-alpha.15/lib/builders/generated/uppercase.js)
  3. ArrayExpression interface (in https://jsr.io/@babel-test-6ae45912/types/0.0.7-8.0.0-alpha.15/lib/ast-types/generated/index.ts)

If I had only (2) and (3), JSR would properly show docs for both under the ArrayExpression name, showing the little (F) and the little (I) next to the ArrayExpression name. See https://jsr.io/@nic-test/[email protected]/doc for an example.

However, given (1) and (2), JSR is collapsing ArrayExpression into arrayExpression. Obviously then there is no interface named arrayExpression, so the interface simply gets forgotten.

EDIT: I don't know what's going on, given the above I was expecting either the ObjectExpression or BooleanExpression interfaces to be missing at https://jsr.io/@nic-test/[email protected]/doc but they are both there. Still, in these docs some (I)s are wrong.

@nicolo-ribaudo
Copy link
Contributor Author

Mhh the original bug report is probably me doing something weird -- I noticed that one of the files is .js rather than .ts. Still, jsr.io/@nic-test/[email protected]/doc shows an occurrence of this deduplication bug (booleanExpression is marked as I, and its docs show a non-existing booleanExpression interface).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs Triage
Development

No branches or pull requests

1 participant