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

Ignore unintended_html_in_doc_comment #278

Merged
merged 5 commits into from
Aug 12, 2024
Merged

Conversation

srujzs
Copy link
Contributor

@srujzs srujzs commented Aug 12, 2024

MDN docs includes some variants of html tags that this rule disallows, like <table class="properties">, <th scope="row">, and <br />. In order to make the CI pass, this is ignored for now. Fixes cases unrelated to the MDN docs.

cc @kallentu for some fun edge cases from the MDN.

MDN docs includes some variants of html tags that this
rule disallows, like <table class="properties">, <th scope="row">,
and <br />. In order to make the CI pass, this is ignored for
now. Fixes cases unrelated to the MDN docs.
@srujzs srujzs requested a review from kevmoo August 12, 2024 21:56
@kevmoo
Copy link
Member

kevmoo commented Aug 12, 2024

Re the failure: we shouldn't run analyzer tests against 3.4 - just dev

@kevmoo
Copy link
Member

kevmoo commented Aug 12, 2024

nit: also: could we just add this ignore at the top of all generated files?

@srujzs
Copy link
Contributor Author

srujzs commented Aug 12, 2024

Re the failure: we shouldn't run analyzer tests against 3.4 - just dev

We should still make sure analysis passes with 3.4 so we don't release a package that breaks against an older Dart SDK version. We might need to ignore unrecognized_error_code to make this work however.

nit: also: could we just add this ignore at the top of all generated files?

Yeah, since it looks like we can't exclude files from a lint, I could try that.

@srujzs srujzs requested a review from kevmoo August 12, 2024 22:35
@srujzs
Copy link
Contributor Author

srujzs commented Aug 12, 2024

Generated in the files themselves instead, which has the nice side-effect of it not affecting the 3.4 analysis.

@srujzs srujzs merged commit 4996dc2 into dart-lang:main Aug 12, 2024
9 checks passed
@devoncarew
Copy link
Member

I'm trying to validate @kallentu's fix for this, but am having trouble getting the false positives from unintended_html_in_doc_comment to fire here (using an sdk before the fix). I'm assuming I have a local config issue but mentioning here as I don't see the false positives.

@devoncarew
Copy link
Member

Nevermind - I had to check out an older commit to get this to trigger; I do see these as fixed in head.

copybara-service bot pushed a commit to dart-lang/sdk that referenced this pull request Aug 13, 2024
Revisions updated by `dart tools/rev_sdk_deps.dart`.

ecosystem (https://github.com/dart-lang/ecosystem/compare/f977423..2719d0c):
  2719d0c  2024-08-08  Devon Carew  add invalid_runtime_check_with_js_interop_types, unintended_html_in_doc_comment (dart-lang/ecosystem#285)

http (https://github.com/dart-lang/http/compare/73fce77..76512c4):
  76512c4  2024-08-07  Kate  test(http_client_conformance_tests): Remove old skips (dart-lang/http#1284)
  d7ae256  2024-08-08  Anikate De  [docs] sort pkg list in ascending order (dart-lang/http#1287)
  b82d88c  2024-08-06  Anikate De  [docs] Add ok_http entry to readme (dart-lang/http#1285)

package_config (https://github.com/dart-lang/package_config/compare/f0b7256..76934c2):
  76934c2  2024-08-06  Kevin Moore  Latest lints, require Dart 3.4 (dart-lang/package_config#157)

sync_http (https://github.com/dart-lang/sync_http/compare/ab8377e..91c0dd5):
  91c0dd5  2024-08-12  dependabot[bot]  Bump actions/checkout from 4.1.6 to 4.1.7 (google/sync_http.dart#49)

test (https://github.com/dart-lang/test/compare/9fbbfdb..8be3c94):
  8be3c948  2024-08-12  Ömer Sinan Ağacan  Run dart2wasm integration test on Windows (dart-lang/test#2265)
  e656e5a9  2024-08-12  Yaroslav Vorobev  fix: use `toFilePath` in package config Uri (dart-lang/test#2262)
  6bfe0d62  2024-08-12  Ömer Sinan Ağacan  Fix documentation rendering issues (dart-lang/test#2264)

tools (https://github.com/dart-lang/tools/compare/55dbd6e..d563c38):
  d563c38  2024-08-13  Moritz  Add health workflow (dart-lang/tools#292)
  8ac5509  2024-08-12  Devon Carew  Update CODEOWNERS for package:unified_analytics (dart-lang/tools#289)

web (https://github.com/dart-lang/web/compare/e89fe49..4996dc2):
  4996dc2  2024-08-12  Srujan Gaddam  Ignore unintended_html_in_doc_comment (dart-lang/web#278)

Change-Id: I808778af5fb9a1f6885ae847614ffb660fcb8662
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/380204
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Auto-Submit: Devon Carew <devoncarew@google.com>
Commit-Queue: Konstantin Shcheglov <scheglov@google.com>
@srujzs
Copy link
Contributor Author

srujzs commented Aug 15, 2024

Cool, thanks Kallen! We'll still need the ignores for a little while until we move to a minimum SDK version that contains the fix.

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