来自掘金：阅读前端源码的思路

一、为什么要阅读源码

语言只是一个工具，关键还是需要我们去传达思想，解决问题

通过阅读源码，了解那些优秀的思想设计，真正带来技术上的进步，这也是进阶不可少的一步；

在阅读源码的时候，遵循一定的方法，层层抽丝剥茧，就可以慢慢发现作者很多精妙的想法，甚至彩蛋，这也是阅读别人源码的乐趣；

二、怎么阅读源码效率更高

由外到内，由浅入深

1.应用文档

如果这个框架有相关应用文档，先耐心看完整个应用文档，了解框架提供的用法；

看完文档之后，反过来思考，如果需要实现文档的这些功能，你可以怎么做；

带着问题去拉源码仓库代码；

2.文件结构

关注源码文件结构，从文件夹命名上可以看出，一些模块和功能是怎样划分的，形成一个大概依赖关系图；

3.package.json中的依赖

可以看下dependencies和devDependencies的各项依赖；了解这些依赖是干什么的，了解依赖的具体用途；

这是提前了解框架应用底座的关键；

4.package.json中的脚本

了解清楚依赖的用途之后，再看"scripts"的各项脚本，脚本一般分为几类：

***工程构件类（常用命令：dev、build等）

***规范校验类（常用命令：lint）

***单元测试类（常用命令：test）

***项目发布类（常用命令:release、publish等）

***其他脚本类

重点关注工程构件类，无论哪个命令都是围绕工程构建框架（rollup、webpack等）的各项配置来启动的，所以这里很容易找到关键配置文件，然后顺藤摸瓜找到源码的入口文件

5.逻辑结构和注释

从源码入口文件开始，逐步去debug整个源码逻辑结构，可以先看函数定义和引用，再附加过程中的各种注释，形成自己的笔记文档

三、部分配置和文档说明

README.md

项目根说明文档，主要说明这个项目是干什么的

CHANGELOG.md

项目更新说明文档，记录不同版本更新了什么内容

CONTRIBUTING.md

贡献代码指南，如果你想贡献源码，可以看这个指引

CODE_OF_CONDUCT.md

代码贡献契约，有不同版本的标准，主要约定贡献者的责任义务之类的内容

BACKERS.md

赞助商或支持者清单，不少开源项目就是靠这个钱来支撑开发的

SECURITY.md

安全漏洞报告指引

AUTHORS

代码作者清单

LICENSE

许可证书，一般是MIT，不同类型证书会有不同的限制

.babelrc.js

babel插件的配置文件，也可以是 babel.config.js

.editorconfig

编辑器配置，例如代码的缩进方式

.eslintignore

忽略eslint校验的文件清单

.eslintrc.js

eslint的主要配置

.flowconfig

flow配置，用到flow校验数据类型项目的才会有

.gitattributes

路径属性定义列表，不同配置项配置不同内容，例如配置行末字符为LF

.gitignore

git提交忽略清单，只存在本地，不会提交上去

.mailmap

映射清单，将个人的多个账号映射为1个，避免git记录不唯一

.npmignore

npm包忽略清单，只存在本地，不会发布到npm

.nvmrc

指定node版本

.prettierignore

不使用prettier格式美化的文件清单

.prettierrc.js

格式美化配置

.watchmanconfig

文件检测器watchman配置文档

.circleci文件夹

持续集成/持续部署（CI/CD）脚本

.codesandbox文件夹

codesandbox相关配置

.github文件夹

github相关脚本配置

四、部分package.json配置字段

name

项目名称

version

版本号，注意三个位置的的数字意义，和前置符^和～等的适配版本范围

description

项目描述

keywords

关键词，用于npm包搜索的

private

设置true为私有，则不会被发布出去

repository

项目仓库地址

author

项目作者，只有一个

bugs

提交bug的地址

contributors

项目贡献者，可以多个

license

许可证书

engines

配置node，npm版本号等

os

设置适用系统，例如linux才能运行此模块

cpu

设置适用cpu架构，例如x64才能运行此模块

browserslist

浏览器兼容类型支持列表

scripts

脚本命令

dependencies

项目生产依赖，代表项目被应用时候，必须依赖的其他包

devDependencies

项目开发依赖，代表项目在开发时候，必须依赖的其他包

peerDependencies

项目对等依赖，代表项目在运行时候，必须依赖外部项目本身安装的依赖，而不是自身内部的依赖

main

commonJS规范下（使用require引用）指定入口，如果不指定，会默认引用根目录下index.js

module

ESM规范下（使用import引用）指定入口

browser

浏览器运行环境的模块引用入口，main和module不区分运行环境

files

指定npm包发布的文件列表，例如指定构建后的文件列表，源码不发布

workspaces

配置工作区，例如你开发的是一个大框架，包含很多子package，则将子package路径配置到工作区里，而将这个大框架的private设置为true，因为这个大框架不是你要发布的包

bin

配置自定义命令，键值将被注册为快捷脚本，对应文件入口为命令执行文件，基本脚手架都会用到这个