Skip to content
vibespell

.github/copilot-instructions.md

Copilot instructions for Nuxt

GitHub Copilot reads `.github/copilot-instructions.md` and applies it across the repository. It is the place for build commands, review rules, and stack conventions Copilot should not invent. This copy is written for a Nuxt project. This repository is a Nuxt 3 app. Data for a page comes from useAsyncData or a server route. Auto-imports match the project. Do not add a second meta-framework.

The example uses a balanced, readable style, pragmatic tests, and comments only where the intent is not obvious. Open the generator to make the agent stricter, switch to test-first, quiet the comments, or pick a different file.

The example assumes Nuxt 3. It does not assume Nuxt UI, Pinia, or a particular database. Use what nuxt.config already wires up.

Customize in the generatorBrowse the library

Example file

Balanced strictness, readable style, pragmatic tests. Download name: copilot-instructions.md

# GitHub Copilot instructions

These instructions apply to the whole Nuxt repository. Copilot reads them from `.github/copilot-instructions.md`.
Prefer the commands and layout below over guesses.

## Stack

This repository is a Nuxt 3 app. Data for a page comes from useAsyncData or a server route. Auto-imports match the project. Do not add a second meta-framework.

## Layout

- Pages live in `pages/` or the app directory the project uses. Components live in `components/`.
- Server routes live in `server/api`. Server-only utilities live in `server/utils`.
- Do not import server code into a Vue component.

## Commands

- Dev server: `npm run dev`
- Build: `npm run build`
- Typecheck: `npm run typecheck`

Use the script the repo already defines when it differs from the command above.

## Conventions

- Load page data with `useAsyncData` or `useFetch` against a server route.
- Mutations go through server routes. Validate the body there.
- Respect the project's auto-import style. Do not mix a manual import convention in one file.
- Use `<script setup>` and the Composition API.
- Runtime config splits public and private keys the way nuxt.config already does.
- Match the UI library already installed.

## Testing

Add or update tests when behavior changes.

Test the server route handler or a pure composable. Cover one bad payload.

## Style

- Optimize for the next reader over the shortest diff.
- Comment only when the why is non-obvious.
- Name things the way neighboring files already do.
- Do not reformat code you did not change.

## Errors

- Fail at the boundary. Do not swallow errors.
- Throw a createError with a status code for expected failures so the error page can render.

## Scope

- Do the requested task. Do not refactor unrelated code.
- Match the rigor already in the repo. Fix what you touch.
- Ask one clarifying question only when the task cannot be finished without it. Otherwise state the assumption and continue.

## Avoid

- Do not fetch in `onMounted` for data the server can load.
- Do not read a private runtime config key in a component.
- Do not disable SSR to dodge a window access bug.
- Do not add Pinia if the page can keep local state.

## Done when

- The requested behavior works.
- `npm run build` succeeds and the page loads with JavaScript disabled if it is a content page.
- The diff stays inside the task.
- You list anything you could not run.

## Review checklist

- The change matches the commands and layout in this file.
- No new dependency was added without a reason already present in the repo.
- Private runtime config never reaches the client.
- Validate server-route bodies. Do not trust the client.
- Keep auth checks in the server route, not only in middleware UI redirects.

Add it to the project

  1. 01

    Copy a starting file

    Copy the example Copilot instructions on this page, or open the generator if you want different testing, strictness, or comment rules.

  2. 02

    Save it at .github/copilot-instructions.md

    Save it as `.github/copilot-instructions.md` in the Nuxt repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.

  3. 03

    Start a fresh agent session

    Rules files are read when a session starts. A chat that is already open may still be using the old instructions.

  4. 04

    Give it one small task

    Ask for one change a Nuxt agent often gets wrong, such as a page whose data comes from useAsyncData instead of onMounted. If it ignores the file, confirm the path and start a new session.

Questions about this file

Where do I put Copilot instructions in a Nuxt repo?

Save it as `.github/copilot-instructions.md` in the Nuxt repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.

Which tools read this Copilot instructions?

GitHub Copilot in VS Code, Visual Studio, and Copilot cloud agents read this file. Other agents will not load it automatically, so keep an AGENTS.md too if more than one tool edits the repo.

What does the Nuxt example assume?

The example assumes Nuxt 3. It does not assume Nuxt UI, Pinia, or a particular database. Use what nuxt.config already wires up.

Does VibeSpell upload my repository?

No. Recipe pages are static, and the generator builds the file in your browser from the options you pick. Your source code never leaves the machine.

Other files for Nuxt

Copilot instructions for other stacks