chore: fix/check tooling improvements with turbo by lifeiscontent · Pull Request #8304 · makeplane/plane

lifeiscontent · 2025-12-10T17:43:17Z

Type of Change

Performance improvements

Summary by CodeRabbit

Chores
- Enabled caching for ESLint and Prettier across apps and packages to speed up linting/formatting.
- Updated task orchestration to leverage cached lint/format outputs.
Style
- Adjusted ESLint rule configuration for more consistent rule placement.
Refactor
- Simplified type handling during core session initialization (no runtime behavior changes).

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

coderabbitai · 2025-12-10T17:43:32Z

Walkthrough

Enabled ESLint and Prettier caching across many packages, adjusted ESLint rule placement in eslint.config.mjs, updated turbo.json to declare cache inputs/outputs and dependencies, and removed an unnecessary TypeScript cast in a Yjs hook.

Changes

Cohort / File(s)	Summary
App package.json files `apps/admin/package.json`, `apps/live/package.json`, `apps/space/package.json`, `apps/web/package.json`	Added `--cache` and `--cache-location node_modules/.cache/eslint/` to ESLint check/fix scripts; added `--cache` to Prettier check/fix scripts.
Package package.json files `packages/constants/package.json`, `packages/decorators/package.json`, `packages/editor/package.json`, `packages/hooks/package.json`, `packages/i18n/package.json`, `packages/logger/package.json`, `packages/propel/package.json`, `packages/services/package.json`, `packages/shared-state/package.json`, `packages/types/package.json`, `packages/ui/package.json`, `packages/utils/package.json`	Added `--cache` and `--cache-location node_modules/.cache/eslint/` to ESLint check/fix scripts; added `--cache` to Prettier check/fix scripts.
ESLint configuration `eslint.config.mjs`	Moved/added `import/consistent-type-specifier-style: ["error","prefer-top-level"]` into the TS/TSX-specific block and changed `react-refresh/only-export-components` rule to `["warn", { allowExportNames: [...] }]` where applicable.
Turbo build configuration `turbo.json`	Added `.prettierrc` and `eslint.config.mjs` to `globalDependencies`; declared outputs for `check:format`/`check:lint` and added inputs/dependsOn/outputs for `fix:lint`/`fix:format` tasks to track cache artifacts.
Type cast removal `packages/editor/src/core/hooks/use-yjs-setup.ts`	Removed an explicit `as Y.Doc` cast when assigning `provider.document`; relies on inferred typing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Spot-check:
- Consistent node_modules/.cache/eslint/ usage across all package.json scripts
- turbo.json outputs/inputs match the cache locations and task names
- ESLint rule placement in eslint.config.mjs behaves as intended for JS vs TS files
- Type inference in use-yjs-setup.ts compiles without TypeScript errors

Possibly related PRs

feat: adding standard scripts for lint and format check #7326 — Modifies the same lint/format scripts and turbo task configuration; closely related to caching and task orchestration changes.

Suggested reviewers

prateekshourya29

Poem

🐰 I dug a little cache today,
To speed the linters on their way.
Prettier hums and ESLint sings,
Turbo keeps those tiny things.
Hop, hop — the repo springs!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is largely incomplete; only a single unchecked checkbox is provided with no actual description, change details, type selection, test scenarios, or references.	Complete the PR description by adding: a detailed Description section explaining the changes, selection of appropriate Type of Change checkbox(es), Test Scenarios explaining verification steps, and any relevant References/linked issues.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'chore: fix/check tooling improvements with turbo' accurately summarizes the main change—enabling ESLint/Prettier caching and updating Turbo configuration across multiple package.json files and configuration.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch lifeiscontent/tooling-improvements

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.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

eslint.config.mjs (1)

138-141: Lint rule tweaks look correct; consider future non-component exports

The updated react-refresh/only-export-components rule with allowExportNames: ["meta", "links", "headers", "loader", "action"] matches typical React Router route module exports, so this should reduce false positives without weakening Fast Refresh safeguards.

Moving import/consistent-type-specifier-style into the TS override with ["error", "prefer-top-level"] is consistent with the repo preference for top‑level import type statements instead of inline type imports. Based on learnings.

If you later add other non-component route exports (e.g., additional metadata handlers), you may want to extend allowExportNames to avoid new false positives.

