Skip to content

Conversation

@birkskyum
Copy link
Member

@birkskyum birkskyum commented Nov 23, 2025

Due to a missing .prettierignore missing in one of the e2e projects, e.g. the cloudflare worker types keep showing up as diffs in PRs

Summary by CodeRabbit

  • Chores
    • Added Prettier ignore files across example and e2e projects to prevent formatting of build/public outputs, lockfiles, and generated route-tree files.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 23, 2025

Walkthrough

Multiple new .prettierignore files were added across e2e and example projects to exclude build/public outputs, pnpm-lock.yaml, and generated routeTree.gen.ts (and similar) from Prettier formatting.

Changes

Cohort / File(s) Summary
e2e — Solid Start examples
e2e/solid-start/basic-cloudflare/.prettierignore, e2e/solid-start/basic-solid-query/.prettierignore, e2e/solid-start/query-integration/.prettierignore
Add .prettierignore files ignoring build/public outputs, pnpm-lock.yaml, and routeTree.gen.ts (or similar generated files).
Examples — React
examples/react/start-i18n-paraglide/.prettierignore, examples/react/start-large/.prettierignore, examples/react/start-material-ui/.prettierignore
Add .prettierignore files with patterns: **/build, **/public, pnpm-lock.yaml, routeTree.gen.ts.
Examples — Solid
examples/solid/start-convex-better-auth/.prettierignore, examples/solid/start-counter/.prettierignore, examples/solid/start-i18n-paraglide/.prettierignore, examples/solid/start-large/.prettierignore, examples/solid/start-streaming-data-from-server-functions/.prettierignore
Add .prettierignore files ignoring build/public directories, lockfile, and generated route tree files (routeTree.gen.ts).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Potential attention points:

  • Verify ignore patterns are consistent across examples (wildcards and filenames).
  • Confirm routeTree.gen.ts is the correct generated filename in each project.

Possibly related PRs

Suggested reviewers

  • schiller-manuel

Poem

🐰
A tiny file to skip and hide,
Public builds and locks aside,
Generated trees I’ll let them be,
Prettier hops with grace and glee,
Formatting peace beneath the tree.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'format: add missing .prettierignore files' directly and accurately describes the main change—adding .prettierignore files across multiple projects to configure Prettier ignore patterns.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch format--worker-configuration

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a04aec3 and 035addb.

📒 Files selected for processing (10)
  • e2e/solid-start/basic-solid-query/.prettierignore (1 hunks)
  • e2e/solid-start/query-integration/.prettierignore (1 hunks)
  • examples/react/start-i18n-paraglide/.prettierignore (1 hunks)
  • examples/react/start-large/.prettierignore (1 hunks)
  • examples/react/start-material-ui/.prettierignore (1 hunks)
  • examples/solid/start-convex-better-auth/.prettierignore (1 hunks)
  • examples/solid/start-counter/.prettierignore (1 hunks)
  • examples/solid/start-i18n-paraglide/.prettierignore (1 hunks)
  • examples/solid/start-large/.prettierignore (1 hunks)
  • examples/solid/start-streaming-data-from-server-functions/.prettierignore (1 hunks)
