npm-pkg-config

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<scope>
Initialize TypeScript projects with proper tooling, type checking, and framework setup.
Reference documentation:
package.md
,
workspace.md
,
typescript.md
,
oxc.md
,
hono.md
,
tanstack-spa.md
,
shadcn-ui.md
,
dev-tools.md
,
ci.md
</scope>
<configuration_decisions>
<scope>
使用合适的工具、类型检查和框架设置来初始化TypeScript项目。
参考文档:
package.md
workspace.md
typescript.md
oxc.md
hono.md
tanstack-spa.md
shadcn-ui.md
dev-tools.md
ci.md
</scope>
<configuration_decisions>

Key Configuration Decisions

关键配置决策

Project visibility:
  • Public → Include LICENSE file
  • Private → Omit license
Package structure:
  • Single package → Root-level configuration
  • Workspace (monorepo) → Root shared config + per-package configs
Application type:
  • Frontend only → TanStack Router + shadcn/ui
  • Backend only → Hono
  • Full-stack → Hono + TanStack Router + shadcn/ui
  • npm library → No framework, focus on build/publish config </configuration_decisions>
<setup_principles>
项目可见性
  • 公开项目 → 包含LICENSE文件
  • 私有项目 → 省略许可证
包结构
  • 单包项目 → 根目录级配置
  • 工作区(单体仓库/monorepo)→ 根目录共享配置 + 每个包独立配置
应用类型
  • 仅前端 → TanStack Router + shadcn/ui
  • 仅后端 → Hono
  • 全栈 → Hono + TanStack Router + shadcn/ui
  • npm库 → 无需框架,聚焦构建/发布配置 </configuration_decisions>
<setup_principles>

Setup Dependencies and Order

依赖项设置与顺序

Required setup sequence (due to configuration dependencies):
  1. Base package (
    package.md
    ): Foundation for all subsequent configs
  2. Workspace structure (
    workspace.md
    ): Only if monorepo - must precede package setup
  3. Linting/formatting (
    oxc.md
    ): Requires package structure to be established
  4. Application setup: Location depends on package structure
    • Single package: Root directory
    • Workspace: Separate
      packages/*/
      directories
    • TypeScript (
      typescript.md
      ): Required for all projects
    • Backend:
      hono.md
    • Frontend SPA:
      tanstack-spa.md
    • UI components:
      shadcn-ui.md
  5. Development tools (
    dev-tools.md
    ): Requires application structure
  6. CI/CD (
    ci.md
    ): Final step after all configs established
Location constraints:
  • Single package: All configs at root
  • Workspace: Shared configs at root, app-specific in
    packages/*/
    </setup_principles>
<reference_index>
必需的设置顺序(因配置依赖关系):
  1. 基础包
    package.md
    ):所有后续配置的基础
  2. 工作区结构
    workspace.md
    ):仅适用于monorepo - 必须在包设置之前完成
  3. 代码检查/格式化
    oxc.md
    ):需要先确定包结构
  4. 应用设置:位置取决于包结构
    • 单包项目:根目录
    • 工作区:独立的
      packages/*/
      目录
    • TypeScript(
      typescript.md
      ):所有项目必需
    • 后端:
      hono.md
    • 前端SPA:
      tanstack-spa.md
    • UI组件:
      shadcn-ui.md
  5. 开发工具
    dev-tools.md
    ):需要先确定应用结构
  6. CI/CD
    ci.md
    ):所有配置完成后的最终步骤
位置约束
  • 单包项目:所有配置在根目录
  • 工作区:共享配置在根目录,应用特定配置在
    packages/*/
    中 </setup_principles>
<reference_index>

Setup Reference Documents

设置参考文档

Core setup (all projects):
  • package.md
    : Package configuration (package.json, pnpm)
  • typescript.md
    : TypeScript strict configuration
  • oxc.md
    : Linting and formatting with oxc
  • dev-tools.md
    : Development utilities
  • ci.md
    : CI/CD pipelines
Structure-specific:
  • workspace.md
    : Monorepo/pnpm workspace setup
Framework-specific:
  • hono.md
    : Backend API with Hono
  • tanstack-spa.md
    : Frontend SPA with TanStack Router
  • shadcn-ui.md
    : UI component library setup
</reference_index>
<best_practices>
核心设置(所有项目):
  • package.md
    :包配置(package.json、pnpm)
  • typescript.md
    :TypeScript严格模式配置
  • oxc.md
    :使用oxc进行代码检查和格式化
  • dev-tools.md
    :开发实用工具
  • ci.md
    :CI/CD流水线
结构特定
  • workspace.md
    :单体仓库/pnpm工作区设置
框架特定
  • hono.md
    :使用Hono构建后端API
  • tanstack-spa.md
    :使用TanStack Router构建前端SPA
  • shadcn-ui.md
    :UI组件库设置
</reference_index>
<best_practices>

Configuration Best Practices

配置最佳实践

TypeScript:
  • Always use strict type checking
  • Configure path aliases for clean imports
Package management:
  • Use pnpm for all TypeScript projects
  • Configure workspace protocol for monorepo dependencies
Tooling consistency:
  • oxc for linting and formatting (faster than ESLint/Prettier)
  • Consistent script names across workspace packages
</best_practices>
TypeScript
  • 始终启用严格类型检查
  • 配置路径别名以实现清晰的导入
包管理
  • 所有TypeScript项目使用pnpm
  • 为单体仓库依赖项配置工作区协议
工具一致性
  • 使用oxc进行代码检查和格式化(比ESLint/Prettier更快)
  • 工作区所有包使用一致的脚本名称
</best_practices>