Eruption.js Core 项目教程

1. 项目目录结构及介绍

Eruption.js Core 是一个基于 Vite 的 React/TypeScript 项目模板。以下是项目的目录结构及其介绍：

.
├── .github/              # GitHub 仓库配置文件
├── .husky/               # Husky 配置文件夹，用于 Git 钩子
├── .vscode/              # VSCode 配置文件
├── env/                  # 环境变量配置
├── public/               # 公共静态文件
├── src/                  # 源代码目录
│   ├── components/       # 组件目录
│   ├── hooks/            # 自定义钩子目录
│   ├── pages/            # 页面组件目录
│   ├── stores/           # 状态管理目录
│   ├── styles/           # 样式目录
│   ├── utils/            # 工具函数目录
│   ├── App.tsx           # 应用主组件
│   └── index.tsx         # 应用入口文件
├── .editorconfig          # 编辑器配置文件
├── .gitattributes         # Git 属性配置
├── .gitignore            # Git 忽略文件
├── .lintstagedrc         # Lint-staged 配置文件
├── .markdownlint.json    # Markdown Lint 配置文件
├── .npmrc                # npm 配置文件
├── .prettierignore       # Prettier 忽略文件
├── .prettierrc.js        # Prettier 配置文件
├── .stylelintignore      # Stylelint 忽略文件
├── .stylelintrc          # Stylelint 配置文件
├── CHANGELOG.md          # 更新日志
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文件
├── bun.lock              # Bun 包管理器锁文件
├── bunfig.toml           # Bun 配置文件
├── commitlint.config.ts  # Commit Lint 配置文件
├── eslint.config.js      # ESLint 配置文件
├── index.html            # HTML 入口文件
├── package.json          # 项目包配置文件
├── tsconfig.json         # TypeScript 配置文件
├── vite.config.ts        # Vite 配置文件
└── vitest.config.ts      # Vitest 配置文件

2. 项目的启动文件介绍

项目的启动文件为 index.tsx，它定义了应用的入口点。以下是 index.tsx 文件的基本内容：

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
  document.getElementById('root')
);

这个文件通过 ReactDOM 将 App 组件渲染到 HTML 文件的 root 元素中。

3. 项目的配置文件介绍

以下是项目中一些重要配置文件的介绍：

• tsconfig.json：TypeScript 配置文件，定义了项目的 TypeScript 编译选项。

• vite.config.ts：Vite 配置文件，用于配置 Vite 的行为，包括服务器设置、构建配置等。

• .editorconfig：编辑器配置文件，用于统一不同开发者的编辑器设置。

• .prettierrc.js：Prettier 配置文件，用于定义代码格式化规则。

• .eslintrc.js：ESLint 配置文件，用于定义代码质量规则。

• commitlint.config.ts：Commit Lint 配置文件，用于规范 Git 提交信息的格式。

这些配置文件确保了代码风格和项目结构的一致性，有助于维护项目质量和开发效率。