深度解析 create-react-app 源码

我在今年1月23日于 segmentfault上发布了此文。今天突发奇想在Google上搜了一波关于create-react-app源码的文章,发现掘金多篇类似文章...我真的想贴图,改了两个字就算原创(虽然好像风气就是这样),那就这样吧,我还能说些什么!

本文原文移至新博客地址,转载注明作者出处谢谢!!!如果你觉得改了一两个字就算是你的了,就TM当我没说。

前言

这段时间公司的事情变得比较少,空下了很多时间,作为一个刚刚毕业初入职场的菜鸟级程序员,一点都不敢放松,秉持着我为人人的思想也想为开源社区做点小小的贡献,但是一直又没有什么明确的目标,最近在努力的准备吃透react,加上react的脚手架工具create-react-app已经很成熟了,初始化一个react项目根本看不到它到底是怎么给我搭建的这个开发环境,又是怎么做到的,我还是想知道知道,所以就把他拖出来溜溜。

文中若有错误或者需要指正的地方,多多指教,共同进步。

使用说明

就像我开头说的那样,学习一个新的东西,应该是先知道如何用,然后在来看他是怎么实现的。create-react-app到底是个什么东西,总结一句话来说,就是官方提供的快速搭建一个新的react项目的脚手架工具,类似于vuevue-cliangularangular-cli,至于为什么不叫react-cli是一个值得深思的问题...哈哈哈,有趣!

不说废话了,贴个图,直接看create-react-app的命令帮助。

create-react-app

概略说明

毕竟它已经是一个很成熟的工具了,说明也很完善,重点对其中--scripts-version说一下,其他比较简单,大概说一下,注意有一行Only <project-directory> is required,直译一下,仅仅只有项目名称是必须的,也就是说你在用create-react-app命令的时候,必须在其后跟上你的项目名称,其实这里说的不准确,像--version --info --help这三个选项是不需要带项目名称的,具体看下面:

  • create-react-app -V(or --version):这个选项可以单独使用,打印版本信息,每个工具基本都有吧?
  • create-react-app --info:这个选项也可以单独使用,打印当前系统跟react相关的开发环境参数,也就是操作系统是什么啊,Node版本啊之类的,可以自己试一试。
  • create-react-app -h(or --help):这个肯定是可以单独使用的,不然怎么打印帮助信息,不然就没有上面的截图了。

也就是说除了上述三个参数选项是可以脱离必须参数项目名称以外来单独使用的,因为它们都跟你要初始化的react项目无关,然后剩下的参数就是对要初始化的react项目进行配置的,也就是说三个参数是可以同时出现的,来看一下它们分别的作用:

  • create-react-app <my-project> --verbose:看上图,打印本地日志,其实他是npmyarn安装外部依赖包可以加的选项,可以打印安装有错时的信息。
  • create-react-app <my-project> --scripts-version:由于它本身把创建目录初始化步骤和控制命令分离了,用来控制react项目的开发、打包和测试都放在了react-scripts里面,所以这里可以单独来配置控制的选项,可能这样你还不是很明白,我下面具体说。
  • create-react-app <my-project> --use-npm:这个选项看意思就知道了,create-react-app默认使用yarn来安装,运行,如果你没有使用yarn,你可能就需要这个配置了,指定使用npm

定制选项

关于--scripts-version我还要多说一点,其实在上述截图中我们已经可以看到,create-react-app本身已经对其中选项进行了说明,一共有四种情况,我并没有一一去试他,因为还挺麻烦的,以后如果用到了再来补,我先来大概推测一下他们的意思:

  • 指定版本为0.8.2
  • npm发布自己的react-scripts
  • 在自己的网站上设置一个.tgz的下载包
  • 在自己的网站上设置一个.tar.gz的下载包

从上述看的出来create-react-app对于开发者还是很友好的,可以自己去定义很多东西,如果你不想这么去折腾,它也提供了标准的react-scripts供开发者使用,我一直也很好奇这个,之后我在来单独说官方标准的react配置是怎么做的。

目录分析

随着它版本的迭代,源码肯定是会发生变化的,我这里下载的是v1.1.0,大家可以自行在github上下载这个版本,找不到的戳链接

主要说明

我们来看一下它的目录结构

├── .github
├── packages
├── tasks
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .travis.yml
├── .yarnrc
├── appveyor.cleanup-cache.txt
├── appveyor.yml
├── CHANGELOG-0.x.md
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── lerna.json
├── LICENSE
├── package.json
├── README.md
└── screencast.svg

咋一看好多啊,我的天啊,到底要怎么看,其实仔细一晃,好像很多一眼就能看出来是什么意思,大概说一下每个文件都是干嘛的,具体的我也不知道啊,往下看,一步一步来。

  • .github:这里面放着当你在这个项目提issuepr时候的规范
  • packages:字面意思就是包们.....暂时不管,后面详说 ----> 重点
  • tasks:字面意思就是任务们.....暂时不管,后面详说 ----> 重点
  • .eslintignore: eslint检查时忽略文件
  • .eslintrceslint检查配置文件
  • .gitignoregit提交时忽略文件
  • .travis.ymltravis配置文件
  • .yarnrcyarn配置文件
  • appveyor.cleanup-cache.txt:里面有一行Edit this file to trigger a cache rebuild编辑此文件触发缓存,具体干嘛的,暂时不议
  • appveyor.ymlappveyor配置文件
  • CHANGELOG-0.x.md:版本0.X开头的变更说明文件
  • CHANGELOG.md:当前版本变更说明文件
  • CODE_OF_CONDUCT.mdfacebook代码行为准则说明
  • CONTRIBUTING.md:项目的核心说明
  • lerna.jsonlerna配置文件
  • LICENSE:开源协议
  • package.json:项目配置文件
  • README.md:项目使用说明
  • screencast.svg:图片...

看了这么多文件,是不是打退堂鼓了?哈哈哈哈,好了好了,进入正题,其实上述对于我们阅读源码有用的只有packagestaskspackage.json三个文件而已,而且本篇能用到的也就packagespackage.json,是不是想打我.....我也只是想告诉大家这些文件有什么用,它们都是有各自的作用的,如果还不了解,参考下面的参考链接。

