Construct-UI 项目教程

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

construct-ui/
├── docs/
│   ├── ...
│   └── ...
├── scripts/
│   ├── ...
│   └── ...
├── src/
│   ├── components/
│   │   ├── ...
│   │   └── ...
│   ├── styles/
│   │   ├── ...
│   │   └── ...
│   ├── index.ts
│   └── ...
├── test/
│   ├── ...
│   └── ...
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .npmignore
├── LICENSE
├── changelog.md
├── package-lock.json
├── package.json
├── readme.md
├── tsconfig.cjs.json
├── tsconfig.esm.json
├── tsconfig.json
└── vite.config.ts

目录结构介绍

• docs/: 存放项目的文档文件。
• scripts/: 存放项目的脚本文件，如生成图标、文档等。
• src/: 项目的源代码目录，包含组件、样式等。
  • components/: 存放UI组件的源代码。
  • styles/: 存放项目的样式文件。
  • index.ts: 项目的入口文件。
• test/: 存放项目的测试文件。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint忽略文件。
• .eslintrc.js: ESLint配置文件。
• .gitignore: Git忽略文件。
• .npmignore: npm发布时忽略的文件。
• LICENSE: 项目的开源许可证。
• changelog.md: 项目的更新日志。
• package-lock.json: npm包锁定文件。
• package.json: 项目的npm配置文件。
• readme.md: 项目的README文件。
• tsconfig.cjs.json: TypeScript CommonJS配置文件。
• tsconfig.esm.json: TypeScript ESM配置文件。
• tsconfig.json: TypeScript配置文件。
• vite.config.ts: Vite配置文件。

2. 项目的启动文件介绍

入口文件

项目的入口文件是 src/index.ts。这个文件通常是项目的启动点，负责初始化应用并加载必要的组件和配置。

启动流程

1. 加载配置: 项目启动时会加载 vite.config.ts 中的配置。
2. 初始化应用: 通过 src/index.ts 初始化应用，加载UI组件和样式。
3. 运行应用: 应用启动后，会根据配置文件和入口文件的逻辑进行运行。

3. 项目的配置文件介绍

vite.config.ts

vite.config.ts 是项目的Vite配置文件，用于配置项目的构建和开发环境。

import { defineConfig } from 'vite';

export default defineConfig({
  // 配置项
});

tsconfig.json

tsconfig.json 是TypeScript的配置文件，用于配置TypeScript编译器的行为。

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

package.json

package.json 是项目的npm配置文件，包含项目的依赖、脚本等信息。

{
  "name": "construct-ui",
  "version": "0.3.4",
  "scripts": {
    "generate:icons": "...",
    "generate:docs": "...",
    "watch:docs": "..."
  },
  "dependencies": {
    "mithril": "^2.0.4"
  },
  "devDependencies": {
    "typescript": "^4.0.0"
  }
}

.eslintrc.js

.eslintrc.js 是ESLint的配置文件，用于配置代码风格检查。

module.exports = {
  extends: 'eslint:recommended',
  rules: {
    // 自定义规则
  }
};

通过以上配置文件，可以确保项目在开发和构建过程中遵循一致的规范和流程。