TangoBoot 开源项目教程

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

TangoBoot 项目的目录结构如下：

tango-boot/
├── examples/
│   └── basic-example/
├── packages/
├── .eslintrc
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── babel.config.js
├── jest.config.js
├── lerna.json
├── package.json
├── tsconfig.json
├── tsconfig.prod.json
└── yarn.lock

目录结构介绍

• examples/: 包含基本示例的目录。
• packages/: 包含项目的主要包和模块。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• babel.config.js: Babel 配置文件。
• jest.config.js: Jest 测试配置文件。
• lerna.json: Lerna 多包管理配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• tsconfig.prod.json: 生产环境 TypeScript 配置文件。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于 index.js，其基本实现如下：

import { runApp } from '@music163/tango-boot';
import routes from './routes';
import services from './services';
import home from './stores/home';
import counter from './stores/counter';
import './global.less'; // 全局样式

runApp({
  routes,
  services,
  stores: {
    home,
    counter,
  },
});

启动文件介绍

• runApp: 创建应用入口的函数。
• routes: 应用的路由配置。
• services: 应用的服务配置。
• stores: 应用的状态管理配置。
• global.less: 全局样式文件。

3. 项目的配置文件介绍

babel.config.js

Babel 配置文件，用于转译 JavaScript 代码。

module.exports = {
  presets: [
    '@babel/preset-env',
    '@babel/preset-react',
    '@babel/preset-typescript',
  ],
  plugins: [
    '@babel/plugin-proposal-class-properties',
    '@babel/plugin-proposal-object-rest-spread',
  ],
};

jest.config.js

Jest 测试配置文件，用于配置测试环境。

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'jsdom',
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
  transform: {
    '^.+\\.(ts|tsx)$': 'ts-jest',
  },
  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(ts?|tsx?)$',
};

tsconfig.json

TypeScript 配置文件，用于配置 TypeScript 编译选项。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "lib": ["dom", "es2015"],
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"]
}

tsconfig.prod.json

生产环境 TypeScript 配置文件，用于配置生产环境编译选项。

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "sourceMap": false,
    "removeComments": true
  }
}

package.json

项目依赖和脚本配置文件，