universal-dev-standards 5.17.0 → 6.0.0

package/bundled/locales/zh-CN/options/project-structure/kotlin.md

@@ -0,0 +1,144 @@
+---
+source: options/project-structure/kotlin.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# Kotlin 项目结构
+
+> **语言**: [English](../../../../options/project-structure/kotlin.md) | 简体中文
+
+**上层标准**: [项目结构](../../core/project-structure.md)
+
+---
+
+## 概览
+
+Kotlin 项目通常使用 Gradle 进行构建管理，并遵循与 Java 类似的约定。Kotlin 支持多种平台，包括 JVM、Android 与 Kotlin Multiplatform。
+
+## 项目类型
+
+### Gradle (JVM)
+
+```
+project-root/
+├── src/
+│   ├── main/
+│   │   ├── kotlin/
+│   │   │   └── com/example/app/
+│   │   │       ├── Application.kt
+│   │   │       ├── config/
+│   │   │       ├── controller/
+│   │   │       ├── service/
+│   │   │       ├── repository/
+│   │   │       └── model/
+│   │   └── resources/
+│   │       └── application.yml
+│   └── test/
+│       ├── kotlin/
+│       │   └── com/example/app/
+│       └── resources/
+├── build.gradle.kts      # Gradle Kotlin DSL
+├── settings.gradle.kts
+├── gradle.properties
+└── gradlew
+```
+
+### Android
+
+```
+project-root/
+├── app/
+│   ├── src/
+│   │   ├── main/
+│   │   │   ├── kotlin/
+│   │   │   ├── res/
+│   │   │   └── AndroidManifest.xml
+│   │   ├── test/
+│   │   └── androidTest/
+│   └── build.gradle.kts
+├── build.gradle.kts
+├── settings.gradle.kts
+└── gradle.properties
+```
+
+### Kotlin Multiplatform
+
+```
+project-root/
+├── shared/
+│   ├── src/
+│   │   ├── commonMain/kotlin/
+│   │   ├── commonTest/kotlin/
+│   │   ├── androidMain/kotlin/
+│   │   ├── iosMain/kotlin/
+│   │   └── jvmMain/kotlin/
+│   └── build.gradle.kts
+├── androidApp/
+├── iosApp/
+└── build.gradle.kts
+```
+
+## 配置文件
+
+| 文件 | 用途 | Required |
+|------|------|----------|
+| `build.gradle.kts` | 构建配置（Kotlin DSL） | Yes |
+| `settings.gradle.kts` | 项目设置 | Yes |
+| `gradle.properties` | Gradle 属性 | No |
+| `gradle/libs.versions.toml` | 版本目录（version catalog） | No (recommended) |
+
+## .gitignore
+
+```
+build/
+.gradle/
+*.iml
+.idea/
+local.properties
+*.apk
+*.aab
+```
+
+## 工具
+
+| 类别 | 工具 |
+|------|------|
+| Build | Gradle, Gradle Kotlin DSL |
+| Test Runner | JUnit5, Kotest, MockK |
+| Linter | Detekt, ktlint |
+| Formatter | ktlint, IntelliJ IDEA |
+| Package Manager | Gradle, Maven |
+| Documentation | Dokka |
+
+## 规则
+
+| 规则 | 说明 | 优先级 |
+|------|------|--------|
+| Kotlin DSL | 优先使用 build.gradle.kts 而非 Groovy | Recommended |
+| Package 结构 | 遵循反向域名命名（com.example.app） | Required |
+| 测试位置 | 在 test 目录中镜像 main 源代码结构 | Required |
+| 版本目录 | 使用 libs.versions.toml 管理依赖包 | Recommended |
+| Coroutines 测试 | 对 suspend 函数使用 kotlinx-coroutines-test | Recommended |
+
+## 相关选项
+
+- [Java](./java.md) - Java 项目结构
+- [.NET](./dotnet.md) - .NET 项目结构
+
+---
+
+## 参考资料
+
+- [Kotlin Documentation](https://kotlinlang.org/docs/home.html)
+- [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html)
+- [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html)
+
+---
+
+## 许可
+
+本文档以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 许可发布。
+
+**来源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)

