cloudwerk-routing

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Cloudwerk Routing

Cloudwerk 路由

File-based routing conventions for Cloudwerk. The
app/
directory structure maps directly to URL patterns, with special filenames determining behavior.
Cloudwerk的基于文件的路由规范。
app/
目录结构直接映射到URL模式,特殊文件名决定路由行为。

When to Apply

适用场景

Reference these guidelines when:
  • Creating new pages or API routes in a Cloudwerk app
  • Adding layouts that wrap multiple pages
  • Implementing middleware for auth, rate limiting, or request processing
  • Using dynamic route segments (
    [id]
    ,
    [...slug]
    )
  • Loading data with
    loader()
    or handling mutations with
    action()
  • Adding error or not-found boundaries
参考本规范的场景包括:
  • 在Cloudwerk应用中创建新页面或API路由时
  • 添加可包裹多个页面的布局时
  • 实现用于身份验证、速率限制或请求处理的中间件时
  • 使用动态路由段(
    [id]
    [...slug]
    )时
  • 使用
    loader()
    加载数据或使用
    action()
    处理变更时
  • 添加错误边界或404页面边界时

Rule Categories by Priority

规则分类及优先级

PriorityCategoryImpactPrefix
1Route FilesCRITICAL
files-
2Dynamic ParametersHIGH
params-
3Data LoadingHIGH
data-
优先级分类影响程度前缀
1路由文件关键
files-
2动态参数
params-
3数据加载
data-

Quick Reference

快速参考

1. Route Files (CRITICAL)

1. 路由文件(关键)

  • files-page-component
    - page.tsx conventions for rendering UI
  • files-api-route
    - route.ts conventions for API endpoints
  • files-layout
    - layout.tsx conventions for shared UI wrappers
  • files-middleware
    - middleware.ts conventions for request processing
  • files-error-boundary
    - error.tsx conventions for error handling
  • files-not-found-boundary
    - not-found.tsx conventions for 404 pages
  • files-page-component
    - 用于渲染UI的page.tsx规范
  • files-api-route
    - 用于API端点的route.ts规范
  • files-layout
    - 用于共享UI包裹层的layout.tsx规范
  • files-middleware
    - 用于请求处理的middleware.ts规范
  • files-error-boundary
    - 用于错误处理的error.tsx规范
  • files-not-found-boundary
    - 用于404页面的not-found.tsx规范

2. Dynamic Parameters (HIGH)

2. 动态参数(高)

  • params-dynamic-segments
    - [id] syntax for single dynamic segments
  • params-catch-all
    - [...slug] syntax for catch-all routes
  • params-route-groups
    - (group) syntax for layout grouping without URL impact
  • params-dynamic-segments
    - 单个动态路由段的[id]语法
  • params-catch-all
    - 通配符路由的[...slug]语法
  • params-route-groups
    - 不影响URL的布局分组((group))语法

3. Data Loading (HIGH)

3. 数据加载(高)

  • data-loader
    - loader() function for server-side data fetching
  • data-action
    - action() function for form submissions and mutations
  • data-error-control-flow
    - NotFoundError/RedirectError for flow control
  • data-context-api
    - getContext(), get(), set() for request-scoped data
  • data-loader
    - 用于服务端数据获取的
    loader()
    函数
  • data-action
    - 用于表单提交和变更处理的
    action()
    函数
  • data-error-control-flow
    - 用于流程控制的NotFoundError/RedirectError
  • data-context-api
    - 用于请求作用域数据的getContext()、get()、set()方法

How to Use

使用方法

Read individual rule files for detailed explanations and code examples:
rules/files-page-component.md
rules/data-loader.md
Each rule file contains:
  • Brief explanation of why it matters
  • Incorrect code example with explanation
  • Correct code example with explanation
  • Additional context and references
阅读单个规则文件以获取详细说明和代码示例:
rules/files-page-component.md
rules/data-loader.md
每个规则文件包含:
  • 规则重要性的简要说明
  • 错误代码示例及解释
  • 正确代码示例及解释
  • 额外背景信息及参考资料