Also applies to: 163-165

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e20f686 and da1588e.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (19)

apps/admin/package.json (1 hunks)
apps/live/package.json (1 hunks)
apps/space/package.json (1 hunks)
apps/web/package.json (1 hunks)
eslint.config.mjs (2 hunks)
packages/constants/package.json (1 hunks)
packages/decorators/package.json (1 hunks)
packages/editor/package.json (1 hunks)
packages/editor/src/core/hooks/use-yjs-setup.ts (1 hunks)
packages/hooks/package.json (1 hunks)
packages/i18n/package.json (1 hunks)
packages/logger/package.json (1 hunks)
packages/propel/package.json (1 hunks)
packages/services/package.json (1 hunks)
packages/shared-state/package.json (1 hunks)
packages/types/package.json (1 hunks)
packages/ui/package.json (1 hunks)
packages/utils/package.json (1 hunks)
turbo.json (3 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{js,mjs,cjs}

📄 CodeRabbit inference engine (.github/instructions/typescript.instructions.md)

Use @import tags in JSDoc for cleaner type imports in JavaScript files when working in a mixed codebase (TypeScript 5.5+)

Files:

eslint.config.mjs

{turbo.json,**/*.sh}

📄 CodeRabbit inference engine (.github/instructions/bash.instructions.md)

Use Turbo for build system orchestration with configuration in turbo.json

Files:

turbo.json

**/*.{ts,tsx,mts,cts}

📄 CodeRabbit inference engine (.github/instructions/typescript.instructions.md)

**/*.{ts,tsx,mts,cts}: Use const type parameters for more precise literal inference in TypeScript 5.0+
Use the satisfies operator to validate types without widening them
Leverage inferred type predicates to reduce the need for explicit is return types in filter/check functions
Use NoInfer<T> utility to block inference for specific type arguments when they should be determined by other arguments
Utilize narrowing in switch(true) blocks for control flow analysis (TypeScript 5.3+)
Rely on narrowing from direct boolean comparisons for type guards
Trust preserved narrowing in closures when variables aren't modified after the check (TypeScript 5.4+)
Use constant indices to narrow object/array properties (TypeScript 5.5+)
Use standard ECMAScript decorators (Stage 3) instead of legacy experimentalDecorators
Use using declarations for explicit resource management with Disposable pattern instead of manual cleanup (TypeScript 5.2+)
Use with { type: "json" } for import attributes; avoid deprecated assert syntax (TypeScript 5.3/5.8+)
Use import type explicitly when importing types to ensure they are erased during compilation, respecting verbatimModuleSyntax flag
Use .ts, .mts, .cts extensions in import type statements (TypeScript 5.2+)
Use import type { Type } from "mod" with { "resolution-mode": "import" } for specific module resolution contexts (TypeScript 5.3+)
Use new iterator methods (map, filter, etc.) if targeting modern environments (TypeScript 5.6+)
Utilize new Set methods like union, intersection, etc., when available (TypeScript 5.5+)
Use Object.groupBy / Map.groupBy standard methods for grouping instead of external libraries (TypeScript 5.4+)
Use Promise.withResolvers() for creating promises with exposed resolve/reject functions (TypeScript 5.7+)
Use copying array methods (toSorted, toSpliced, with) for immutable array operations (TypeScript 5.2+)
Avoid accessing instance fields via super in classes (TypeScript 5....

Files:

packages/editor/src/core/hooks/use-yjs-setup.ts

🧠 Learnings (13)

📚 Learning: 2025-11-25T10:17:39.709Z

Learnt from: CR
Repo: makeplane/plane PR: 0
File: .github/instructions/bash.instructions.md:0-0
Timestamp: 2025-11-25T10:17:39.709Z
Learning: Applies to {turbo.json,**/*.sh} : Use Turbo for build system orchestration with configuration in turbo.json

Applied to files:

packages/types/package.json
packages/decorators/package.json
packages/utils/package.json
packages/constants/package.json
apps/admin/package.json
packages/hooks/package.json
turbo.json
packages/i18n/package.json
apps/space/package.json
packages/services/package.json
packages/editor/package.json
packages/shared-state/package.json
apps/live/package.json
packages/logger/package.json
packages/propel/package.json