Skip to content

Conversation

kevmoo
Copy link
Member

@kevmoo kevmoo commented Aug 12, 2025

No description provided.

@kevmoo kevmoo requested review from srujzs and nikeokoronkwo August 12, 2025 19:08
Copy link
Contributor

@srujzs srujzs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikeokoronkwo Do we need to ignore this lint for the web package or can it be only for TS gen?

@nikeokoronkwo
Copy link
Collaborator

@nikeokoronkwo Do we need to ignore this lint for the web package or can it be only for TS gen?

This was because of the single-file examples. We cannot tell when we will need to ignore constant_identifier_names or not because it is majorly dependent on the IDL declarations we parse.

@srujzs
Copy link
Contributor

srujzs commented Aug 12, 2025

Right, but we already ignore them for the whole web package in the analysis_options.yaml file so this is duplicating that:

constant_identifier_names: ignore
.

@kevmoo
Copy link
Member Author

kevmoo commented Aug 12, 2025

It might be better to do it file-by-file and drop the pkg:web analyzer bit. Just to keep things consistent .

@srujzs
Copy link
Contributor

srujzs commented Aug 12, 2025

Yeah, it's a bit odd because we're already inconsistent. We have other ignores in that analysis_options.yaml file but we have an ignore in each of the files for unintended_html_in_doc_comment.

@nikeokoronkwo
Copy link
Collaborator

Yeah, it's a bit odd because we're already inconsistent. We have other ignores in that analysis_options.yaml file but we have an ignore in each of the files for unintended_html_in_doc_comment.

I think we can keep that, since we wouldn't necessarily be testing single-file output with already-established web APIs (that'd be suited for something like the current repo)

@srujzs
Copy link
Contributor

srujzs commented Aug 13, 2025

I think we can keep that

You mean keep ignores for unintended_html_in_doc_comment in each of the files?

At any rate, if we want this per file, that's fine by me, but we should just remove the global ignore in analysis_options.yaml to avoid duplication.

@nikeokoronkwo
Copy link
Collaborator

We might keep it per-file for now, because there's a setting to auto-generate docs for any decl that is part of webref. In the future, we can have such setting an option only enabled for generating package:web and then move to the global analysis_options.yaml file

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

Successfully merging this pull request may close these issues.

3 participants