✅ Files skipped from review due to trivial changes (9)
  • e2e/solid-start/query-integration/.prettierignore
  • examples/react/start-material-ui/.prettierignore
  • examples/solid/start-i18n-paraglide/.prettierignore
  • examples/react/start-large/.prettierignore
  • examples/solid/start-counter/.prettierignore
  • examples/solid/start-streaming-data-from-server-functions/.prettierignore
  • examples/solid/start-convex-better-auth/.prettierignore
  • e2e/solid-start/basic-solid-query/.prettierignore
  • examples/react/start-i18n-paraglide/.prettierignore
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: schiller-manuel
Repo: TanStack/router PR: 5330
File: e2e/react-start/custom-basepath/src/routeTree.gen.ts:58-61
Timestamp: 2025-10-01T18:31:35.420Z
Learning: Do not review files named `routeTree.gen.ts` in TanStack Router repositories, as these are autogenerated files that should not be manually modified.
Learnt from: nlynzaad
Repo: TanStack/router PR: 5402
File: packages/router-generator/tests/generator/no-formatted-route-tree/routeTree.nonnested.snapshot.ts:19-21
Timestamp: 2025-10-08T08:11:47.088Z
Learning: Test snapshot files in the router-generator tests directory (e.g., files matching the pattern `packages/router-generator/tests/generator/**/routeTree*.snapshot.ts` or `routeTree*.snapshot.js`) should not be modified or have issues flagged, as they are fixtures used to verify the generator's output and are intentionally preserved as-is.
Learnt from: hokkyss
Repo: TanStack/router PR: 5418
File: e2e/react-start/custom-identifier-prefix/src/styles/app.css:19-21
Timestamp: 2025-10-09T12:59:02.129Z
Learning: In e2e test directories (paths containing `e2e/`), accessibility concerns like outline suppression patterns are less critical since the code is for testing purposes, not production use.
Learnt from: hokkyss
Repo: TanStack/router PR: 5418
File: e2e/react-start/custom-identifier-prefix/public/site.webmanifest:2-3
Timestamp: 2025-10-09T12:59:14.842Z
Learning: In e2e test fixtures (files under e2e directories), empty or placeholder values in configuration files like site.webmanifest are acceptable and should not be flagged unless the test specifically validates those fields.
📚 Learning: 2025-10-01T18:31:35.420Z
Learnt from: schiller-manuel
Repo: TanStack/router PR: 5330
File: e2e/react-start/custom-basepath/src/routeTree.gen.ts:58-61
Timestamp: 2025-10-01T18:31:35.420Z
Learning: Do not review files named `routeTree.gen.ts` in TanStack Router repositories, as these are autogenerated files that should not be manually modified.

Applied to files:

  • examples/solid/start-large/.prettierignore
📚 Learning: 2025-10-08T08:11:47.088Z
Learnt from: nlynzaad
Repo: TanStack/router PR: 5402
File: packages/router-generator/tests/generator/no-formatted-route-tree/routeTree.nonnested.snapshot.ts:19-21
Timestamp: 2025-10-08T08:11:47.088Z
Learning: Test snapshot files in the router-generator tests directory (e.g., files matching the pattern `packages/router-generator/tests/generator/**/routeTree*.snapshot.ts` or `routeTree*.snapshot.js`) should not be modified or have issues flagged, as they are fixtures used to verify the generator's output and are intentionally preserved as-is.

Applied to files:

  • examples/solid/start-large/.prettierignore
📚 Learning: 2025-11-02T16:16:24.898Z
Learnt from: nlynzaad
Repo: TanStack/router PR: 5732
File: packages/start-client-core/src/client/hydrateStart.ts:6-9
Timestamp: 2025-11-02T16:16:24.898Z
Learning: In packages/start-client-core/src/client/hydrateStart.ts, the `import/no-duplicates` ESLint disable is necessary for imports from `#tanstack-router-entry` and `#tanstack-start-entry` because both aliases resolve to the same placeholder file (`fake-start-entry.js`) in package.json during static analysis, even though they resolve to different files at runtime.

Applied to files:

  • examples/solid/start-large/.prettierignore
⏰ 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: Preview
  • GitHub Check: Test
🔇 Additional comments (1)
examples/solid/start-large/.prettierignore (1)

1-4: Configuration looks good.

The ignore patterns correctly exclude build artifacts (**/build, **/public), lock files (pnpm-lock.yaml), and autogenerated route tree files (routeTree.gen.ts) from Prettier formatting, which aligns with the PR objective to prevent these from appearing as diffs in unrelated PRs.


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 Nov 23, 2025

View your CI Pipeline Execution ↗ for commit 035addb

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded 1m 18s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-24 10:28:41 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 23, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5951

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5951

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5951

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5951

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5951

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5951

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5951

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5951

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5951

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5951

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5951

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5951

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5951

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5951

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5951

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5951

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5951

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5951

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5951

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5951

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5951

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5951

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5951

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@5951

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5951

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5951

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5951

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5951

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5951

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5951

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5951

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5951

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5951

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5951

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5951

commit: 035addb

@birkskyum birkskyum marked this pull request as draft November 23, 2025 20:43
@birkskyum birkskyum marked this pull request as ready for review November 24, 2025 10:18
@birkskyum birkskyum changed the title format: worker-configuration format: add missing .prettierignore files Nov 24, 2025
@birkskyum birkskyum merged commit 6e0de0a into main Nov 24, 2025
6 checks passed
@birkskyum birkskyum deleted the format--worker-configuration branch November 24, 2025 10:29
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.

2 participants