专栏首页Aloys的开发之路能让程序做的事情坚决不用人来做——批量修复markdownlint MD034警告

能让程序做的事情坚决不用人来做——批量修复markdownlint MD034警告

欢迎和大家交流技术相关问题:

现在各种编程语言都有自己的lint工具来做静态检查,防止一些低级错误并维持统一的风格。Markdown这样的样式标记语言也不例外,现在大家用的比较多的是markdownlint。该项目开源在github:https://github.com/markdownlint/markdownlint,当前很多实用markdown语言的项目都使用该工具。

markdownlint的检查规则目前有41项https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md,其中"MD034 - Bare URL used"是大家经常遇到的问题,如果你在Markdown文档中使用URL,但是没有在URL周围使用<>的话就会产生警告,我维护了一个类似于awesome的项目https://github.com/jiangxincode/cnblogs,其中报了1000多个类似的警告,如果全部手工来修改估计手都回废掉,因此写了个小程序在所有的.md文档中的所有url两遍加上了<>。

程序使用Java编写,比较简单,主要使用了正则表达式的替换,程序如下:

package edu.jiangxin.tools;

import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Solve the problem of MD034. <p>
 * {@link https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md}
 * This program doesn't process any exception!
 * @author aloys
 *
 */
public class MD034Solver {
    public static final String regex = "\\b(https?|ftp|file)://[-A-Z0-9+&@#/%?=~_|$!:,.;]*[A-Z0-9+&@#/%=~_|$]";
    
    public static final String sourceDirStr = "D:\\temp\\cnblogs";
    
    public static final String targetDirStr = "D:\\temp\\cnblogsbak";

    public static void main(String[] args) throws IOException {
        // Source directory must be a valid directory which contains the text files to be processed.
        File sourceDir = new File(sourceDirStr);

        // Target directory must be a valid directory which will save the proecessed files.
        File targetDir = new File(targetDirStr);

        for (File file : sourceDir.listFiles()) {

            // take off the .git directory and .gitignore file
            if (file.getName().startsWith(".")) {
                continue;
            }

            BufferedReader reader = new BufferedReader(new FileReader(file));
            BufferedWriter writer = new BufferedWriter(new FileWriter(new File(targetDir, file.getName())));

            String temp = null;
            while ((temp = reader.readLine()) != null) {
                Pattern pattern = Pattern.compile(regex, Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE);
                Matcher regexMatcher = pattern.matcher(temp);
                StringBuffer sb = new StringBuffer();
                while (regexMatcher.find()) {
                    String group = regexMatcher.group();
                    int start = regexMatcher.start();
                    if (start >= 1 && (temp.charAt(start - 1) == '<' || temp.charAt(start - 1) == '(')) {
                        regexMatcher.appendReplacement(sb, group);
                    } else {
                        regexMatcher.appendReplacement(sb, "<" + group + ">");
                    }

                }
                regexMatcher.appendTail(sb);
                writer.write(sb.toString());
                writer.newLine();
            }
            reader.close();
            writer.close();
        }
    }

}

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 制作Aspose CHM文档的过程记录

    最近公司需要使用Aspose组件开发相关内容,但是网上找不到理想的参考文档,官网访问速度也慢的可以。所以打算自己做份CHM文档,做的过程中遇到很多困难,这里记录...

    用户1221057
  • 使用CXF+Spring发布WebService,启动报错

    使用CXF+Spring发布WebService,启动报错,日志如下: 五月 12, 2017 9:01:37 下午 org.apache.tomcat.uti...

    用户1221057
  • Linux乱码问题解决方案

    linux系统中文件名内容为urf8编码, windows系统中文件名默认为gbk编码, 多数文档使用gbk编码,系统采用utf8编码 无中文输入法导致的乱码 ...

    用户1221057
  • 自己动手写Web服务器(一)简单的静态服务器

    前几天开始看《How Tomcat Works》,因为有人推荐要研究tomcat源代码,看这本书是很有帮助的。

    the5fire
  • Java每日一练(2017/6/8)

    Java基础 | 数据库 | Android | 学习视频 | 学习资料下载 课前导读 ●回复"每日一练"获取以前的题目! ●答案公布时间:为每期发布题目的第二...

    Java学习
  • Java NIO 实现 EchoServer EchoClient

    EchoServer采用阻塞模式,用线程池中的工作线程处理每个客户连接。 EchoClient也采用阻塞模式,单线程。

    用户1621453
  • 做Java Web项目过程中遇到的几个问题及解决方案

    javax.servlet.ServletException:java.lang.NoClassDefFoundErr

    魏晓蕾
  • mkdir与mkdirs

    在Java中对文件进行操作时常常用到java.io.File.mkdir()和java.io.File.mkdirs()两个方法来创建一个目录(文件夹),这两个...

    似水的流年
  • Unsupported major.minor version 51.0

    这是版本不支持造成的,更改方法:JDK向下兼容,当你的Linux中安装的是1.6时,你的工程代码也要相应的调整为1.6. 重新上传问题解决。

    用户5166556
  • 3种常见的Class级别的错误

    ClassNotFoundException 很明显,这个错误是 找不到类异常,即在当前classpath路径下找不到这个类。 ClassNotFoundExc...

    Java技术栈

扫码关注云+社区

领取腾讯云代金券