Oxygen Not Included 存档编辑器(oni-duplicity)使用教程
1. 项目的目录结构及介绍
oni-duplicity/
├── assets/
├── dist/
├── docs/
├── scripts/
├── src/
│ ├── components/
│ ├── models/
│ ├── services/
│ ├── utils/
│ └── index.ts
├── tests/
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json
- assets/: 存放项目所需的静态资源文件。
- dist/: 编译后的输出目录。
- docs/: 项目文档。
- scripts/: 项目脚本文件。
- src/: 源代码目录。
- components/: 存放React组件。
- models/: 存放数据模型。
- services/: 存放服务层代码。
- utils/: 存放工具函数。
- index.ts: 项目入口文件。
- tests/: 测试文件目录。
- .gitignore: Git忽略文件配置。
- package.json: 项目依赖和脚本配置。
- README.md: 项目说明文档。
- tsconfig.json: TypeScript配置文件。
2. 项目的启动文件介绍
项目的启动文件是 src/index.ts
。这个文件负责初始化应用并启动服务。以下是 index.ts
的主要内容:
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(
<React.StrictMode>
<App />
</React.StrictMode>,
document.getElementById('root')
);
- ReactDOM.render: 将React应用渲染到指定的DOM节点上。
- App: 主应用组件。
3. 项目的配置文件介绍
package.json
package.json
文件包含了项目的基本信息和依赖配置。以下是一些关键字段:
{
"name": "oni-duplicity",
"version": "1.0.0",
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"dependencies": {
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-scripts": "4.0.3"
},
"devDependencies": {
"@types/react": "^17.0.3",
"@types/react-dom": "^17.0.3",
"typescript": "^4.2.3"
}
}
- scripts: 定义了项目的启动、构建、测试等脚本。
- dependencies: 生产环境依赖。
- devDependencies: 开发环境依赖。
tsconfig.json
tsconfig.json
文件是TypeScript的配置文件,定义了编译选项和编译目标。以下是一些关键配置:
{
"compilerOptions": {
"target": "es5",
"lib": ["dom", "es2015"],
"module": "commonjs",
"jsx": "react",
"outDir": "./dist",
"strict": true,
"esModuleInterop": true
},
"include": ["src"]
}
- compilerOptions: 编译选项。
- target: 编译目标。
- lib: 编译时包含的库。
- module: 模块系统。
- jsx: JSX处理方式。
- outDir: 输出目录。
- strict: 严格模式。
- esModuleInterop: 支持ES模块互操作。
- include: 包含的文件或目录。