参考链接

eslint相关的:eslint官网 travis相关的:travis官网 travis入门 yarn相关的:yarn官网 appveyor相关的:appveyor官网 lerna相关的:lerna官网

工具自行了解,本文只说源码相关的packagespackage.json

寻找入口

现在的前端项目大多数都有很多别的依赖,不在像以前那些原生javascript的工具库,拿到源码文件,就可以开始看了,像jQueryunderscore等等,一个两个文件包含了它所有的内容,虽然也有很框架会有umd规范的文件可以直接阅读,像better-scroll等等,但是其实他在书写源码的时候还是拆分成了很多块,最后在用打包工具整合在一起了。但是像create-react-app这样的脚手架工具好像不能像之前那种方法来看了,必须找到整个程序的入口,在逐步突破,所以最开始的工具肯定是寻找入口。

开始关注

拿到一个项目我们应该从哪个文件开始看起呢?只要是基于npm管理的,我都推荐从package.json文件开始看,人家是项目的介绍文件,你不看它看啥。

它里面理论上应该是有名称、版本等等一些说明性信息,但是都没用,看几个重要的配置。

"workspaces": [
    "packages/*"
],

关于workspaces一开始我在npm的说明文档里面没找到,虽然从字面意思我们也能猜到它的意思是实际工作的目录是packages,后来我查了一下是yarn里面的东东,具体看这篇文章,用于在本地测试,具体不关注,只是从这里我们知道了真正的起作用的文件都在packages里面。

重点关注

从上述我们知道现在真正需要关注的内容都在packages里面,我们来看看它里面都是有什么东东:

├── babel-preset-react-app    --> 暂不关注
├── create-react-app
├── eslint-config-react-app   --> 暂不关注
├── react-dev-utils           --> 暂不关注
├── react-error-overlay       --> 暂不关注
└── react-scripts             --> 核心啊,还是暂不关注

里面有六个文件夹,哇塞,又是6个单独的项目,这要看到何年何月.....是不是有这种感触,放宽心大胆的看,先想一下我们在安装了create-react-app后在,在命令行输入的是create-react-app的命令,所以我们大胆的推测关于这个命令应该都是存在了create-react-app下,在这个目录下同样有package.json文件,现在我们把这6个文件拆分成6个项目来分析,上面也说了,看一个项目首先看package.json文件,找到其中的重点:

"bin": {
    "create-react-app": "./index.js"
}

找到重点了,package.json文件中的bin就是在命令行中可以运行的命令,也就是说我们在执行create-react-app命令的时候,就是执行create-react-app目录下的index.js文件。

多说两句

关于package.json中的bin选项,其实是基于node环境运行之后的内容。举个简单的例子,在我们安装create-react-app后,执行create-react-app等价于执行node index.js

create-react-app目录解析

经过以上一系列的查找,我们终于艰难的找到了create-react-app命令的中心入口,其他的都先不管,我们打开packages/create-react-app目录,仔细一瞅,噢哟,只有四个文件,四个文件我们还搞不定吗?除了package.jsonREADME.md就只剩两个能看的文件了,我们来看看这两个文件。

index.js

既然之前已经看到packages/create-react-app/package.json中关于bin的设置,就是执行index.js文件,我们就从index.js入手,开始瞅瞅源码到底都有些虾米。

除了一大串的注释以外,代码其实很少,全贴上来了:

var chalk = require('chalk');

var currentNodeVersion = process.versions.node; // 返回Node版本信息,如果有多个版本返回多个版本
var semver = currentNodeVersion.split('.'); // 所有Node版本的集合
var major = semver[0]; // 取出第一个Node版本信息

// 如果当前版本小于4就打印以下信息并终止进程
if (major < 4) {
  console.error(
    chalk.red(
      'You are running Node ' +
        currentNodeVersion +
        '.\n' +
        'Create React App requires Node 4 or higher. \n' +
        'Please update your version of Node.'
    )
  );
  process.exit(1); // 终止进程
}

// 没有小于4就引入以下文件继续执行
require('./createReactApp');

咋一眼看过去其实你就知道它大概是什么意思了....检查Node.js的版本,小于4就不执行了,我们分开来看一下,这里他用了一个库chalk,理解起来并不复杂,一行一行的解析。

  • chalk:这个对这段代码的实际影响就是在命令行中,将输出的信息变色。也就引出了这个库的作用改变命令行中输出信息的样式。npm地址

其中有几个Node自身的API

  • process.versions 返回一个对象,包含Node以及它的依赖信息
  • process.exit 结束Node进程,1是状态码,表示有异常没有处理

在我们经过index.js后,就来到了createReactApp.js,下面再继续看。

createReactApp.js

当我们本机上的Node版本大于4的时候就要继续执行这个文件了,打开这个文件,代码还不少,大概700多行吧,我们慢慢拆解。

这里放个小技巧,在读源码的时候,可以在开一个写代码的窗口,跟着写一遍,执行过的代码可以在源文件中先删除,这样700行代码,当你读了200行的时候,源文件就只剩500行了,不仅有成就感继续阅读,也把不执行的逻辑先删除了,影响不到你读其他地方。

const validateProjectName = require('validate-npm-package-name');
const chalk = require('chalk');
const commander = require('commander');
const fs = require('fs-extra');
const path = require('path');
const execSync = require('child_process').execSync;
const spawn = require('cross-spawn');
const semver = require('semver');
const dns = require('dns');
const tmp = require('tmp');
const unpack = require('tar-pack').unpack;
const url = require('url');
const hyperquest = require('hyperquest');
const envinfo = require('envinfo');

const packageJson = require('./package.json');

打开代码一排依赖,懵逼....我不可能挨着去查一个个依赖是用来干嘛的吧?所以,我的建议就是先不管,用到的时候在回来看它是干嘛的,理解更加透彻一些,继续往下看。

let projectName; // 定义了一个用来存储项目名称的变量

