本文介绍了选择vtable开发大数据量可编辑表格的原因,并详细说明了如何访问和了解vtable的github仓库。文中提到了阅读源码的两个目的,并详细列出了仓库中的各个目录及其功能,包括项目配置、工作流模板、vscode配置、公共文件、自动安装器、git钩子、脚本、帮助文档、主包、公用扩展和工具库等。最后预告了下一篇文章将分享packages中的react-vtable源码。
为什么要选择Vtable,可见文章:为什么我推荐使用vtable开发大数据量可编辑表格
读源码有两个目的:
1、vtable作为功能强大的大数据可编辑表格,如果想使用他,需要能够掌控源码,拥有从源码层面解决问题的能力。
2、字节作为大公司,又开源了这么优秀的项目,肯定有很多值得借鉴的地方
好了,话不多说,开讲
首先进入vtable的官网,在最右角有个小猫头像,点击即可进入vtable的github仓库,点击下载即可,也可通过git链接拉取下来
解压后目录
其中:
.github: 项目在github中的配置
ISSUE_TEMPLATE:自定义贡献者在仓库中打开新议题时可使用的模板
PULL_REQUEST_TEMPLATE:拉取请求模板
workflows:工作流模板,工作流模板是可帮助你为存储库创建自己的 GitHub Actions 工作流的模板。 使用入门工作流时,你无需从空白工作流文件全新开始,由于部分工作已经为你完成,因此非常实用。
bug-server.yml
release.yml: 发行流程工作流
stale
.yml: stale
是一个用于检测 GitHub 仓库中长时间未更新的 issue 和 pull request 的工具
unit-test.yml: 单元测试工作流
pre-release.yml: 预发布版本发行流程工作流
release-changelog.yml: 构建版本日志工作流
题外话:在此之前,还一直没用过github的这些功能,包括模板和工作流,多一点技术积累总归没错,以后可以用到
.vscode:vscode配置,这个暂不一一介绍了
common:公共文件
autoinstallers:自动安装器
config/rush:rushjs 是来自微软的单体仓库管理工具,rush配置。rush 会通过默认的 pnpm 包管理器安装依赖,所有的依赖会安装在总项目目录下的 common 的 temp 文件夹下,而对应的子项目例如 vueapp 目录下同时会 出现 node_modules 目录,而里面的包都是软链接自最外层的 common 下的 temp 目录。
git-hooks:git钩子,git hooks
是一些自定义的脚本,用于控制git工作的流程,分为客户端钩子和服务端钩子。
commit-msg:用来在提交通过前验证项目状态或提交信息。
pre-commit:用于检查即将提交的快照。
pre-push:用于检查即将推送的快照。
scripts:脚本,供 github的流程图调用
docs: vtable的帮助文档,暂不介绍
packages:主包,后续详细介绍
share: 一些公用的扩展,如react和vue等,在子项目中会使用
tools:工具库
bundler: 打包机,供rush使用
bugserver-trigger:为所有vGrammar包触发错误服务器,错误上报
今天先分享到这里,下一篇文章分享packages中的 react-vtable源码