Skip to content

Conversation

@arnoud-dv
Copy link
Collaborator

@arnoud-dv arnoud-dv commented Oct 21, 2025

🎯 Changes

Rename DeveloperToolsFeature to DevtoolsFeature for consistency with internal naming conventions and ecosystem

βœ… Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

πŸš€ Release Impact

  • This change affects published code, and I have generated a changeset.
  • [] This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Refactor

    • Renamed public type DeveloperToolsFeature β†’ DevtoolsFeature in the Angular Query experimental package.
  • Documentation

    • Removed the public reference for injectQueries.
    • Multiple docs cleaned up: signature formatting, typographic consistency (e.g., emphasis and quote styles), minor examples and line-reference updates.
    • Added an ignore pattern for framework reference docs to formatting tooling.

@changeset-bot
Copy link

changeset-bot bot commented Oct 21, 2025

πŸ¦‹ Changeset detected

Latest commit: 637eeb5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@tanstack/angular-query-experimental Patch
@tanstack/angular-query-persist-client Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025

Walkthrough

Renames the public type alias DeveloperToolsFeature to DevtoolsFeature in @tanstack/angular-query-experimental and updates related exports and references. Many Angular framework doc pages were reformatted or updated (signature formatting, quoting, line numbers); a changeset and .prettierignore entry were added.

Changes

