Skip to content

feat(cli): add Astro framework support #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ardasoyturk wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat(cli): add Astro framework support #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f715df
feat(cli): add Astro framework support
ardasoyturk Mar 14, 2026
b0f66fd
fix(cli): resolve Astro support issues
ardasoyturk Mar 14, 2026
f48382c
test: add Astro vs Vite priority detection test
ardasoyturk Mar 14, 2026
02006cb
fix(cli): resolve additional Astro support issues
ardasoyturk Mar 14, 2026
84d7195
fix(cli): resolve force guard and indentation issues in Astro support
ardasoyturk Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/cli/src/commands/init.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ const FRAMEWORK_NAMES: Record<Framework, string> = {
vite: "Vite",
tanstack: "TanStack Start",
webpack: "Webpack",
astro: "Astro",
unknown: "Unknown",
};

Expand All @@ -96,7 +97,6 @@ const UNSUPPORTED_FRAMEWORK_NAMES: Record<
string
> = {
remix: "Remix",
astro: "Astro",
sveltekit: "SvelteKit",
gatsby: "Gatsby",
};
Expand Down Expand Up @@ -342,7 +342,10 @@ export const init = new Command()
title: "Toggle (press to activate/deactivate)",
value: "toggle",
},
{ title: "Hold (hold key to keep active)", value: "hold" },
{
title: "Hold (hold key to keep active)",
value: "hold",
},
],
initial: 0,
});
Expand Down Expand Up @@ -911,7 +914,7 @@ export const init = new Command()
frameworkSpinner.fail("Could not detect a supported framework.");
logger.break();
logger.log(
"React Grab supports Next.js, Vite, TanStack Start, and Webpack projects.",
"React Grab supports Next.js, Vite, TanStack Start, Astro, and Webpack projects.",
);
logger.log(`Visit ${highlighter.info(DOCS_URL)} for manual setup.`);
logger.break();
Expand Down
36 changes: 25 additions & 11 deletions packages/cli/src/utils/detect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ import { detect } from "@antfu/ni";
import ignore from "ignore";

export type PackageManager = "npm" | "yarn" | "pnpm" | "bun";
export type Framework = "next" | "vite" | "tanstack" | "webpack" | "unknown";
export type NextRouterType = "app" | "pages" | "unknown";
export type UnsupportedFramework =
| "remix"
export type Framework =
| "next"
| "vite"
| "tanstack"
| "webpack"
| "astro"
| "sveltekit"
| "gatsby"
| null;
| "unknown";
export type NextRouterType = "app" | "pages" | "unknown";
export type UnsupportedFramework = "remix" | "sveltekit" | "gatsby" | null;

export interface ProjectInfo {
packageManager: PackageManager;
Expand Down Expand Up @@ -68,6 +69,10 @@ export const detectFramework = (projectRoot: string): Framework => {
return "tanstack";
}

if (allDependencies["astro"]) {
return "astro";
}

if (allDependencies["vite"]) {
return "vite";
}
Expand Down Expand Up @@ -413,6 +418,19 @@ export const detectReactGrab = (projectRoot: string): boolean => {
join(projectRoot, "src", "routes", "__root.jsx"),
join(projectRoot, "app", "routes", "__root.tsx"),
join(projectRoot, "app", "routes", "__root.jsx"),
join(projectRoot, "src", "layouts", "Layout.astro"),
join(projectRoot, "src", "layouts", "_BaseLayout.astro"),
join(projectRoot, "src", "layouts", "_Layout.astro"),
join(projectRoot, "src", "layouts", "BaseLayout.astro"),
join(projectRoot, "layouts", "Layout.astro"),
join(projectRoot, "layouts", "_BaseLayout.astro"),
join(projectRoot, "layouts", "_Layout.astro"),
join(projectRoot, "layouts", "BaseLayout.astro"),
join(projectRoot, "src", "pages", "index.astro"),
join(projectRoot, "src", "pages", "_layout.astro"),
join(projectRoot, "pages", "index.astro"),
join(projectRoot, "Layout.astro"),
join(projectRoot, "index.astro"),
];

return filesToCheck.some(hasReactGrabInFile);
Expand Down Expand Up @@ -450,10 +468,6 @@ export const detectUnsupportedFramework = (
return "remix";
}

if (allDependencies["astro"]) {
return "astro";
}

if (allDependencies["@sveltejs/kit"]) {
return "sveltekit";
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli/src/utils/templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,25 @@ export const TANSTACK_EFFECT_WITH_AGENT = (agent: AgentIntegration): string => {
}, []);`;
};

export const ASTRO_EFFECT = `{import.meta.env.DEV && (
<script>
if (import.meta.env.DEV) {
import("react-grab");
}
</script>
)}`;

export const ASTRO_EFFECT_WITH_AGENT = (agent: AgentIntegration): string => {
if (agent === "none") return ASTRO_EFFECT;

return `{import.meta.env.DEV && (
<script>
if (import.meta.env.DEV) {
import("react-grab");
import("@react-grab/${agent}/client");
}
</script>
)}`;
};

export const SCRIPT_IMPORT = 'import Script from "next/script";';
Loading