Reactist 项目教程

Reactist 项目教程

reactistOpen source React components made with ❤️ by Doist项目地址:https://gitcode.com/gh_mirrors/re/reactist

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

Reactist 项目的目录结构如下：

reactist/
├── .github/
├── docs/
├── examples/
├── scripts/
├── src/
│   ├── components/
│   ├── hooks/
│   ├── styles/
│   ├── utils/
│   ├── index.ts
│   └── ...
├── .gitignore
├── .npmignore
├── .prettierrc
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── ...

• .github/: GitHub 相关配置文件。
• docs/: 项目文档。
• examples/: 示例代码。
• scripts/: 脚本文件。
• src/: 源代码目录，包含组件、钩子、样式和工具函数等。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置。
• CHANGELOG.md: 变更日志。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2、项目的启动文件介绍

Reactist 项目的启动文件主要是 src/index.ts，它负责导出项目中的所有组件和钩子，以便在其他项目中使用。

// src/index.ts
export * from './components';
export * from './hooks';
export * from './styles';
export * from './utils';

3、项目的配置文件介绍

Reactist 项目的主要配置文件包括：

• package.json: 包含项目的依赖、脚本命令和其他元数据。

{
  "name": "@doist/reactist",
  "version": "1.0.0",
  "description": "Open source React components made with ❤️ by Doist",
  "main": "dist/index.js",
  "scripts": {
    "build": "npm run build",
    "test": "npm run test",
    "start": "npm run start"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  },
  "devDependencies": {
    "@types/react": "^17.0.2",
    "@types/react-dom": "^17.0.2",
    "typescript": "^4.1.3"
  }
}

• tsconfig.json: TypeScript 编译配置文件。

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

• .prettierrc: Prettier 代码格式化配置文件。

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80
}

这些配置文件确保了项目的正确编译、测试和代码格式化。

reactistOpen source React components made with ❤️ by Doist项目地址:https://gitcode.com/gh_mirrors/re/reactist