Skip to content

feat(create-astro): ts-check comment #11924

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

Merged
florian-lefebvre merged 2 commits into from
Sep 6, 2024
Merged

feat(create-astro): ts-check comment #11924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f217cb2
feat(create-astro): ts-check comment
florian-lefebvre Sep 5, 2024
e2f46c3
Merge branch 'main' into feat/config-ts-check
florian-lefebvre Sep 6, 2024
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
5 changes: 5 additions & 0 deletions .changeset/nasty-dogs-sort.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-astro': patch
---

Updates the default Astro config with `// @ts-check` if the Typescript preset is `strict` or `strictest`
15 changes: 15 additions & 0 deletions packages/create-astro/src/actions/typescript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,21 @@ const FILES_TO_UPDATE = {
}
}
},
'astro.config.mjs': async (file: string, options: { value: string }) => {
if (!(options.value === 'strict' || options.value === 'strictest')) {
return;
}

try {
let data = await readFile(file, { encoding: 'utf-8' });
data = `// @ts-check\n${data}`;
await writeFile(file, data, { encoding: 'utf-8' });
} catch (err) {
// if there's no astro.config.mjs (which is very unlikely), then do nothing
if (err && (err as any).code === 'ENOENT') return;
if (err instanceof Error) throw new Error(err.message);
}
},
};

export async function setupTypeScript(value: string, ctx: PickedTypeScriptContext) {
Expand Down