Fix misspelled @deprecated tag on QueryRowFormat.UseJsPropertyNames#9295
Fix misspelled @deprecated tag on QueryRowFormat.UseJsPropertyNames#9295Copilot wants to merge 7 commits into
Conversation
Agent-Logs-Url: https://github.com/iTwin/itwinjs-core/sessions/bbd49eb6-b0ea-4670-9657-68bcd662ee5e Co-authored-by: aruniverse <11051042+aruniverse@users.noreply.github.com>
|
@copilot make sure you run |
Agent-Logs-Url: https://github.com/iTwin/itwinjs-core/sessions/39627072-45e3-4da4-a1cc-beafb081c5d6 Co-authored-by: aruniverse <11051042+aruniverse@users.noreply.github.com>
Done in commit 6c4d4ff. |
|
@copilot run |
Agent-Logs-Url: https://github.com/iTwin/itwinjs-core/sessions/74b0b0b4-8eef-4e66-8c11-113430756769 Co-authored-by: aruniverse <11051042+aruniverse@users.noreply.github.com>
…rkers Agent-Logs-Url: https://github.com/iTwin/itwinjs-core/sessions/74b0b0b4-8eef-4e66-8c11-113430756769 Co-authored-by: aruniverse <11051042+aruniverse@users.noreply.github.com>
... Done in commit d1995a8. Added |
|
@copilot make sure to run |
…rences of UseJsPropertyNames Agent-Logs-Url: https://github.com/iTwin/itwinjs-core/sessions/45f7d46d-fae0-4189-92c6-da895bcacbc3 Co-authored-by: aruniverse <11051042+aruniverse@users.noreply.github.com>
Completed in commit 90d80d5. Here's what was validated:
|
|
@copilot you need to run |
Agent-Logs-Url: https://github.com/iTwin/itwinjs-core/sessions/d2ec29a8-7848-4102-93a3-fc3625ce3a07 Co-authored-by: aruniverse <11051042+aruniverse@users.noreply.github.com>
Done in commit 71259e4. Added
|
Security Fix
Severity
Description
QueryRowFormat.UseJsPropertyNameshad a misspelled TSDoc tag (@depreactedinstead of@deprecated), silently suppressing IDE strikethroughs, IntelliSense warnings, and ESLintno-deprecatedrule violations for all consumers of this enum member.Root Cause
Typo in the TSDoc comment on
QueryRowFormat.UseJsPropertyNamesincore/common/src/ConcurrentQuery.ts.Link to Security Notice
N/A
Solution
Corrected the tag spelling from
@depreactedto@deprecated. Also ranrush extract-apito updatecommon/api/core-common.api.md(theUseJsPropertyNamesentry now reflects// @deprecated) and created changelog entries viarush changefor all modified published packages.Added
// eslint-disable-next-line @typescript-eslint/no-deprecatedbefore all existing TypeScript code usages ofQueryRowFormat.UseJsPropertyNamesacross 38 files to suppress the@typescript-eslint/no-deprecatedlint rule that now correctly fires for this properly-tagged deprecated enum member. Incorrectly placed disable comments that had been inserted before string literal and JSDoc occurrences ofUseJsPropertyNames(e.g. init()test descriptions) were identified and removed.Additional Notes
The API surface change is limited to the addition of the
// @deprecatedmarker onUseJsPropertyNamesincommon/api/core-common.api.md. All changelog entries use bump type"none"per the lockstep monorepo policy. Changelog entries were added for all modified published packages:@itwin/core-common,@itwin/core-backend,@itwin/core-frontend,@itwin/ecschema-rpcinterface-impl,@itwin/frontend-devtools,@itwin/hypermodeling-frontend,@itwin/presentation-backend, and@itwin/presentation-frontend. All existing call sites have been annotated with lint-disable comments; consumers should migrate toUseECSqlPropertyIndexesfor best performance.Lint validation confirmed no new
no-deprecatederrors are introduced incore/common,core/backend, orcore/frontend. All remaining lint errors in those packages are pre-existing and unrelated to this change.