前言

你是否在参加有README.md的项目的编写时，老是在更改了README.md之后诲人不倦地一个一个奉告同事去读README.md？你是否遇到过有人由于没读README.md，在修正代码的时分犯了初级错误？你是否在项目中有好几个甚至几十个README.md，而没有办法在README.md被修正之后及时地找到并阅览README.md？

现在好了，有了rtf-readme这个项目中的插件和相关CLI东西后，你再也不必担心上面的问题了。

rtf-readme项目地址：github.com/digshare/rt…

VSCode 插件地址：marketplace.visualstudio.com/items?itemN…

项目讨论QQ群：1029881641

rtf-readme项目功能一览

  • 支撑在VSCode中，当翻开/修正一个文件时，提示查看修正这个文件所需求读的README文件。
  • 支撑在CI中，运用指令行来查看是否有人 在没有阅览需求读的README 的情况下，修正了某个文件。
  • 支撑在README中，运用glob patterns来指定某些文件在修正时需求读这个README。
  • 支撑README文件中写父目录途径的glob patterns。
  • 支撑自定义需求提示查看的README的途径。

过一遍项目的插件功能

rtf-readme项目分为三个部分：VSCode插件、指令行客户端、指令行服务端。其中，木帆科技现已供给了一个服务端，在生成配置文件的时分会主动添加到配置文件中，所以运用这个项目的童鞋们不必自己去找公网服务器部署了。而要运用VSCode插件、指令行客户端，有必要要在项目中有个配置文件。

下面，咱们就来尝试用VSCode插件来创立一个rtf-readme项目所需求的配置文件。

首先，咱们需求下载vscode插件rtf-readme。在插件查找框中输入rtf-readme，找到rtf-README插件，并下载。

终于，不用再一个个地提醒同事读README了

下载完成后，按Ctrl+Shift+P快捷键，然后在弹出来的框中输入Create Config File，找到rtf-README插件所供给的指令“rtf-README: Create Config File”。

终于，不用再一个个地提醒同事读README了

运用指令“rtf-README: Create Config File”来创立配置文件，一般server的URL直接运用默许的就好（除非你自己在某个公网服务器搭了个rtf-readme服务）。创立好的配置文件放在项目根目录里，

终于，不用再一个个地提醒同事读README了

让咱们来看看配置文件里都有啥。

终于，不用再一个个地提醒同事读README了

如上图所示，配置文件中一共有4个子项，分别是(1) server: 支撑数据中心化的公网服务器地址； (2) token: 用于指定某固定项目的字符串，一般一个项目用一个单独的token； (3) ignore: 这个字段指定插件和指令行东西要疏忽的文件，支撑glob pattern格式； (4) readme: 指定插件和指令行东西需求考虑到的README文件途径，支撑glob pattern格式。

配置文件创立后，就能够开始运用插件提示和指令行查看了。当然，在运用前，咱们得下载rtf-README插件(前面现已装置过了)以及在npm.js上下载rtf-reame包。

要让插件在翻开文件的时分提示阅览README文件，首先，咱们能够在根目录创立一个README.md文件，然后在里面输入 <!-- README ** --> ，这样写了今后，保存README.md，再翻开项目中的其他文件，就能够看到VSCode的提示读README的提示了。

终于，不用再一个个地提醒同事读README了

别的，还能够在项目根目录履行yarn rtfr check来履行查看，看有没有文件被修正但却没读README的情况。这里的修正是指提交到git中，所以要测试这个功能，需求两个commit：先提交README.md，然后再提交这个README.md关联的文件。别的，还需求第二个commit和第一个commit的作者不同，且第二个commit的作者没有阅览第一个commit提交的README.md。

终于，不用再一个个地提醒同事读README了

仔细的童鞋或许现已注意到，在README文件添加glob patterns后，VSCode中翻开的文件的左上方呈现了一个n associated字样。

终于，不用再一个个地提醒同事读README了

这个字样是rtf-README插件添加的，意思是这个文件有1个README与它相关联。点击上图中红框部分，还会弹出与这个文件相关联的README文件的文件名和途径。

终于，不用再一个个地提醒同事读README了

服务器端简要阐明

为了中心化README阅览的数据，需求起一个服务器来保存数据。为什么要中心化呢？由于数据存在本地的话，数据会跟着分支切换而改动，这样一来就欠好维护了。

服务器端记载了两种数据，分别是用户读过的README版本和运用rtf-readme check查看过的commit。前者是通过记载README相对途径和README的commit hash来完成记载README版本的。

碎碎念

有人或许不知道rtf是什么意思，其实rtf是read the f***ing的简写

我司其他项目引荐

magicspace，一个前端代码主动生成器。