const program = new commander.Command(packageJson.name)
  .version(packageJson.version) // 输入版本信息,使用`create-react-app -v`的时候就用打印版本信息
  .arguments('<project-directory>') // 使用`create-react-app <my-project>` 尖括号中的参数
  .usage(`${chalk.green('<project-directory>')} [options]`) //  使用`create-react-app`第一行打印的信息,也就是使用说明
  .action(name => {
    projectName = name; // 此处action函数的参数就是之前argument中的<project-directory> 初始化项目名称 --> 此处影响后面
  })
  .option('--verbose', 'print additional logs') // option配置`create-react-app -[option]`的选项,类似 --help -V
  .option('--info', 'print environment debug info') // 打印本地相关开发环境,操作系统,`Node`版本等等
  .option(
    '--scripts-version <alternative-package>',
    'use a non-standard version of react-scripts'
  ) // 这我之前就说过了,指定特殊的`react-scripts`
  .option('--use-npm') // 默认使用`yarn`,指定使用`npm`
  .allowUnknownOption() // 这个我没有在文档上查到,直译就是允许无效的option 大概意思就是我可以这样`create-react-app <my-project> -la` 其实 -la 并没有定义,但是我还是可以这么做而不会保存
  .on('--help', () => {
    // 此处省略了一些打印信息
  }) // on('--help') 用来定制打印帮助信息 当使用`create-react-app -h(or --help)`的时候就会执行其中的代码,基本都是些打印信息
  .parse(process.argv); // 这个就是解析我们正常的`Node`进程,可以这么理解没有这个东东,`commander`就不能接管`Node`

在上面的代码中,我把无关紧要打印信息省略了,这段代码算是这个文件的关键入口地此处他new了一个commander,这是个啥东东呢?这时我们就返回去看它的依赖,找到它是一个外部依赖,这时候怎么办呢?不可能打开node_modules去里面找撒,很简单,打开npm官网查一下这个外部依赖。

  • commander:概述一下,Node命令接口,也就是可以用它代管Node命令。npm地址

上述只是commander用法的一种实现,没有什么具体好说的,了解了commander就不难,这里的定义也就是我们在命令行中看到的那些东西,比如参数,比如打印信息等等,我们继续往下来。

// 判断在命令行中执行`create-react-app <name>` 有没有name,如果没有就继续
if (typeof projectName === 'undefined') {
  // 当没有传name的时候,如果带了 --info 的选项继续执行下列代码,这里配置了--info时不会报错
  if (program.info) {
    // 打印当前环境信息和`react`、`react-dom`, `react-scripts`三个包的信息
    envinfo.print({
      packages: ['react', 'react-dom', 'react-scripts'],
      noNativeIDE: true,
      duplicates: true,
    });
    process.exit(0); // 正常退出进程
  }
  // 在没有带项目名称又没带 --info 选项的时候就会打印一堆错误信息,像--version 和 --help 是commander自带的选项,所以不用单独配置
  console.error('Please specify the project directory:');
  console.log(
    `  ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}`
  );
  console.log();
  console.log('For example:');
  console.log(`  ${chalk.cyan(program.name())} ${chalk.green('my-react-app')}`);
  console.log();
  console.log(
    `Run ${chalk.cyan(`${program.name()} --help`)} to see all options.`
  );
  process.exit(1); // 抛出异常退出进程
}

还记得上面把create-react-app <my-project>中的项目名称赋予了projectName变量吗?此处的作用就是看看用户有没有传这个<my-project>参数,如果没有就会报错,并显示一些帮助信息,这里用到了另外一个外部依赖envinfo

  • envinfo:可以打印当前操作系统的环境和指定包的信息。 npm地址

到这里我还要吐槽一下segmentfault的编辑器...我同时打开视图和编辑好卡...捂脸.png!

这里我之前省略了一个东西,还是拿出来说一下:

const hiddenProgram = new commander.Command()
  .option(
    '--internal-testing-template <path-to-template>',
    '(internal usage only, DO NOT RELY ON THIS) ' +
      'use a non-standard application template'
  )
  .parse(process.argv);

create-react-app在初始化一个项目的时候,会生成一个标准的文件夹,这里有一个隐藏的选项--internal-testing-template,用来更改初始化目录的模板,这里他已经说了,供内部使用,应该是开发者们开发时候用的,所以不建议大家使用这个选项。

我们继续往下看,有几个提前定义的函数,我们不管,直接找到第一个被执行的函数:

createApp(
  projectName,
  program.verbose,
  program.scriptsVersion,
  program.useNpm,
  hiddenProgram.internalTestingTemplate
);

一个createAPP函数,接收了5个参数

  • projectName: 执行create-react-app <name> name的值,也就是初始化项目的名称
  • program.verbose:这里在说一下commanderoption选项,如果加了这个选项这个值就是true,否则就是false,也就是说这里如果加了--verbose,那这个参数就是true,至于verbose是什么,我之前也说过了,在yarn或者npm安装的时候打印本地信息,也就是如果安装过程中出错,我们可以找到额外的信息。
  • program.scriptsVersion:与上述同理,指定react-scripts版本
  • program.useNpm:以上述同理,指定是否使用npm,默认使用yarn
  • hiddenProgram.internalTestingTemplate:这个东东,我之前给他省略了,我在前面已经补充了,指定初始化的模板,人家说了内部使用,大家可以忽略了,应该是用于开发测试模板目录的时候使用。

找到了第一个执行的函数createApp,我们就来看看createApp函数到底做了什么?

createApp()