package/bundled/locales/zh-CN/options/project-structure/php.md

@@ -0,0 +1,168 @@
+---
+source: options/project-structure/php.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# PHP 项目结构
+
+> **语言**: [English](../../../../options/project-structure/php.md) | 简体中文
+
+**上层标准**: [Project Structure](../../core/project-structure.md)
+
+---
+
+## 概览
+
+PHP 项目结构会因框架而异，但都遵循 PSR 标准来进行 autoload。`public/` 目录作为 web root，而应用代码则放在 `src/` 或框架特定的目录中。
+
+## 项目类型
+
+### 标准 PHP
+
+```
+project-root/
+├── src/
+│   ├── Controller/
+│   ├── Service/
+│   ├── Repository/
+│   ├── Entity/
+│   ├── Exception/
+│   └── Helper/
+├── config/
+│   └── config.php
+├── public/               # Web root
+│   ├── index.php
+│   ├── css/
+│   ├── js/
+│   └── images/
+├── resources/
+│   └── views/
+├── tests/
+│   ├── Unit/
+│   └── Feature/
+├── vendor/               # Dependencies (gitignored)
+├── storage/              # Logs, cache (gitignored)
+├── composer.json
+├── composer.lock
+└── phpunit.xml
+```
+
+### Laravel
+
+```
+project-root/
+├── app/
+│   ├── Http/
+│   │   ├── Controllers/
+│   │   └── Middleware/
+│   ├── Models/
+│   ├── Services/
+│   └── Providers/
+├── config/
+├── database/
+│   ├── migrations/
+│   ├── seeders/
+│   └── factories/
+├── public/
+├── resources/
+│   ├── views/
+│   ├── css/
+│   └── js/
+├── routes/
+├── storage/
+├── tests/
+├── composer.json
+└── artisan
+```
+
+### Symfony
+
+```
+project-root/
+├── bin/
+│   └── console
+├── config/
+│   ├── packages/
+│   ├── routes/
+│   └── services.yaml
+├── public/
+│   └── index.php
+├── src/
+│   ├── Controller/
+│   ├── Entity/
+│   ├── Repository/
+│   └── Service/
+├── templates/
+├── tests/
+├── var/                  # Cache, logs
+├── vendor/
+└── composer.json
+```
+
+## 配置文件
+
+| 文件 | 用途 | Required |
+|------|------|----------|
+| `composer.json` | 包 manifest | Yes |
+| `composer.lock` | 依赖包锁定文件 | Yes |
+| `phpunit.xml` | PHPUnit 配置 | No |
+| `.php-cs-fixer.php` | 代码风格配置 | No |
+| `phpstan.neon` | 静态分析配置 | No |
+
+## .gitignore
+
+```
+vendor/
+storage/
+var/
+.env
+.env.local
+*.cache
+*.log
+node_modules/
+```
+
+## 工具
+
+| 类别 | 工具 |
+|------|------|
+| Build | Composer |
+| 测试运行器 | PHPUnit, Pest, Codeception |
+| Linter | PHP_CodeSniffer, PHP-CS-Fixer |
+| 静态分析 | PHPStan, Psalm |
+| 包管理器 | Composer, Packagist |
+| 文档 | phpDocumentor |
+
+## 规则
+
+| 规则 | 说明 | 优先级 |
+|------|------|--------|
+| PSR-4 autoloading | 遵循 PSR-4 autoload 标准 | Required |
+| Public web root | 将 web root 仅指向 `public/` 目录 | Required |
+| 环境配置 | 使用 .env 文件存放环境特定的配置 | Recommended |
+| 测试映射 | 在 `tests/` 目录中映射 `src/` 结构 | Recommended |
+| 依赖注入 | 使用依赖注入容器（dependency injection container） | Recommended |
+
+## 相关选项
+
+- [Node.js](./nodejs.md) - Node.js 项目结构
+- [Ruby](./ruby.md) - Ruby 项目结构
+
+---
+
+## 参考资料
+
+- [PHP Standards Recommendations (PSR)](https://www.php-fig.org/psr/)
+- [Composer](https://getcomposer.org/)
+- [Laravel Documentation](https://laravel.com/docs)
+- [Symfony Documentation](https://symfony.com/doc/current/index.html)
+
+---
+
+## 许可
+
+本文档以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 许可发布。
+
+**来源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)

package/bundled/locales/zh-CN/options/project-structure/ruby.md

@@ -0,0 +1,156 @@
+---
+source: options/project-structure/ruby.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+# Ruby 项目结构
+
+> **语言**: [English](../../../../options/project-structure/ruby.md) | 简体中文
+
+**上层标准**: [Project Structure](../../core/project-structure.md)
+
+---
+
+## 概览
+
+Ruby 项目结构会因 gem、Rails 应用程序与其他框架而有所不同。它们全都使用 Bundler 进行依赖管理，并遵循代码组织的惯例。
+
+## 项目类型
+
+### Gem（库）
+
+```
+project-root/
+├── lib/
+│   ├── gem_name.rb       # Main entry point
+│   └── gem_name/
+│       ├── version.rb
+│       ├── client.rb
+│       └── errors.rb
+├── spec/                 # RSpec tests
+│   ├── spec_helper.rb
+│   └── gem_name/
+│       └── client_spec.rb
+├── bin/                  # Executables
+│   └── gem_name
+├── sig/                  # RBS type signatures
+├── Gemfile
+├── Gemfile.lock
+├── gem_name.gemspec
+├── Rakefile
+└── README.md
+```
+
+### Rails 应用程序
+
+```
+project-root/
+├── app/
+│   ├── controllers/
+│   ├── models/
+│   ├── views/
+│   ├── helpers/
+│   ├── mailers/
+│   ├── jobs/
+│   └── services/         # Custom addition
+├── config/
+│   ├── routes.rb
+│   ├── database.yml
+│   └── environments/
+├── db/
+│   ├── migrate/
+│   ├── schema.rb
+│   └── seeds.rb
+├── lib/
+│   └── tasks/
+├── public/
+├── spec/                 # or test/
+│   ├── models/
+│   ├── controllers/
+│   ├── requests/
+│   └── factories/
+├── Gemfile
+└── config.ru
+```
+
+### Sinatra 应用程序
+
+```
+project-root/
+├── app.rb                # Main application
+├── config.ru
+├── lib/
+│   └── helpers/
+├── views/
+├── public/
+├── spec/
+├── Gemfile
+└── Gemfile.lock
+```
+
+## 配置文件
+
+| 文件 | 用途 | Required |
+|------|---------|----------|
+| `Gemfile` | 依赖声明 | Yes |
+| `Gemfile.lock` | 依赖锁定文件 | Yes |
+| `*.gemspec` | Gem 规格说明 | Gems only |
+| `Rakefile` | Rake 任务 | No |
+| `.rubocop.yml` | RuboCop 配置 | No |
+| `.rspec` | RSpec 配置 | No |
+
+## .gitignore
+
+```
+.bundle/
+log/
+tmp/
+*.gem
+.env
+coverage/
+node_modules/
+.byebug_history
+```
+
+## 工具
+
+| 类别 | 工具 |
+|----------|-------|
+| Build | Rake, Bundler |
+| Test Runner | RSpec, Minitest |
+| Linter | RuboCop, Standard |
+| Formatter | RuboCop --auto-correct, Standard |
+| Package Manager | Bundler, RubyGems |
+| Documentation | YARD, RDoc |
+
+## 规则
+
+| 规则 | 说明 | 优先级 |
+|------|-------------|----------|
+| lib 结构 | 将主要代码放在 `lib/<gem_name>/` | Required |
+| spec 位置 | 在 `spec/` 目录中对映 `lib/` 结构 | Recommended |
+| Service 对象 | 在 `app/services/` 中使用 service 对象处理复杂操作 | Recommended |
+| FactoryBot | 搭配 `spec/factories/` 中的 factory 使用 FactoryBot | Recommended |
+| RuboCop 配置 | 为 RuboCop 配置项目专属规则 | Recommended |
+
+## 相关选项
+
+- [PHP](./php.md) - PHP 项目结构
+- [Python](./python.md) - Python 项目结构
+
+---
+
+## 参考资料
+
+- [Bundler](https://bundler.io/)
+- [Rails Guides](https://guides.rubyonrails.org/)
+- [RubyGems](https://rubygems.org/)
+
+---
+
+## 授权
+
+本文档以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 发布。
+
+**来源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)

package/bundled/locales/zh-CN/options/project-structure/rust.md

@@ -0,0 +1,136 @@
+---
+source: options/project-structure/rust.md
+source_version: 1.0.0
+translation_version: 1.0.0
+status: current
+---
+
+# Rust Project Structure
+
+> **语言**: [English](../../../../options/project-structure/rust.md) | 简体中文
+
+**上层标准**: [Project Structure](../../core/project-structure.md)
+
+---
+
+## 概览
+
+Rust 项目结构遵循 Cargo 惯例，将源代码、测试、基准测试（benchmark）与示例清楚区隔。module 系统可明确控制代码的组织与可见性。
+
+## 项目类型
+
+### Binary Project
+
+```
+project-root/
+├── src/
+│   ├── main.rs           # Entry point
+│   ├── lib.rs            # Library root (optional)
+│   ├── config.rs
+│   ├── error.rs
+│   └── modules/
+│       ├── mod.rs
+│       ├── handler.rs
+│       └── service.rs
+├── tests/                # Integration tests
+│   └── integration_test.rs
+├── benches/              # Benchmarks
+│   └── benchmark.rs
+├── examples/             # Example code
+│   └── example.rs
+├── Cargo.toml
+├── Cargo.lock
+└── README.md
+```
+
+### Library Project
+
+```
+project-root/
+├── src/
+│   ├── lib.rs            # Library entry point
+│   ├── error.rs
+│   └── modules/
+│       └── mod.rs
+├── tests/
+├── examples/
+├── Cargo.toml
+└── README.md
+```
+
+### Workspace（多 Crate）
+
+```
+project-root/
+├── crates/
+│   ├── core/
+│   │   ├── src/
+│   │   └── Cargo.toml
+│   ├── api/
+│   │   ├── src/
+│   │   └── Cargo.toml
+│   └── cli/
+│       ├── src/
+│       └── Cargo.toml
+├── Cargo.toml            # Workspace root
+└── Cargo.lock
+```
+
+## 配置文件
+
+| 文件 | 用途 | Required |
+|------|------|----------|
+| `Cargo.toml` | 包 manifest | Yes |
+| `Cargo.lock` | 依赖包锁定文件 | Yes (binaries), No (libraries) |
+| `rust-toolchain.toml` | Toolchain 版本 | No |
+| `.cargo/config.toml` | Cargo 配置 | No |
+
+## .gitignore
+
+```
+target/
+*.pdb
+.env
+Cargo.lock  # For libraries only
+```
+
+## 工具
+
+| 类别 | 工具 |
+|------|------|
+| Build | `cargo build`、`cargo build --release` |
+| Test Runner | `cargo test`、`cargo nextest` |
+| Linter | clippy |
+| Formatter | rustfmt、`cargo fmt` |
+| Package Manager | cargo、crates.io |
+| Documentation | `cargo doc`、rustdoc |
+
+## 规则
+
+| 规则 | 说明 | 优先级 |
+|------|------|--------|
+| Module 组织 | 一致地采用 mod.rs 或 module_name.rs 模式 | Required |
+| 测试位置 | 单元测试以 `#[cfg(test)]` 置于同文件，集成测试置于 `tests/` | Required |
+| 错误处理 | 在 error.rs 或 errors.rs 定义自定义错误类型 | Recommended |
+| 大型项目用 Workspace | 多 crate 项目采用 Cargo workspace | Recommended |
+| Doc 注释 | 公开项使用 `///`，module 层级文档使用 `//!` | Recommended |
+
+## 相关选项
+
+- [Go](./go.md) - Go 项目结构
+- [Node.js](./nodejs.md) - Node.js 项目结构
+
+---
+
+## 参考资料
+
+- [The Cargo Book](https://doc.rust-lang.org/cargo/)
+- [Rust Book - Packages and Crates](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html)
+
+---
+
+## 授权
+
+本文档以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 授权发布。
+
+**来源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)