Cohort / File(s) Summary
Public API rename
packages/angular-query-experimental/src/providers.ts, packages/angular-query-experimental/src/index.ts, packages/angular-query-experimental/src/devtools/types.ts
Rename type alias and references: DeveloperToolsFeature β†’ DevtoolsFeature; update exports and import sites. No runtime or semantic behavior changes.
Angular docs β€” reference files (formatting, signatures, removals)
docs/framework/angular/reference/... (many files including functions/*, interfaces/*, type-aliases/*, index.md)
Extensive documentation edits: formatting and signature reflows (multi-line β†’ single-line), emphasis style changes (_extends_ β†’ *extends*), quote normalization, trailing semicolons, updated "Defined in" line numbers, removal of injectQueries doc page and references, and renaming doc entries from DeveloperToolsFeature β†’ DevtoolsFeature. No code behavior changes.
Changeset entry
.changeset/devtools-feature-rename.md
Adds a changeset documenting the public API rename for a patch release.
Prettier ignore update
.prettierignore
Adds ignore pattern docs/framework/*/reference to prettierignore.

Sequence Diagram(s)

No sequence diagram provided β€” the changes are renames and documentation/formatting edits without control-flow or runtime interaction modifications.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Reasoning: a focused API rename across a few source files plus broad, heterogeneous documentation edits that require spot-checking for correctness and completeness.

Possibly related PRs

Suggested labels

documentation

Poem

πŸ‡ I hopped through types and docs today,
I nudged a name and hopped away,
DevtoolsFeature now in place,
Clean docs, neat quotes β€” a tidy trace,
πŸ₯• small change, big neat display.

Pre-merge checks and finishing touches

βœ… Passed checks (3 passed)
Check name Status Explanation
Title Check βœ… Passed The pull request title "refactor(angular-query): rename DeveloperToolsFeature to DevtoolsFeature" directly and clearly summarizes the primary change in the changeset. The title accurately reflects that this is a refactoring effort to rename a public type alias from DeveloperToolsFeature to DevtoolsFeature for consistency. The title is concise, specific enough for a teammate to understand the main change when scanning history, and avoids vague or generic terminology. It matches the core objective documented in the PR's description and is demonstrated throughout the file changes, including the changeset entry, type definitions, exports, and documentation updates.
Description Check βœ… Passed The pull request description follows the required template structure and includes all essential sections. The Changes section clearly states what is being done and provides motivation (consistency with internal naming conventions and ecosystem). The Checklist section shows both items are checked, confirming the author followed the contributing guide and tested locally. The Release Impact section indicates this affects published code with a changeset generated, which is appropriate for a public API rename. While the Changes section is relatively brief, it contains sufficient information about the refactoring being performed.
Docstring Coverage βœ… Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • πŸ“ Generate docstrings
πŸ§ͺ Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❀️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Oct 21, 2025

View your CI Pipeline Execution β†— for commit 637eeb5

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... βœ… Succeeded 50s View β†—
nx run-many --target=build --exclude=examples/*... βœ… Succeeded 1s View β†—

☁️ Nx Cloud last updated this comment at 2025-10-22 00:12:58 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 21, 2025

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9794

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9794

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9794

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9794

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@9794

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@9794

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9794

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9794

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@9794

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@9794

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9794

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9794

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@9794

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9794

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9794

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@9794

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9794

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9794

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@9794

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9794

commit: 637eeb5

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

πŸ“œ Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 1e77bd4 and c41a2dd.

πŸ“’ Files selected for processing (4)
  • .changeset/devtools-feature-rename.md (1 hunks)
  • packages/angular-query-experimental/src/devtools/types.ts (2 hunks)
  • packages/angular-query-experimental/src/index.ts (1 hunks)
  • packages/angular-query-experimental/src/providers.ts (2 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
packages/angular-query-experimental/src/devtools/types.ts (2)
packages/angular-query-experimental/src/index.ts (1)
  • DevtoolsFeature (50-50)
packages/angular-query-experimental/src/providers.ts (1)
  • DevtoolsFeature (158-158)
packages/angular-query-experimental/src/providers.ts (1)
packages/angular-query-experimental/src/index.ts (4)
  • DevtoolsFeature (50-50)
  • QueryFeature (52-52)
  • QueryFeatures (53-53)
  • PersistQueryClientFeature (51-51)
πŸ”‡ Additional comments (4)
packages/angular-query-experimental/src/devtools/types.ts (1)

7-7: LGTM! Type rename applied consistently.

The import and return type properly reflect the renamed DevtoolsFeature type, maintaining consistency with the new naming convention.

Also applies to: 107-107

.changeset/devtools-feature-rename.md (1)

1-5: Consider whether "patch" is appropriate for a public API rename.

While the package is experimental, renaming a public type (DeveloperToolsFeature β†’ DevtoolsFeature) is technically a breaking change for any external code referencing it. Semantic versioning typically categorizes breaking changes as major (or minor for pre-1.0 packages), not patch.

Given the experimental nature of @tanstack/angular-query-experimental, this may be acceptable, but verify this aligns with the project's versioning policy for experimental packages.

packages/angular-query-experimental/src/index.ts (1)

49-54: LGTM! Public export surface updated correctly.

The export statement properly reflects the renamed DevtoolsFeature type, maintaining consistency across the public API.

packages/angular-query-experimental/src/providers.ts (1)

173-173: LGTM! Union type updated correctly.

The QueryFeatures union type properly references the renamed DevtoolsFeature, maintaining type consistency across the API surface.

@codecov
Copy link

codecov bot commented Oct 21, 2025

Codecov Report

βœ… All modified and coverable lines are covered by tests.
βœ… Project coverage is 94.13%. Comparing base (1e77bd4) to head (637eeb5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #9794       +/-   ##
===========================================
+ Coverage   45.74%   94.13%   +48.39%     
===========================================
  Files         200       21      -179     
  Lines        8404      426     -7978     
  Branches     1929       99     -1830     
===========================================
- Hits         3844      401     -3443     
+ Misses       4112       24     -4088     
+ Partials      448        1      -447     
Components Coverage Ξ”
@tanstack/angular-query-experimental 93.85% <ΓΈ> (ΓΈ)
@tanstack/eslint-plugin-query βˆ… <ΓΈ> (βˆ…)
@tanstack/query-async-storage-persister βˆ… <ΓΈ> (βˆ…)
@tanstack/query-broadcast-client-experimental βˆ… <ΓΈ> (βˆ…)
@tanstack/query-codemods βˆ… <ΓΈ> (βˆ…)
@tanstack/query-core βˆ… <ΓΈ> (βˆ…)
@tanstack/query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/query-persist-client-core βˆ… <ΓΈ> (βˆ…)
@tanstack/query-sync-storage-persister βˆ… <ΓΈ> (βˆ…)
@tanstack/query-test-utils βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query-next-experimental βˆ… <ΓΈ> (βˆ…)
@tanstack/react-query-persist-client βˆ… <ΓΈ> (βˆ…)
@tanstack/solid-query βˆ… <ΓΈ> (βˆ…)
@tanstack/solid-query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/solid-query-persist-client βˆ… <ΓΈ> (βˆ…)
@tanstack/svelte-query βˆ… <ΓΈ> (βˆ…)
@tanstack/svelte-query-devtools βˆ… <ΓΈ> (βˆ…)
@tanstack/svelte-query-persist-client βˆ… <ΓΈ> (βˆ…)
@tanstack/vue-query βˆ… <ΓΈ> (βˆ…)
@tanstack/vue-query-devtools βˆ… <ΓΈ> (βˆ…)
πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • πŸ“¦ JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@arnoud-dv arnoud-dv force-pushed the fix/angular-devtools-consistent-naming branch from c41a2dd to 637eeb5 Compare October 22, 2025 00:10
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 22, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

πŸ“œ Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between c41a2dd and 637eeb5.

πŸ“’ Files selected for processing (45)
  • .changeset/devtools-feature-rename.md (1 hunks)
  • .prettierignore (1 hunks)
  • docs/framework/angular/reference/functions/infinitequeryoptions.md (6 hunks)
  • docs/framework/angular/reference/functions/injectinfinitequery.md (6 hunks)
  • docs/framework/angular/reference/functions/injectisfetching.md (1 hunks)
  • docs/framework/angular/reference/functions/injectmutation.md (1 hunks)
  • docs/framework/angular/reference/functions/injectmutationstate.md (1 hunks)
  • docs/framework/angular/reference/functions/injectqueries.md (0 hunks)
  • docs/framework/angular/reference/functions/injectquery.md (6 hunks)
  • docs/framework/angular/reference/functions/injectqueryclient.md (1 hunks)
  • docs/framework/angular/reference/functions/mutationoptions.md (5 hunks)
  • docs/framework/angular/reference/functions/providetanstackquery.md (1 hunks)
  • docs/framework/angular/reference/functions/queryfeature.md (1 hunks)
  • docs/framework/angular/reference/functions/queryoptions.md (10 hunks)
  • docs/framework/angular/reference/index.md (2 hunks)
  • docs/framework/angular/reference/interfaces/basemutationnarrowing.md (2 hunks)
  • docs/framework/angular/reference/interfaces/basequerynarrowing.md (2 hunks)
  • docs/framework/angular/reference/interfaces/createbasequeryoptions.md (1 hunks)
  • docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md (1 hunks)
  • docs/framework/angular/reference/interfaces/createqueryoptions.md (1 hunks)
  • docs/framework/angular/reference/interfaces/injectmutationoptions.md (2 hunks)
  • docs/framework/angular/reference/interfaces/queryfeature.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createbasemutationresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createbasequeryresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createmutatefunction.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createmutationresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/createqueryresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md (3 hunks)
  • docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md (3 hunks)
  • docs/framework/angular/reference/type-aliases/devtoolsfeature.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/persistqueryclientfeature.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/queriesoptions.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/queriesresults.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/queryfeatures.md (1 hunks)
  • docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md (3 hunks)
  • docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md (3 hunks)
  • docs/framework/angular/reference/type-aliases/unusedskiptokeninfiniteoptions.md (2 hunks)
  • docs/framework/angular/reference/type-aliases/unusedskiptokenoptions.md (2 hunks)
  • packages/angular-query-experimental/src/devtools/types.ts (2 hunks)
  • packages/angular-query-experimental/src/index.ts (1 hunks)
  • packages/angular-query-experimental/src/providers.ts (2 hunks)
πŸ’€ Files with no reviewable changes (1)
  • docs/framework/angular/reference/functions/injectqueries.md
βœ… Files skipped from review due to trivial changes (13)
  • docs/framework/angular/reference/functions/injectisfetching.md
  • docs/framework/angular/reference/interfaces/createqueryoptions.md
  • docs/framework/angular/reference/functions/queryfeature.md
  • docs/framework/angular/reference/functions/injectqueryclient.md
  • docs/framework/angular/reference/interfaces/injectmutationoptions.md
  • docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md
  • docs/framework/angular/reference/functions/injectmutationstate.md
  • docs/framework/angular/reference/type-aliases/createmutationresult.md
  • docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md
  • docs/framework/angular/reference/functions/providetanstackquery.md
  • docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md
  • docs/framework/angular/reference/type-aliases/unusedskiptokenoptions.md
  • docs/framework/angular/reference/interfaces/queryfeature.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • .changeset/devtools-feature-rename.md
  • packages/angular-query-experimental/src/index.ts
  • packages/angular-query-experimental/src/devtools/types.ts
🧰 Additional context used
🧬 Code graph analysis (1)
packages/angular-query-experimental/src/providers.ts (1)
packages/angular-query-experimental/src/index.ts (4)
  • DevtoolsFeature (50-50)
  • QueryFeature (52-52)
  • QueryFeatures (53-53)
  • PersistQueryClientFeature (51-51)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Test
  • GitHub Check: Preview
πŸ”‡ Additional comments (33)
docs/framework/angular/reference/type-aliases/unusedskiptokeninfiniteoptions.md (1)

11-11: Documentation formatting improvements look good.

The reformatting of the type alias to a single-line definition (line 11) improves readability, and the switch from underscores to asterisks for Markdown italics (line 32) follows standard conventions. These changes align with the broader documentation consistency effort across the type aliases.

Also applies to: 32-32

docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md (1)

6-11: Verify edits to autogenerated documentation file.

Line 6 indicates this file is autogenerated and should not be manually edited. The changes at lines 11, 21, and 40 appear to be formatting refinements. Confirm whether these changes were generated as a side effect of the PR's broader refactoring (e.g., documentation regeneration following the DeveloperToolsFeature β†’ DevtoolsFeature rename), or if they represent manual edits that should be sourced from the upstream type definitions instead.

docs/framework/angular/reference/interfaces/createbasequeryoptions.md (1)

26-26: Minor formatting change in autogenerated docs.

The markdown emphasis style has been updated from underscores to asterisks (_extends_ β†’ *extends*). This is a cosmetic change that aligns with the broader doc reformatting mentioned in the PR summary.

Since this file is autogenerated (as noted on line 6), please verify that the docs were regenerated correctly as part of this PR and that the source types remain accurate.

docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md (1)

24-24: Formatting change looks good.

The markdown italic formatting (*extends*) is consistent with the doc-formatting cleanup mentioned across Angular Framework reference pages. Since this is an autogenerated file, ensure the change originates from an updated generation script rather than manual edits.

docs/framework/angular/reference/functions/mutationoptions.md (2)

1-6: Verify that autogenerated documentation was properly regenerated.

This file is marked as autogenerated (line 6), yet the PR objective centers on renaming DeveloperToolsFeature to DevtoolsFeature in the source code. The marked changes show example code additions (QueryClient injection), type signature updates with quote normalization, and line number changes.

Confirm that:

  • The autogeneration process was run to produce these changes (not manually edited)
  • All changes correspond to actual updates in the source type comments (mutation-options.ts)
  • This file should be included in a PR focused on type renaming

49-52: Confirm type signature quote changes align with actual implementation.

The type signatures now use double quotes for "mutationKey" (lines 49, 119), and the "Defined in" references have been updated with new line numbers (L39 and L53). Verify that these changes reflect the actual source code in mutation-options.ts and are not manual formatting inconsistencies.

Also applies to: 119-122

.prettierignore (1)

12-12: Pattern addition aligns with PR scope.

The new glob pattern correctly excludes reference documentation directories from Prettier formatting, which is consistent with the documentation framework updates described in the PR.

Please confirm that these reference documentation files are auto-generated or require special formatting that differs from Prettier's defaults, justifying their exclusion from formatting.

docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md (1)

11-11: Auto-generated documentation formatting updates.

These changes appear to be formatting standardization for auto-generated documentation:

  • Single-line type alias declaration (line 11)
  • Markdown emphasis formatting update _extends_ β†’ *extends* (line 34)

Since this file is auto-generated, verify that the upstream source comments or doc generation tool have been updated to produce these formatting changes.

Also applies to: 21-21, 34-34

docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md (1)

11-11: Auto-generated documentation formatting updates.

Consistent with the other type-alias documentation file updates:

  • Single-line type alias declaration with trailing semicolon (line 11)
  • Markdown emphasis formatting update (line 35)

These are formatting-only changes in auto-generated documentation.

Also applies to: 21-21, 35-35

docs/framework/angular/reference/functions/injectinfinitequery.md (1)

24-24: Auto-generated function documentation formatting updates.

Consistent with the type-alias documentation updates:

  • Function call signatures reformatted to single-line format (lines 24, 77, 130)
  • Markdown emphasis standardization in type parameters (lines 40, 93, 146)

These are purely formatting changes in auto-generated documentation with no impact on function signatures, behavior, or exported API.

Also applies to: 40-40, 77-77, 93-93, 130-130, 146-146

docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md (2)

11-11: Clarify the purpose of formatting changes in this file.

The changes here (single-line formatting, semicolon, line number shift from 151β†’153) do not directly relate to the stated PR objective of renaming DeveloperToolsFeature to DevtoolsFeature. Confirm whether:

  1. These are collateral documentation regenerations caused by the rename PR
  2. There's an unrelated documentation formatting/consistency initiative bundled into this PR
  3. The line number shift reflects actual code additions in types.ts related to the rename

This clarification will help determine if the changes are in scope or represent scope creep.

Also applies to: 14-14


6-6: Now I need to directly inspect the actual changes in the file and the build process:Based on the information I've gathered so far, I can now provide a definitive assessment:


File changes are part of legitimate autogenerated documentation.

The file was properly regenerated as part of the PR. Evidence:

  1. TypeDoc converts comments in TypeScript's source code into HTML documentation or a JSON model, and this repository contains a custom ./scripts/generateDocs.ts script alongside TypeDoc tooling.

  2. Git history confirms this file was modified in commit 637eeb5e titled "refactor(angular-query): rename DeveloperToolsFeature to DevtoolsFeature" β€” the same PR objective, indicating the documentation generation script was properly executed as part of the code changes.

  3. The line number reference change (151β†’153) is consistent with source code modifications elsewhere in types.ts. TypeDoc-generated documentation automatically reflects such line shifts when code is added or restructured.

  4. Typedoc-plugin-markdown appends semicolons to signatures in code blocks, explaining the formatting change from multi-line to single-line with trailing semicolon β€” a normal output consistency behavior from the documentation generator.

No manual edits were made despite the file's autogenerated header. The changes reflect legitimate regeneration of documentation as part of the build process.

docs/framework/angular/reference/functions/queryoptions.md (3)

35-35: Inconsistent quote styles in generated return types.

The return type formatting across call signatures uses different quoting conventions:

  • Line 35: Omit<...CreateQueryOptions..., "queryFn"> (double quotes)
  • Line 91: OmitKeyof<...CreateQueryOptions..., "queryFn"> (double quotes, also changed from Omit to OmitKeyof)
  • Line 147: CreateQueryOptions<...> & object & object (no omit clause)

Verify that the return type formatting is correct and consistent. If OmitKeyof is the correct utility on line 91, confirm that the other signatures (line 35) should also be updated for consistency.

Also applies to: 91-91, 147-147


66-66: Markdown emphasis formatting standardized but verify correctness.

Type parameters now consistently use *extends* (asterisk-based italics) instead of _extends_ (underscore-based italics). Both render as italics in Markdown, so this is a style standardization. Confirm this aligns with your documentation style guide or tool output.

Also applies to: 122-122, 178-178


6-6: Auto-generated docs should be committed as part of the build workflow; no action needed.

The docs:generate script (via TypeDoc) is an intentional part of the project's workflow. Auto-generated files in docs/framework/angular/reference/ are meant to be committedβ€”they are not excluded in .gitignore, and the docs:generate npm script is a standard build step. The formatting changes visible in queryoptions.md (code indentation, emphasis styles, return type formatting) are legitimate artifacts from regenerating the documentation, not manual edits. The "DO NOT EDIT" header correctly marks this as generated content, not something that was manually modified.

Likely an incorrect or invalid review comment.

docs/framework/angular/reference/type-aliases/createmutatefunction.md (1)

11-11: Formatting change approved.

The type alias has been reformatted from multi-line to single-line, which improves readability for this simple function type. The semantic definition remains unchanged.

docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md (1)

11-11: Formatting and quote style updates approved.

Single-line formatting and quote style changes (single to double quotes) improve consistency with prettier conventions. The semantic type definition remains unchanged.

docs/framework/angular/reference/type-aliases/createbasequeryresult.md (1)

11-11: Formatting consistency maintained.

The changes align with the formatting updates across other type alias documentation files (single-line, double quotes for string literals, trailing semicolons).

docs/framework/angular/reference/type-aliases/createbasemutationresult.md (1)

11-16: Formatting consistency applied to object type members.

Semicolons added to member declarations within the object type, maintaining consistency with the formatting standardization across the PR. The structure and semantics remain unchanged.

Also applies to: 23-23

docs/framework/angular/reference/interfaces/basequerynarrowing.md (1)

38-38: Documentation formatting improvements approved.

The separator lines improve visual organization of the interface documentation. These are purely cosmetic changes to auto-generated docs with no impact on the interface definition or behavior.

Also applies to: 58-58

docs/framework/angular/reference/type-aliases/createqueryresult.md (1)

11-11: Trailing semicolon is standard Prettier formattingβ€”no issue.

Prettier prints semicolons by default for type aliases when the "semi" option is enabled. The semicolon addition in this type alias aligns with standard TypeScript/Prettier conventions and requires no changes.

docs/framework/angular/reference/type-aliases/queriesresults.md (1)

8-8: I need to verify the location of the actual type definitions since the initial search returned no results. Let me search more broadly:

Let me search for the actual source file location:

Let me check where the QueriesResults type is actually defined in the source code:

Based on my verification, I can now provide the rewritten review comment:


Verify that TResult β†’ TResults renaming is complete across the codebase and properly reflects actual source code changes.

The Angular documentation currently shows QueriesResults<T, TResult, TDepth> with GetResults, while other frameworks like Svelte have already been updated to use QueriesResults<T, TResults, TDepth> with GetCreateQueryResult. This change affects a public type parameter and is a breaking API change.

Before finalizing this documentation update:

  • Confirm the actual source code in @tanstack/angular-query-experimental has been updated to match
  • Verify the source file location (current search found no matches in packages/angular-query-experimental/src/)
  • Ensure all internal references use the new naming consistently
docs/framework/angular/reference/type-aliases/queryfeatures.md (1)

11-13: LGTM! Documentation properly updated to reflect the type rename.

The QueryFeatures type alias correctly shows DevtoolsFeature as the first union member, consistent with the source code changes in providers.ts.

docs/framework/angular/reference/type-aliases/persistqueryclientfeature.md (1)

11-11: LGTM! Documentation formatting updated.

The quote style change from single to double quotes is consistent with the documentation generation for this PR.

packages/angular-query-experimental/src/providers.ts (2)

158-158: LGTM! Type alias renamed correctly.

The rename from DeveloperToolsFeature to DevtoolsFeature preserves the underlying type semantics and aligns with the stated PR objective for consistent naming. The documentation files in this PR appear to have been properly regenerated to reflect this change.


173-173: LGTM! Union type updated consistently.

The QueryFeatures type alias correctly references the renamed DevtoolsFeature.

docs/framework/angular/reference/index.md (2)

2-3: LGTM! Metadata formatting updated.

The quote style change is consistent with documentation generation standards.


39-39: LGTM! Index properly updated with renamed type.

The DevtoolsFeature type alias is correctly referenced in the documentation index.

docs/framework/angular/reference/type-aliases/devtoolsfeature.md (1)

2-3: LGTM! Documentation fully updated for the renamed type.

All references to the type alias are correctly updated from DeveloperToolsFeature to DevtoolsFeature throughout the documentation page.

Also applies to: 8-8, 11-11

docs/framework/angular/reference/functions/injectquery.md (1)

56-56: LGTM! Documentation formatting standardized.

The function signature formatting and type parameter emphasis markers have been updated for consistency across the documentation.

Also applies to: 100-100, 143-143, 187-187, 230-230, 274-274

docs/framework/angular/reference/functions/infinitequeryoptions.md (1)

21-21: LGTM! Documentation formatting updated consistently.

Function signatures and type parameters have been reformatted for improved consistency and readability.

Also applies to: 38-38, 65-65, 82-82, 109-109, 126-126

docs/framework/angular/reference/interfaces/basemutationnarrowing.md (1)

10-10: LGTM! Documentation updated with formatting improvements.

Line references and property signatures have been updated to reflect the current source code structure. The addition of section separators improves documentation readability.

Also applies to: 27-32, 37-42, 47-52, 57-60

docs/framework/angular/reference/functions/injectmutation.md (1)

1-48: ****

All changes are verified. The new sentence "Unlike queries, mutations are not run automatically" on line 18 is properly sourced from the JSDoc comments in inject-mutation.ts source file. The documentation was correctly regenerated from the updated source codeβ€”the file is marked auto-generated and the changes reflect legitimate updates to the source JSDoc comments, not manual edits. The line reference change (44 β†’ 45) and signature formatting are consistent with the published documentation and represent valid documentation generation output.

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Type Alias: QueriesOptions\<T, TResult, TDepth\>
# Type Alias: QueriesOptions\<T, TResults, TDepth\>
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | πŸ”΄ Critical

🧩 Analysis chain

Verify type parameter and utility function renaming is complete and consistent.

Similar to QueriesResults, this type has been updated with TResult β†’ TResults and GetOptions β†’ GetCreateQueryOptionsForCreateQueries. Ensure all occurrences are consistently updated throughout the codebase and that these changes don't break downstream consumers.

Also applies to: 11-11, 14-14, 20-22


🏁 Script executed:

#!/bin/bash
# Description: Verify GetOptions β†’ GetCreateQueryOptionsForCreateQueries renaming

echo "=== Checking for remaining GetOptions references ==="
rg -n "GetOptions" packages/angular-query-experimental/src/ --type=ts --type=tsx 2>/dev/null | grep -v GetCreateQueryOptionsForCreateQueries | head -20

echo -e "\n=== Checking for GetCreateQueryOptionsForCreateQueries references ==="
rg -n "GetCreateQueryOptionsForCreateQueries" packages/angular-query-experimental/src/ --type=ts --type=tsx 2>/dev/null | head -20

Length of output: 123



🏁 Script executed:

#!/bin/bash
# Description: Broader search for GetOptions and GetCreateQueryOptionsForCreateQueries across entire repo

echo "=== Searching entire repository for GetOptions (excluding node_modules) ==="
rg -n "GetOptions" --type=ts --type=tsx --type=js -g '!node_modules' 2>/dev/null | head -20

echo -e "\n=== Searching entire repository for GetCreateQueryOptionsForCreateQueries ==="
rg -n "GetCreateQueryOptionsForCreateQueries" --type=ts --type=tsx --type=js -g '!node_modules' 2>/dev/null | head -20

echo -e "\n=== Searching for QueriesOptions type definition ==="
rg -n "QueriesOptions" --type=ts --type=tsx --type=js -g '!node_modules' -B2 -A5 2>/dev/null | head -40

Length of output: 208



🏁 Script executed:

#!/bin/bash
# Description: Examine the documentation file directly and check for related files

echo "=== Content of queriesoptions.md ==="
cat docs/framework/angular/reference/type-aliases/queriesoptions.md

echo -e "\n=== Listing other type-aliases in the same directory ==="
fd --type f "\.md$" docs/framework/angular/reference/type-aliases/ 2>/dev/null | head -10

echo -e "\n=== Checking for any references to queriesoptions in the repo ==="
rg -n "queriesoptions" -i --type=md --type=ts --type=tsx -g '!node_modules' 2>/dev/null | head -20

Length of output: 2125



🏁 Script executed:

#!/bin/bash
# Description: Examine the source file where the type is defined

echo "=== Content around line 144 of inject-queries.ts ==="
sed -n '130,160p' packages/angular-query-experimental/src/inject-queries.ts

echo -e "\n=== Searching for type definition pattern around line 144 ==="
sed -n '120,180p' packages/angular-query-experimental/src/inject-queries.ts | cat -n

echo -e "\n=== Checking if GetCreateQueryOptionsForCreateQueries is imported or defined ==="
rg -n "GetCreateQueryOptionsForCreateQueries|GetOptions" packages/angular-query-experimental/src/inject-queries.ts -B3 -A3 2>/dev/null

Length of output: 5601


Fix outdated comment referencing old type name.

The type renaming from GetOptions to GetCreateQueryOptionsForCreateQueries is complete in the actual type definitions and usage throughout inject-queries.ts. However, line 37 contains an outdated comment referencing the old GetOptions name that should be updated to match the current type name for consistency.

Location: packages/angular-query-experimental/src/inject-queries.ts:37

Current comment: // This defines the 'CreateQueryOptions' that are accepted in 'QueriesOptions' & 'GetOptions'.

Update to: // This defines the 'CreateQueryOptions' that are accepted in 'QueriesOptions' & 'GetCreateQueryOptionsForCreateQueries'.

πŸ€– Prompt for AI Agents
docs/framework/angular/reference/type-aliases/queriesoptions.md around line 8:
update the outdated comment that still references the old type name; open
packages/angular-query-experimental/src/inject-queries.ts at line 37 and replace
the comment "// This defines the 'CreateQueryOptions' that are accepted in
'QueriesOptions' & 'GetOptions'." with "// This defines the 'CreateQueryOptions'
that are accepted in 'QueriesOptions' &
'GetCreateQueryOptionsForCreateQueries'." to match the renamed type.

@arnoud-dv arnoud-dv merged commit ddf6b80 into TanStack:main Oct 22, 2025
9 checks passed
@arnoud-dv arnoud-dv deleted the fix/angular-devtools-consistent-naming branch October 22, 2025 00:24
@github-actions github-actions bot mentioned this pull request Oct 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation package: angular-query-experimental

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant