Skip to content

Dev/feat roadmap support sync#62

Merged
miccy merged 6 commits intomainfrom
dev/feat-roadmap-support-sync
Mar 3, 2026
Merged

Dev/feat roadmap support sync#62
miccy merged 6 commits intomainfrom
dev/feat-roadmap-support-sync

Conversation

@miccy
Copy link
Contributor

@miccy miccy commented Mar 3, 2026

This pull request updates the project documentation and configuration to introduce a detailed integrations roadmap, clarify the status and scope of framework integrations, and improve coverage reporting and testing for new packages. The changes also include documentation improvements for example apps and minor dependency and TypeScript config updates.

Integrations Roadmap and Documentation:

  • Replaced the informal "Planned Integrations" section in README.md with an executive-style "Integrations Roadmap," providing a snapshot of integration progress, priorities, and actionable upstream issues. Added a reference to a new detailed roadmap document.
  • Added a comprehensive docs/roadmap/integrations.md file detailing integration progress, checklists, and per-framework status, including new and upcoming integrations like Electrobun.

Example App Documentation Improvements:

  • Overhauled examples/react-nextjs/README.md and examples/react-electron/README.md to clarify integration scope, usage instructions, and roadmap links, making them more useful as reference implementations for framework-specific integration and troubleshooting. [1] [2]

Testing and Coverage Enhancements:

  • Added new Vitest test and coverage scripts for react-web and tauri packages in the root package.json, along with corresponding coverage gates and lanes.
  • Set explicit name fields in the Vitest config for react-web and tauri to support multi-project test reporting. [1] [2]

Dependency and TypeScript Config Updates:

  • Updated @vue/tsconfig to version ^0.9.0 in the Vue PWA example.
  • Enabled the noUncheckedIndexedAccess TypeScript compiler option in the Vue PWA example for stricter type safety.

Summary by CodeRabbit

  • Dokumentace

    • Přidán nový Roadmap integracích s detailním přehledem priorit, pokroku a plánů pro jednotlivé integrace.
    • Aktualizovány příklady dokumentace pro React s Electronem, React s Next.js a Vue aplikace s jasným zaměřením.
  • Chores

    • Přidány nové skripty pro testování a kontrolu pokrytí kódu.
    • Aktualizovány konfigurační soubory testů s novými identifikátory projektů.
    • Aktualizovány závislosti a TypeScript možnosti.

@miccy miccy requested review from Jakub-coding99 and Copilot March 3, 2026 11:29
@miccy miccy self-assigned this Mar 3, 2026
@miccy miccy added docs Improvements or additions to documentation update Update libs and deps labels Mar 3, 2026
@coderabbitai
Copy link

coderabbitai bot commented Mar 3, 2026

📝 Walkthrough

Walkthrough

Zmítání zahrnuje aktualizaci dokumentace o integraci a cestovní mapy, reorganizaci příkladů dokumentace s zaměřením na integrační poznámky a cestovní mapy, zásadní změny v konfiguracích testů s přidáním názvů projektů a rozšíření skriptů pokrytí v kořenových package.json.

Changes

Cohort / File(s) Souhrn
Dokumentace cestovní mapy
README.md, docs/roadmap/integrations.md
Nahrazení staré části "Plánované integrace" novou "Integrations Roadmap (Executive View)" s datem, tabulkou na bázi priorit a modelem pokroku. Přidáno nové podrobné dokumenty pro sledování pokroku jednotlivých integrací.
Příklady dokumentace
examples/react-electron/README.md, examples/react-nextjs/README.md
Přeformátování titulků, nahrazení pokynů pro vývoj na integrační poznámky, zjednodušení spouštěcích skriptů na bun a přidání odkazů na cestovní mapy.
Konfigurace projektů
examples/vue-vite-pwa/package.json, examples/vue-vite-pwa/tsconfig.app.json, packages/react-web/vitest.config.ts, packages/tauri/vitest.config.ts
Aktualizace závislostí (@vue/tsconfig), přidání přísného typu (noUncheckedIndexedAccess), a nastavení názvů projektů v konfiguraci testů.
Skripty pokrytí
package.json
Přidání nových skriptů pokrytí a bran pro react-web a tauri projekty, zrcadlící existující strukturu lane/gate/test.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minuty

Poem

🐰 Cestovní mapy nyní září
Integrací mnohem více než bylo dřív,
Skriptech přidáš, konfig seřadíš,
Příklady jasné k novému cíli spěchají,
Králíčí skok vpřed! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title "Dev/feat roadmap support sync" uses vague branch-like naming that doesn't clearly convey the main change from a user/developer perspective. Consider a clearer title like "Add formal integrations roadmap and update example documentation" that better describes the primary changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dev/feat-roadmap-support-sync

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.