function createApp(name, verbose, version, useNpm, template) {
  const root = path.resolve(name); // 获取当前进程运行的位置,也就是文件目录的绝对路径
  const appName = path.basename(root); // 返回root路径下最后一部分

  checkAppName(appName); // 执行 checkAppName 函数 检查文件名是否合法
  fs.ensureDirSync(name); // 此处 ensureDirSync 方法是外部依赖包 fs-extra 而不是 node本身的fs模块,作用是确保当前目录下有指定文件名,没有就创建
  // isSafeToCreateProjectIn 函数 判断文件夹是否安全
  if (!isSafeToCreateProjectIn(root, name)) {
    process.exit(1); // 不合法结束进程
  }
  // 到这里打印成功创建了一个`react`项目在指定目录下
  console.log(`Creating a new React app in ${chalk.green(root)}.`);
  console.log();
  // 定义package.json基础内容
  const packageJson = {
    name: appName,
    version: '0.1.0',
    private: true,
  };
  // 往我们创建的文件夹中写入package.json文件
  fs.writeFileSync(
    path.join(root, 'package.json'),
    JSON.stringify(packageJson, null, 2)
  );
  // 定义常量 useYarn 如果传参有 --use-npm useYarn就是false,否则执行 shouldUseYarn() 检查yarn是否存在
  // 这一步就是之前说的他默认使用`yarn`,但是可以指定使用`npm`,如果指定使用了`npm`,`useYarn`就是`false`,不然执行 shouldUseYarn 函数
  // shouldUseYarn 用于检测本机是否安装了`yarn`
  const useYarn = useNpm ? false : shouldUseYarn();
  // 取得当前node进程的目录,之前还懂为什么要单独取一次,之后也明白了,下一句代码将会改变这个值,所以如果我后面要用这个值,后续其实取得值将不是这个
  // 所以这里的目的就是提前存好,免得我后续使用的时候不好去找,这个地方就是我执行初始化项目的目录,而不是初始化好的目录,是初始化的上级目录,有点绕..
  const originalDirectory = process.cwd();
  // 修改进程目录为底下子进程目录
  // 在这里就把进程目录修改为了我们创建的目录
  process.chdir(root);
  // 如果不使用yarn 并且checkThatNpmCanReadCwd()函数 这里之前说的不是很对,在重新说一次
  // checkThatNpmCanReadCwd 这个函数的作用是检查进程目录是否是我们创建的目录,也就是说如果进程不在我们创建的目录里面,后续再执行`npm`安装的时候就会出错,所以提前检查
  if (!useYarn && !checkThatNpmCanReadCwd()) {
    process.exit(1);
  }
  // 比较 node 版本,小于6的时候发出警告
  // 之前少说了一点,小于6的时候指定`react-scripts`标准版本为0.9.x,也就是标准的`react-scripts@1.0.0`以上的版本不支持`node`在6版本之下
  if (!semver.satisfies(process.version, '>=6.0.0')) {
    console.log(
      chalk.yellow(
        `You are using Node ${process.version} so the project will be bootstrapped with an old unsupported version of tools.\n\n` +
          `Please update to Node 6 or higher for a better, fully supported experience.\n`
      )
    );
    // Fall back to latest supported react-scripts on Node 4
    version = 'react-scripts@0.9.x';
  }
  // 如果没有使用yarn 也发出警告
  // 这里之前也没有说全,还判断了`npm`的版本是不是在3以上,如果没有依然指定安装`react-scripts@0.9.x`版本
  if (!useYarn) {
    const npmInfo = checkNpmVersion();
    if (!npmInfo.hasMinNpm) {
      if (npmInfo.npmVersion) {
        console.log(
          chalk.yellow(
            `You are using npm ${npmInfo.npmVersion} so the project will be boostrapped with an old unsupported version of tools.\n\n` +
              `Please update to npm 3 or higher for a better, fully supported experience.\n`
          )
        );
      }
      // Fall back to latest supported react-scripts for npm 3
      version = 'react-scripts@0.9.x';
    }
  }
  // 传入这些参数执行run函数
  // 执行完毕上述代码以后,将执行`run`函数,但是我还是先把上述用到的函数全部说完,在来下一个核心函数`run`
  run(root, appName, version, verbose, originalDirectory, template, useYarn);
}

我这里先来总结一下这个函数都做了哪些事情,再来看看他用到的依赖有哪些,先说做了哪些事情,在我们的目录下创建了一个项目目录,并且校验了这个目录的名称是否合法,这个目录是否安全,然后往其中写入了一个package.json的文件,并且判断了当前环境下应该使用的react-scripts的版本,然后执行了run函数。我们在来看看这个函数用了哪些外部依赖:

  • fs-extra:外部依赖,Node自带文件模块的外部扩展模块 npm地址
  • semver:外部依赖,用于比较Node版本 npm地址

之后函数的函数依赖我都会进行详细的解析,除了少部分特别简单的函数,然后我们来看看这个函数的函数依赖:

  • checkAppName():用于检测文件名是否合法,
  • isSafeToCreateProjectIn():用于检测文件夹是否安全
  • shouldUseYarn():用于检测yarn在本机是否已经安装
  • checkThatNpmCanReadCwd():用于检测npm是否在正确的目录下执行
  • checkNpmVersion():用于检测npm在本机是否已经安装了

checkAppName()

function checkAppName(appName) {
  // 使用 validateProjectName 检查包名是否合法返回结果,这个validateProjectName是外部依赖的引用,见下面说明
  const validationResult = validateProjectName(appName); 
  // 如果对象中有错继续,这里就是外部依赖的具体用法
  if (!validationResult.validForNewPackages) {
    console.error(
      `Could not create a project called ${chalk.red(
        `"${appName}"`
      )} because of npm naming restrictions:`
    );
    printValidationResults(validationResult.errors);
    printValidationResults(validationResult.warnings);
    process.exit(1);
  }
  
  // 定义了三个开发依赖的名称
  const dependencies = ['react', 'react-dom', 'react-scripts'].sort();
  // 如果项目使用了这三个名称都会报错,而且退出进程
  if (dependencies.indexOf(appName) >= 0) {
    console.error(
      chalk.red(
        `We cannot create a project called ${chalk.green(
          appName
        )} because a dependency with the same name exists.\n` +
          `Due to the way npm works, the following names are not allowed:\n\n`
      ) +
        chalk.cyan(dependencies.map(depName => `  ${depName}`).join('\n')) +
        chalk.red('\n\nPlease choose a different project name.')
    );
    process.exit(1);
  }
}

它这个函数其实还蛮简单的,用了一个外部依赖来校验文件名是否符合npm包文件名的规范,然后定义了三个不能取得名字reactreact-domreact-scripts,外部依赖:

  • validate-npm-package-name:外部依赖,检查包名是否合法。npm地址

其中的函数依赖:

  • printValidationResults():函数引用,这个函数就是我说的特别简单的类型,里面就是把接收到的错误信息循环打印出来,没什么好说的。

isSafeToCreateProjectIn()

