搜索

PythonReactSEOPDF
GitHub Skill

next-project-structure

Authoritative guide on Next.js 16+ App Router structure. Use this skill to determine where files should be created, how to name them for routing, and how to organize project architecture.

HenryXV☆ 1 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

Next.js Project Structure

Purpose

This skill defines the folder and file conventions for Next.js App Router applications. Use this to ensure file placement dictates the correct routing behavior and architectural consistency.

Usage

When creating new features or refactoring, you must first identify the project's Organization Strategy (see below) to determine where files belong.

1. Top-Level Organization Strategies

Identify which strategy the project is using and strictly adhere to it. Do not mix strategies.

Strategy Description Indicator
Store in src Application code lives in src/app. Config files live in root. src/app/page.tsx exists
Root app Application code lives in app. Config files live in root. app/page.tsx exists
Split by Feature Global code in app; feature code colocated in route segments. app/dashboard/_components/ exists
External Projects Project files live in components/ or lib/ at root, outside app. components/ exists at root

2. File Conventions (Quick Ref)

Next.js uses file-system based routing. The filename determines the behavior.

  • Routes: Must be named page.tsx or route.ts.
  • UI Wrappers: layout.tsx (persistent), template.tsx (re-mounted).
  • Data UI: loading.tsx (Suspense), error.tsx (Error Boundary).

For the complete table of supported file names and their hierarchy, read: references/file-conventions.md

3. Routing & Groups

Do not rely on folder names alone for URL structure.

  • URL Segments: app/blog/page.tsx -> /blog
  • Route Groups: app/(marketing)/page.tsx -> / (Folder name omitted from URL)
  • Private Folders: app/_utils/ -> Not routable.

For advanced patterns (Dynamic [id], Parallel @slot, Intercepting (.)), read: references/routing-patterns.md

Validation Checklist

Before finalizing a file creation:

  1. Does the file name match a reserved Next.js convention (e.g., page.tsx)?
  2. Is the file inside the correct Route Group (if applicable)?
  3. Are colocated components properly marked private (in _folders) if they shouldn't be routable?

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-26
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!