Flagship 项目教程

1. 项目的目录结构及介绍

Flagship 项目的目录结构如下：

flagship/
├── apps/
├── packages/
├── .eslintrc.js
├── .gitignore
├── .prettierrc.js
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
├── turbo.json
└── yarn.lock

目录结构介绍

• apps/: 包含项目的应用程序代码。
• packages/: 包含项目的包和库代码。
• .eslintrc.js: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。
• .prettierrc.js: Prettier 配置文件，用于代码格式化。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 贡献指南，指导开发者如何参与项目。
• LICENSE: 项目的开源许可证，Flagship 使用 MIT 许可证。
• README.md: 项目的介绍和使用说明。
• package.json: 项目的 npm 配置文件，包含依赖和脚本。
• tsconfig.json: TypeScript 配置文件，用于 TypeScript 编译设置。
• turbo.json: Turbo 配置文件，用于项目构建和任务管理。
• yarn.lock: Yarn 锁定文件，确保依赖版本一致性。

2. 项目的启动文件介绍

Flagship 项目的启动文件主要依赖于 package.json 中的脚本配置。以下是一些常见的启动脚本：

{
  "scripts": {
    "start": "react-native start",
    "android": "react-native run-android",
    "ios": "react-native run-ios",
    "test": "jest"
  }
}

启动文件介绍

• start: 启动 React Native 开发服务器。
• android: 启动 Android 应用程序。
• ios: 启动 iOS 应用程序。
• test: 运行测试脚本。

3. 项目的配置文件介绍

Flagship 项目中有多个配置文件，以下是一些关键配置文件的介绍：

.eslintrc.js

ESLint 配置文件，用于定义代码风格和规则：

module.exports = {
  extends: ['@brandingbrand/eslint-config-flagship'],
  rules: {
    // 自定义规则
  }
};

.prettierrc.js

Prettier 配置文件，用于代码格式化：

module.exports = {
  singleQuote: true,
  trailingComma: 'all',
  printWidth: 80
};

tsconfig.json

TypeScript 配置文件，用于 TypeScript 编译设置：

{
  "compilerOptions": {
    "target": "esnext",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  }
}

turbo.json

Turbo 配置文件，用于项目构建和任务管理：

{
  "pipeline": {
    "build": {
      "dependsOn": ["^build"]
    },
    "test": {
      "dependsOn": ["build"]
    }
  }
}

通过以上配置文件，Flagship 项目可以实现代码风格统一、自动化构建和测试等功能。