2022-02-11阅读源码的思路

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

一、为什么要阅读源码

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

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

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

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

由外到内,由浅入深

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

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容