function isSafeToCreateProjectIn(root, name) {
  // 定义了一堆文件名
  // 我今天早上仔细的看了一些,以下文件的来历就是我们这些开发者在`create-react-app`中提的一些文件
  const validFiles = [
    '.DS_Store',
    'Thumbs.db',
    '.git',
    '.gitignore',
    '.idea',
    'README.md',
    'LICENSE',
    'web.iml',
    '.hg',
    '.hgignore',
    '.hgcheck',
    '.npmignore',
    'mkdocs.yml',
    'docs',
    '.travis.yml',
    '.gitlab-ci.yml',
    '.gitattributes',
  ];
  console.log();

  // 这里就是在我们创建好的项目文件夹下,除了上述文件以外不包含其他文件就会返回true
  const conflicts = fs
    .readdirSync(root)
    .filter(file => !validFiles.includes(file));
  if (conflicts.length < 1) {
    return true;
  }
  // 否则这个文件夹就是不安全的,并且挨着打印存在哪些不安全的文件
  console.log(
    `The directory ${chalk.green(name)} contains files that could conflict:`
  );
  console.log();
  for (const file of conflicts) {
    console.log(`  ${file}`);
  }
  console.log();
  console.log(
    'Either try using a new directory name, or remove the files listed above.'
  );
  // 并且返回false
  return false;
}

他这个函数也算比较简单,就是判断创建的这个目录是否包含除了上述validFiles里面的文件,至于这里面的文件是怎么来的,就是create-react-app在发展至今,开发者们提出来的。

shouldUseYarn()

function shouldUseYarn() {
  try {
    execSync('yarnpkg --version', { stdio: 'ignore' });
    return true;
  } catch (e) {
    return false;
  }
}

就三行...其中execSync是由node自身模块child_process引用而来,就是用来执行命令的,这个函数就是执行一下yarnpkg --version来判断我们是否正确安装了yarn,如果没有正确安装yarn的话,useYarn依然为false,不管指没有指定--use-npm

  • execSync:引用自child_process.execSync,用于执行需要执行的子进程

checkThatNpmCanReadCwd()

function checkThatNpmCanReadCwd() {
  const cwd = process.cwd(); // 这里取到当前的进程目录
  let childOutput = null; // 定义一个变量来保存`npm`的信息
  try {
    // 相当于执行`npm config list`并将其输出的信息组合成为一个字符串
    childOutput = spawn.sync('npm', ['config', 'list']).output.join('');
  } catch (err) {
    return true;
  }
  // 判断是否是一个字符串
  if (typeof childOutput !== 'string') {
    return true;
  }
  // 将整个字符串以换行符分隔
  const lines = childOutput.split('\n');
  // 定义一个我们需要的信息的前缀
  const prefix = '; cwd = ';
  // 去整个lines里面的每个line查找有没有这个前缀的一行
  const line = lines.find(line => line.indexOf(prefix) === 0);
  if (typeof line !== 'string') {
    return true;
  }
  // 取出后面的信息,这个信息大家可以自行试一试,就是`npm`执行的目录
  const npmCWD = line.substring(prefix.length);
  // 判断当前目录和执行目录是否是一致的
  if (npmCWD === cwd) {
    return true;
  }
  // 不一致就打印以下信息,大概意思就是`npm`进程没有在正确的目录下执行
  console.error(
    chalk.red(
      `Could not start an npm process in the right directory.\n\n` +
        `The current directory is: ${chalk.bold(cwd)}\n` +
        `However, a newly started npm process runs in: ${chalk.bold(
          npmCWD
        )}\n\n` +
        `This is probably caused by a misconfigured system terminal shell.`
    )
  );
  // 这里他对windows的情况作了一些单独的判断,没有深究这些信息
  if (process.platform === 'win32') {
    console.error(
      chalk.red(`On Windows, this can usually be fixed by running:\n\n`) +
        `  ${chalk.cyan(
          'reg'
        )} delete "HKCU\\Software\\Microsoft\\Command Processor" /v AutoRun /f\n` +
        `  ${chalk.cyan(
          'reg'
        )} delete "HKLM\\Software\\Microsoft\\Command Processor" /v AutoRun /f\n\n` +
        chalk.red(`Try to run the above two lines in the terminal.\n`) +
        chalk.red(
          `To learn more about this problem, read: https://blogs.msdn.microsoft.com/oldnewthing/20071121-00/?p=24433/`
        )
    );
  }
  return false;
}

这个函数我之前居然贴错了,实在是不好意思。我之前没有弄懂这个函数的意思,今天再来看的时候已经豁然开朗了,它的意思上述代码已经解析了,其中用到了一个外部依赖:

  • cross-spawn:这个我之前说到了没有?忘了,用来执行node进程。npm地址

为什么用单独用一个外部依赖,而不是用node自身的呢?来看一下cross-spawn它自己对自己的说明,Node跨平台解决方案,解决在windows下各种问题。

checkNpmVersion()

function checkNpmVersion() {
  let hasMinNpm = false;
  let npmVersion = null;
  try {
    npmVersion = execSync('npm --version')
      .toString()
      .trim();
    hasMinNpm = semver.gte(npmVersion, '3.0.0');
  } catch (err) {
    // ignore
  }
  return {
    hasMinNpm: hasMinNpm,
    npmVersion: npmVersion,
  };
}

这个能说的也比较少,一眼看过去就知道什么意思了,返回一个对象,对象上面有两个对对,一个是npm的版本号,一个是是否有最小npm版本的限制,其中一个外部依赖,一个Node自身的API我之前也都说过了,不说了。

看到到这里createApp()函数的依赖和执行都结束了,接着执行了run()函数,我们继续来看run()函数都是什么,我又想吐槽了,算了,忍住!!!

run()函数在createApp()函数的所有内容执行完毕后执行,它接收7个参数,先来看看。

  • root:我们创建的目录的绝对路径
  • appName:我们创建的目录名称
  • versionreact-scripts的版本
  • verbose:继续传入verbose,在createApp中没有使用到
  • originalDirectory:原始目录,这个之前说到了,到run函数中就有用了
  • tempalte:模板,这个参数之前也说过了,不对外使用
  • useYarn:是否使用yarn

具体的来看下面run()函数。

run()

function run(
  root,
  appName,
  version,
  verbose,
  originalDirectory,
  template,
  useYarn
) {
  // 这里对`react-scripts`做了大量的处理
  const packageToInstall = getInstallPackage(version, originalDirectory); // 获取依赖包信息
  const allDependencies = ['react', 'react-dom', packageToInstall]; // 所有的开发依赖包

  console.log('Installing packages. This might take a couple of minutes.');
  getPackageName(packageToInstall) // 获取依赖包原始名称并返回
    .then(packageName =>
      // 检查是否离线模式,并返回结果和包名
      checkIfOnline(useYarn).then(isOnline => ({
        isOnline: isOnline,
        packageName: packageName,
      }))
    )
    .then(info => {
      // 接收到上述的包名和是否为离线模式
      const isOnline = info.isOnline;
      const packageName = info.packageName;
      console.log(
        `Installing ${chalk.cyan('react')}, ${chalk.cyan(
          'react-dom'
        )}, and ${chalk.cyan(packageName)}...`
      );
      console.log();
      // 安装依赖
      return install(root, useYarn, allDependencies, verbose, isOnline).then(
        () => packageName
      );
    })
    .then(packageName => {
      // 检查当前`Node`版本是否支持包
      checkNodeVersion(packageName);
      // 检查`package.json`的开发依赖是否正常
      setCaretRangeForRuntimeDeps(packageName);
      // `react-scripts`脚本的目录
      const scriptsPath = path.resolve(
        process.cwd(),
        'node_modules',
        packageName,
        'scripts',
        'init.js'
      );
      // 引入`init`函数
      const init = require(scriptsPath);
      // 执行目录的拷贝
      init(root, appName, verbose, originalDirectory, template);
      // 当`react-scripts`的版本为0.9.x发出警告
      if (version === 'react-scripts@0.9.x') {
        console.log(
          chalk.yellow(
            `\nNote: the project was boostrapped with an old unsupported version of tools.\n` +
              `Please update to Node >=6 and npm >=3 to get supported tools in new projects.\n`
          )
        );
      }
    })
    // 异常处理
    .catch(reason => {
      console.log();
      console.log('Aborting installation.');
      // 根据命令来判断具体的错误
      if (reason.command) {
        console.log(`  ${chalk.cyan(reason.command)} has failed.`);
      } else {
        console.log(chalk.red('Unexpected error. Please report it as a bug:'));
        console.log(reason);
      }
      console.log();

      // 出现异常的时候将删除目录下的这些文件
      const knownGeneratedFiles = [
        'package.json',
        'npm-debug.log',
        'yarn-error.log',
        'yarn-debug.log',
        'node_modules',
      ];
      // 挨着删除
      const currentFiles = fs.readdirSync(path.join(root));
      currentFiles.forEach(file => {
        knownGeneratedFiles.forEach(fileToMatch => {
          if (
            (fileToMatch.match(/.log/g) && file.indexOf(fileToMatch) === 0) ||
            file === fileToMatch
          ) {
            console.log(`Deleting generated file... ${chalk.cyan(file)}`);
            fs.removeSync(path.join(root, file));
          }
        });
      });
      // 判断当前目录下是否还存在文件
      const remainingFiles = fs.readdirSync(path.join(root));
      if (!remainingFiles.length) {
        console.log(
          `Deleting ${chalk.cyan(`${appName} /`)} from ${chalk.cyan(
            path.resolve(root, '..')
          )}`
        );
        process.chdir(path.resolve(root, '..'));
        fs.removeSync(path.join(root));
      }
      console.log('Done.');
      process.exit(1);
    });
}

他这里对react-script做了很多处理,大概是由于react-script本身是有node版本的依赖的,而且在用create-react-app init <project>初始化一个项目的时候,是可以指定react-script的版本或者是外部自身定义的东东。

他在run()函数中的引用都是用Promise回调的方式来完成的,从我正式接触Node开始就习惯用async/await,所以对Promise还真不熟,恶补了一番,下面我们来拆解其中的每一句和每一个函数的作用,先来看一下用到外部依赖还是之前那些不说了,来看看函数列表:

  • getInstallPackage():获取要安装的react-scripts版本或者开发者自己定义的react-scripts
  • getPackageName():获取到正式的react-scripts的包名
  • checkIfOnline():检查网络连接是否正常
  • install():安装开发依赖包
  • checkNodeVersion():检查Node版本信息
  • setCaretRangeForRuntimeDeps():检查发开依赖是否正确安装,版本是否正确
  • init():将事先定义好的目录文件拷贝到我的项目中

知道了个大概,我们在来逐一分析每个函数的作用:

getInstallPackage()

function getInstallPackage(version, originalDirectory) {
  let packageToInstall = 'react-scripts'; // 定义常量 packageToInstall,默认就是标准`react-scripts`包名
  const validSemver = semver.valid(version); // 校验版本号是否合法
  if (validSemver) {
    packageToInstall += `@${validSemver}`; // 合法的话执行,就安装指定版本,在`npm install`安装的时候指定版本为加上`@x.x.x`版本号,安装指定版本的`react-scripts`
  } else if (version && version.match(/^file:/)) {
    // 不合法并且版本号参数带有`file:`执行以下代码,作用是指定安装包为我们自身定义的包
    packageToInstall = `file:${path.resolve(
      originalDirectory,
      version.match(/^file:(.*)?$/)[1]
    )}`;
  } else if (version) {
    // 不合法并且没有`file:`开头,默认为在线的`tar.gz`文件
    // for tar.gz or alternative paths
    packageToInstall = version;
  }
  // 返回最终需要安装的`react-scripts`的信息,或版本号或本地文件或线上`.tar.gz`资源
  return packageToInstall;
}

这个方法接收两个参数version版本号,originalDirectory原始目录,主要的作用是判断react-scripts应该安装的信息,具体看每一行。

这里create-react-app本身提供了安装react-scripts的三种机制,一开始初始化的项目是可以指定react-scripts的版本或者是自定义这个东西的,所以在这里他就提供了这几种机制,其中用到的外部依赖只有一个semver,之前就说过了,不多说。

getPackageName()

function getPackageName(installPackage) {
  // 函数进来就根据上面的那个判断`react-scripts`的信息来安装这个包,用于返回正规的包名
  // 此处为线上`tar.gz`包的情况
  if (installPackage.match(/^.+\.(tgz|tar\.gz)$/)) {
    // 里面这段创建了一个临时目录,具体它是怎么设置了线上.tar.gz包我没试就不乱说了
    return getTemporaryDirectory()
      .then(obj => {
        let stream;
        if (/^http/.test(installPackage)) {
          stream = hyperquest(installPackage);
        } else {
          stream = fs.createReadStream(installPackage);
        }
        return extractStream(stream, obj.tmpdir).then(() => obj);
      })
      .then(obj => {
        const packageName = require(path.join(obj.tmpdir, 'package.json')).name;
        obj.cleanup();
        return packageName;
      })
      .catch(err => {
        console.log(
          `Could not extract the package name from the archive: ${err.message}`
        );
        const assumedProjectName = installPackage.match(
          /^.+\/(.+?)(?:-\d+.+)?\.(tgz|tar\.gz)$/
        )[1];
        console.log(
          `Based on the filename, assuming it is "${chalk.cyan(
            assumedProjectName
          )}"`
        );
        return Promise.resolve(assumedProjectName);
      });
  // 此处为信息中包含`git+`信息的情况
  } else if (installPackage.indexOf('git+') === 0) {
    return Promise.resolve(installPackage.match(/([^/]+)\.git(#.*)?$/)[1]);
  // 此处为只有版本信息的时候的情况
  } else if (installPackage.match(/.+@/)) {
    return Promise.resolve(
      installPackage.charAt(0) + installPackage.substr(1).split('@')[0]
    );
  // 此处为信息中包含`file:`开头的情况
  } else if (installPackage.match(/^file:/)) {
    const installPackagePath = installPackage.match(/^file:(.*)?$/)[1];
    const installPackageJson = require(path.join(installPackagePath, 'package.json'));
    return Promise.resolve(installPackageJson.name);
  }
  // 什么都没有直接返回包名
  return Promise.resolve(installPackage);
}

他这个函数的目标就是返回一个正常的依赖包名,比如我们什么都不带就返回react-scripts,在比如我们是自己定义的包就返回my-react-scripts,继续到了比较关键的函数了,接收一个installPackage参数,从这函数开始就采用Promise回调的方式一直执行到最后,我们来看看这个函数都做了什么,具体看上面每一行的注释。

总结一句话,这个函数的作用就是返回正常的包名,不带任何符号的,来看看它的外部依赖:

  • hyperquest:这个用于将http请求流媒体传输。npm地址

他本身还有函数依赖,这两个函数依赖我都不单独再说,函数的意思很好理解,至于为什么这么做我还没想明白:

  • getTemporaryDirectory():不难,他本身是一个回调函数,用来创建一个临时目录。
  • extractStream():主要用到node本身的一个流,这里我真没懂为什么药改用流的形式,就不发表意见了,在看其实我还是没懂,要真正的明白是要去试一次,但是真的有点麻烦,不想去关注。

PS:其实这个函数很好理解就是返回正常的包名,但是里面的有些处理我都没想通,以后理解深刻了在回溯一下。

checkIfOnline()

function checkIfOnline(useYarn) {
  if (!useYarn) {
    return Promise.resolve(true);
  }

  return new Promise(resolve => {
    dns.lookup('registry.yarnpkg.com', err => {
      let proxy;
      if (err != null && (proxy = getProxy())) {
        dns.lookup(url.parse(proxy).hostname, proxyErr => {
          resolve(proxyErr == null);
        });
      } else {
        resolve(err == null);
      }
    });
  });
}

这个函数本身接收一个是否使用yarn的参数来判断是否进行后续,如果使用的是npm就直接返回true了,为什么会有这个函数是由于yarn本身有个功能叫离线安装,这个函数来判断是否离线安装,其中用到了外部依赖:

  • dns:用来检测是否能够请求到指定的地址。npm地址

install()

function install(root, useYarn, dependencies, verbose, isOnline) {
  // 封装在一个回调函数中
  return new Promise((resolve, reject) => {
    let command; // 定义一个命令
    let args;  // 定义一个命令的参数
    // 如果使用yarn
    if (useYarn) {
      command = 'yarnpkg';  // 命令名称
      args = ['add', '--exact']; // 命令参数的基础
      if (!isOnline) {
        args.push('--offline');  // 此处接上面一个函数判断是否是离线模式
      }
      [].push.apply(args, dependencies); // 组合参数和开发依赖 `react` `react-dom` `react-scripts`
      args.push('--cwd'); // 指定命令执行目录的地址
      args.push(root); // 地址的绝对路径
      // 在使用离线模式时候会发出警告
      if (!isOnline) {
        console.log(chalk.yellow('You appear to be offline.'));
        console.log(chalk.yellow('Falling back to the local Yarn cache.'));
        console.log();
      }
    // 不使用yarn的情况使用npm
    } else {
      // 此处于上述一样,命令的定义 参数的组合
      command = 'npm';
      args = [
        'install',
        '--save',
        '--save-exact',
        '--loglevel',
        'error',
      ].concat(dependencies);
    }
    // 因为`yarn`和`npm`都可以带这个参数,所以就单独拿出来了拼接到上面
    if (verbose) {
      args.push('--verbose');
    }
    // 这里就把命令组合起来执行
    const child = spawn(command, args, { stdio: 'inherit' });
    // 命令执行完毕后关闭
    child.on('close', code => {
      // code 为0代表正常关闭,不为零就打印命令执行错误的那条
      if (code !== 0) {
        reject({
          command: `${command} ${args.join(' ')}`,
        });
        return;
      }
      // 正常继续往下执行
      resolve();
    });
  });
}

又到了比较关键的地方了,仔细看每一行代码注释,此处函数的作用就是组合一个yarn或者npm的安装命令,把这些模块安装到项目的文件夹中,其中用到的外部依赖cross-spawn前面有说了,就不说了。

其实执行到这里,create-react-app已经帮我们创建好了目录,package.json并且安装了所有的依赖,reactreact-domreact-scrpts,复杂的部分已经结束,继续往下走。

checkNodeVersion()

function checkNodeVersion(packageName) {
  // 找到`react-scripts`的`package.json`路径
  const packageJsonPath = path.resolve(
    process.cwd(),
    'node_modules',
    packageName,
    'package.json'
  );
  // 引入`react-scripts`的`package.json`
  const packageJson = require(packageJsonPath);
  // 在`package.json`中定义了一个`engines`其中放着`Node`版本的信息,大家可以打开源码`packages/react-scripts/package.json`查看
  if (!packageJson.engines || !packageJson.engines.node) {
    return;
  }
  // 比较进程的`Node`版本信息和最小支持的版本,如果比他小的话,会报错然后退出进程
  if (!semver.satisfies(process.version, packageJson.engines.node)) {
    console.error(
      chalk.red(
        'You are running Node %s.\n' +
          'Create React App requires Node %s or higher. \n' +
          'Please update your version of Node.'
      ),
      process.version,
      packageJson.engines.node
    );
    process.exit(1);
  }
}

这个函数直译一下,检查Node版本,为什么要检查了?之前我已经说过了react-scrpts是需要依赖Node版本的,也就是说低版本的Node不支持,其实的外部依赖也是之前的几个,没什么好说的。

setCaretRangeForRuntimeDeps()

function setCaretRangeForRuntimeDeps(packageName) {
  const packagePath = path.join(process.cwd(), 'package.json');  // 取出创建项目的目录中的`package.json`路径
  const packageJson = require(packagePath); // 引入`package.json`
  // 判断其中`dependencies`是否存在,不存在代表我们的开发依赖没有成功安装
  if (typeof packageJson.dependencies === 'undefined') {
    console.error(chalk.red('Missing dependencies in package.json'));
    process.exit(1);
  }
  // 拿出`react-scripts`或者是自定义的看看`package.json`中是否存在
  const packageVersion = packageJson.dependencies[packageName];
  if (typeof packageVersion === 'undefined') {
    console.error(chalk.red(`Unable to find ${packageName} in package.json`));
    process.exit(1);
  }
  // 检查`react` `react-dom` 的版本 
  makeCaretRange(packageJson.dependencies, 'react');
  makeCaretRange(packageJson.dependencies, 'react-dom');
  // 重新写入文件`package.json`
  fs.writeFileSync(packagePath, JSON.stringify(packageJson, null, 2));
}

这个函数我也不想说太多了,他的作用并没有那么大,就是用来检测我们之前安装的依赖是否写入了package.json里面,并且对依赖的版本做了检测,其中一个函数依赖:

  • makeCaretRange():用来对依赖的版本做检测

我没有单独对其中的子函数进行分析,是因为我觉得不难,而且对主线影响不大,我不想贴太多说不完。

到这里createReactApp.js里面的源码都分析完了,咦!你可能会说你都没说init()函数,哈哈哈,看到这里说明你很认真哦,init()函数是放在packages/react-scripts/script目录下的,但是我还是要给他说了,因为它其实跟react-scripts包联系不大,就是个copy他本身定义好的模板目录结构的函数。

init()

它本身接收5个参数:

  • appPath:之前的root,项目的绝对路径
  • appName:项目的名称
  • verbose:这个参数我之前说过了,npm安装时额外的信息
  • originalDirectory:原始目录,命令执行的目录
  • template:其实其中只有一种类型的模板,这个选项的作用就是配置之前我说过的那个函数,测试模板
// 当前的包名,也就是这个命令的包
const ownPackageName = require(path.join(__dirname, '..', 'package.json')).name;
// 当前包的路径
const ownPath = path.join(appPath, 'node_modules', ownPackageName);
// 项目的`package.json`
const appPackage = require(path.join(appPath, 'package.json'));
// 检查项目中是否有`yarn.lock`来判断是否使用`yarn`
const useYarn = fs.existsSync(path.join(appPath, 'yarn.lock'));

appPackage.dependencies = appPackage.dependencies || {};

// 定义其中`scripts`的
appPackage.scripts = {
  start: 'react-scripts start',
  build: 'react-scripts build',
  test: 'react-scripts test --env=jsdom',
  eject: 'react-scripts eject',
};
// 重新写入`package.json`
fs.writeFileSync(
  path.join(appPath, 'package.json'),
  JSON.stringify(appPackage, null, 2)
);

// 判断项目目录是否有`README.md`,模板目录中已经定义了`README.md`防止冲突
const readmeExists = fs.existsSync(path.join(appPath, 'README.md'));
if (readmeExists) {
  fs.renameSync(
    path.join(appPath, 'README.md'),
    path.join(appPath, 'README.old.md')
  );
}
// 是否有模板选项,默认为当前执行命令包目录下的`template`目录,也就是`packages/react-scripts/tempalte`
const templatePath = template
  ? path.resolve(originalDirectory, template)
  : path.join(ownPath, 'template');
if (fs.existsSync(templatePath)) {
  // 拷贝目录到项目目录
  fs.copySync(templatePath, appPath);
} else {
  console.error(
    `Could not locate supplied template: ${chalk.green(templatePath)}`
  );
  return;
}

这个函数我就不把代码贴全了,里面的东西也蛮好理解,基本上就是对目录结构的修改和重名了那些,挑了一些来说,到这里,create-react-app从零到目录依赖的安装完毕的源码已经分析完毕,但是其实这只是个初始化目录和依赖,其中控制环境的代码都存在react-scripts中,所以其实离我想知道的关键的地方还有点远,但是本篇已经很长了,不打算现在说了,多多包涵。

希望本篇对大家有所帮助吧。

啰嗦两句

本来这篇我是打算把create-react-app中所有的源码的拿出来说一说,包括其中的webpack的配置啊,eslint的配置啊,babel的配置啊.....等等,但是实在是有点多,他自己本身把初始化的命令和控制react环境的命令分离成了packages/create-react-apppackages/react-script两边,这个篇幅才把packages/create-react-app说完,更复杂的packages/react-script在说一下这篇幅都不知道有多少了,所以我打算之后空了,在单独写一篇关于packages/react-script的源码分析的文。

码字不易,可能出现错别字什么的,说的不清楚的,说错的,欢迎指正,多多包涵!

关注下面的标签,发现更多相似文章
评论
说说你的看法