customize-cra 项目教程

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

customize-cra 项目的目录结构如下：

customize-cra/
├── src/
│   ├── index.js
│   ├── utils/
│   │   ├── addDecoratorsLegacy.js
│   │   ├── disableEsLint.js
│   │   └── ...
├── .gitignore
├── .npmignore
├── package.json
├── README.md
└── LICENSE

目录介绍

• src/: 包含项目的主要源代码文件。
  • index.js: 项目的入口文件。
  • utils/: 包含各种工具函数和配置覆盖函数。
    • addDecoratorsLegacy.js: 用于支持 MobX 装饰器。
    • disableEsLint.js: 用于禁用 ESLint。
    • ...
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• README.md: 项目的说明文档。
• LICENSE: 项目的开源许可证。

2、项目的启动文件介绍

项目的启动文件是 src/index.js，它是 customize-cra 的入口文件。该文件导入了各种工具函数，并提供了覆盖 webpack 和 devServer 配置的方法。

// src/index.js
const { override, overrideDevServer, watchAll } = require('./utils');

module.exports = {
  webpack: override(
    // 常用的 webpack 插件
    disableEsLint()
  ),
  devServer: overrideDevServer(
    // dev server 插件
    watchAll()
  )
};

启动文件介绍

• override: 用于覆盖 webpack 配置。
• overrideDevServer: 用于覆盖 devServer 配置。
• watchAll: 用于监听所有文件的变化。
• disableEsLint: 用于禁用 ESLint。

3、项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖、脚本和其他配置信息。

{
  "name": "customize-cra",
  "version": "1.0.0",
  "description": "Override webpack configurations for create-react-app 2.0",
  "main": "src/index.js",
  "scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react-app-rewired": "^2.1.8"
  },
  "devDependencies": {
    "customize-cra": "^1.0.0"
  },
  "license": "MIT"
}

配置文件介绍

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件。
• scripts: 包含项目的启动、构建、测试等脚本。
• dependencies: 项目的依赖包。
• devDependencies: 项目的开发依赖包。
• license: 项目的开源许可证。

通过以上介绍，您可以更好地理解和使用 customize-cra 项目。希望本教程对您有所帮助！