@socket-security
Copy link

socket-security bot commented Mar 3, 2026

@socket-security
Copy link

socket-security bot commented Mar 3, 2026

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action Severity Alert  (click "▶" to expand/collapse)
Warn High
Obfuscated code: npm markdown-it is 91.0% likely obfuscated

Confidence: 0.91

Location: Package overview

From: ?npm/typedoc@0.28.17npm/markdown-it@14.1.1

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/markdown-it@14.1.1. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates documentation and monorepo configuration to better track framework integration progress and to add coverage/test lanes for additional packages (react-web, tauri), improving multi-project Vitest reporting and coverage gating consistency across integrations.

Changes:

  • Added an “Integrations Roadmap” executive summary to README.md and introduced a detailed roadmap document under docs/roadmap/.
  • Added new Vitest coverage lane scripts + coverage gates for react-web and tauri, and named their Vitest projects for clearer multi-project reporting.
  • Tightened the Vue PWA example’s TS config (noUncheckedIndexedAccess) and updated @vue/tsconfig.

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/tauri/vitest.config.ts Adds Vitest project name for multi-project reporting (tauri).
packages/react-web/vitest.config.ts Adds Vitest project name for multi-project reporting (react-web).
package.json Adds coverage lane scripts + file gates for react-web and tauri.
examples/vue-vite-pwa/tsconfig.app.json Enables noUncheckedIndexedAccess for stricter example app typing.
examples/vue-vite-pwa/package.json Updates @vue/tsconfig dependency range.
examples/react-nextjs/README.md Replaces template README with integration-focused scope/run/roadmap notes.
examples/react-electron/README.md Replaces template README with integration-focused scope/run/roadmap notes.
docs/roadmap/integrations.md Adds detailed per-integration checklist roadmap document.
bun.lock Lockfile updates reflecting dependency resolution changes (including @vue/tsconfig).
README.md Replaces planned integrations section with roadmap + upstream watch tables and link to detailed roadmap.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
@miccy miccy marked this pull request as ready for review March 3, 2026 12:02
@miccy miccy requested a review from a team as a code owner March 3, 2026 12:02
Copy link

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

🧹 Nitpick comments (1)
examples/react-nextjs/README.md (1)

31-33: Zvažte převod roadmap reference na klikací Markdown odkaz.

V Line 33 je cesta uvedena jako text (docs/roadmap/integrations.md -> Next.js (App Router)), ale bez odkazu. Pro čitelnost a rychlou navigaci je lepší dát sem přímý link (ideálně s anchor).

Návrh úpravy
 ## Roadmap Link
 
-- `docs/roadmap/integrations.md` -> `Next.js (App Router)`
+- [Next.js (App Router) roadmap](../../docs/roadmap/integrations.md#nextjs-app-router)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@examples/react-nextjs/README.md` around lines 31 - 33, V sekci označené "##
Roadmap Link" nahraď prostý text `docs/roadmap/integrations.md` -> `Next.js (App
Router)` klikacím Markdown odkazem; odkaz by měl směřovat na soubor
docs/roadmap/integrations.md a přidat vhodný anchor pro Next.js App Router
(např. docs/roadmap/integrations.md#nextjs-app-router) tak aby text "Next.js
(App Router)" byl samotný klikací odkaz; uprav README.md tak, aby řádek
obsahoval standardní Markdown link syntaxi místo neklikatelného textu.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@examples/react-nextjs/README.md`:
- Around line 31-33: V sekci označené "## Roadmap Link" nahraď prostý text
`docs/roadmap/integrations.md` -> `Next.js (App Router)` klikacím Markdown
odkazem; odkaz by měl směřovat na soubor docs/roadmap/integrations.md a přidat
vhodný anchor pro Next.js App Router (např.
docs/roadmap/integrations.md#nextjs-app-router) tak aby text "Next.js (App
Router)" byl samotný klikací odkaz; uprav README.md tak, aby řádek obsahoval
standardní Markdown link syntaxi místo neklikatelného textu.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55cb458 and d2fe689.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (9)
  • README.md
  • docs/roadmap/integrations.md
  • examples/react-electron/README.md
  • examples/react-nextjs/README.md
  • examples/vue-vite-pwa/package.json
  • examples/vue-vite-pwa/tsconfig.app.json
  • package.json
  • packages/react-web/vitest.config.ts
  • packages/tauri/vitest.config.ts

@miccy miccy merged commit 2fff107 into main Mar 3, 2026
35 checks passed
@miccy miccy deleted the dev/feat-roadmap-support-sync branch March 3, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation update Update libs and deps

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants