如何將markdown轉換爲wxml

原文地址:如何將markdown轉換爲wxml
話說我要爲技術博客寫一個小程序版,個人博客解決方案是 hexo + github-page,格式固然是技術控們喜歡的 markdown 了 。但小程序使用的倒是獨有的模版語言 WXML。我總不能把以前的文章手動轉換成小程序的 wxml 格式吧,而網上也沒完善的轉換庫,仍是本身寫個解析器吧。javascript

解析器最核心的部分就是字符串模式匹配,既然涉及到字符串匹配,那麼就離不開正則表達式。幸虧,正則表達式是個人優點之一。css

正則表達式

JavaScript中的正則表達式

解析器涉及到的 JavaScript 正則表達式知識html

RegExp 構造函數屬性,其中lastMatch,rightContent在字符串截取時很是有用java

長屬性名 短屬性名 替換標誌 說明
input $_ 最近一次要匹配的字符串。Opera未實現此屬性
lastMatch $& $& 最近一次的匹配項。Opera未實現此屬性
lastParen $+ 最近一次匹配的捕獲組。Opera未實現此屬性
leftContext $` $` input字符串中lastMatch以前的文本
rightContext $' $' Input字符串中lastMatch以後的文本
multiline $* 布爾值,表示是否全部表達式都使用多行模式。IE和Opera未實現此屬性
$n $n 分組
$$ 轉義$
  1. test 方法 和 RegExp 構造函數
    test 方法調用後,上面的屬性就會出如今 RegExp 中,不推薦使用短屬性名,由於會形成代碼可讀性的問題,下面就是樣例node

    var text = "this has been a short summer";
    var pattern = /(.)hort/g;
    
    if (pattern.test(text)){
        alert(RegExp.input);         // this has been a short summer
        alert(RegExp.leftContext);   // this has been a
        alert(RegExp.rightContext);  // summer
        alert(RegExp.lastMatch);     // short
        alert(RegExp.lastParen);     // s
        alert(RegExp.multiline);     // false
    }
    
    //長屬性名均可以用相應的短屬性名來代替。不過因爲這些短屬性名大都不是有效的ECMAScript標識符,所以必須經過方括號語法來訪問它們
    if (pattern.test(text)){
        alert(RegExp.$_);
        alert(RegExp["$`"]);
        alert(RegExp["$'"]);
        alert(RegExp["$&"]);
        alert(RegExp["$+"]);
        alert(RegExp["$*"]);
    }
  2. replace 方法git

    通常使用的是沒有回調函數的簡單版本,而回調函數版本則是個大殺器,及其強大github

    //簡單替換, replace默認只進行一次替換, 如設定全局模式,  將會對符合條件的子字符串進行屢次替換,最後返回通過屢次替換的結果字符串.
    var regex = /(\d{4})-(\d{2})-(\d{2})/;
    "2011-11-11".replace(regex, "$2/$3/$1");
    
    //replace 使用回調函數自定義替換,必須啓用全局模式g,由於要不斷向前匹配,直到匹配完整個字符串
    //match爲當前匹配到的字符串,index爲當前匹配結果在字符串中的位置,sourceStr表示原字符串,
    //若是有分組,則中間多了匹配到的分組內容,match,group1(分組1)...groupN(分組n),index,sourceStr
    "one two three".replace(/\bt[a-zA-Z]+\b/g, function (match,index,str) { //將非開頭的單詞大寫
        console.log(match,index,str);
        return match.toUpperCase(); 
    });
  3. match 方法正則表達式

    全局模式和非全局模式有顯著的區別,全局模式和 exec 方法相似。數據庫

    // 若是參數中傳入的是子字符串或是沒有進行全局匹配的正則表達式,那麼match()方法會從開始位置執行一次匹配,若是沒有匹配到結果,則返回null.不然則會返回一個數組,該數組的第0個元素存放的是匹配文本,返回的數組還含有兩個對象屬性index和input,分別表示匹配文本的起始字符索引和原字符串,還有分組屬性
    var str = '1a2b3c4d5e';
    console.log(str.match(/b/)); //返回["b", index: 3, input: "1a2b3c4d5e"]
    
    //若是參數傳入的是具備全局匹配的正則表達式,那麼match()從開始位置進行屢次匹配,直到最後.若是沒有匹配到結果,則返回null.不然則會返回一個數組,數組中存放全部符合要求的子字符串,但沒有index和input屬性,也沒有分組屬性
    var str = '1a2b3c4d5e';
    str.match(/h/g); //返回null
    str.match(/\d/g); //返回["1", "2", "3", "4", "5"]
    
    var pattern = /\d{4}-\d{2}-\d{2}/g;
    var str ="2010-11-10 2012-12-12";
    var matchArray = str.match(pattern);
    for(vari = 0; i < matchArray.length; i++) {
         console.log(matchArray[i]);
    }
  4. exec 方法json

    與全局模式下的 match 相似,但 exec 更強大,由於返回結果包含各類匹配信息,而match全局模式是不包含具體匹配信息的。

    //逐步提取,捕獲分組匹配文本,必須使用全局模式g, 成功則返回數組(包含匹配的分組信息), 不然爲null
    //Regex每次匹配成功後,會把匹配結束位置更新到lastIndex,下次從lastIndex開始匹配
    //若是不指定全局模式,使用while循環,會形成無窮循環
    var pattern = /(\d{4})-(\d{2})-(\d{2})/g;
    var str2 = "2011-11-11 2013-13-13" ;
    while ((matchArray = pattern.exec(str2)) != null) {
      console.log( "date: " + matchArray[0]+"start at:" + matchArray.index+" ends at:"+         pattern.lastIndex);
      console.log( ",year: " + matchArray[1]);
      console.log( ",month: " + matchArray[2]);
      console.log( ",day: " + matchArray[3]);
    }
  5. searchsplit 這兩個比較簡單的方法則再也不介紹

正則表達式高級概念

正常狀況下正則是從左向右進行單字符匹配,每匹配到一個字符, 就後移位置, 直到最終消耗完整個字符串, 這就是正則表達式的字符串匹配過程,也就是它會匹配字符,佔用字符。相關的基本概念再也不講解,這裏要講的和字符匹配不一樣的概念 - 斷言。

  1. 斷言

    正則中大多數結構都是匹配字符,而斷言則不一樣,它不匹配字符,不佔用字符,而只在某個位置判斷左/右側的文本是否符合要求。這類匹配位置的元素,能夠稱爲 "錨點",主要分爲三類:單詞邊界,開始結束位置,環視。

    單詞邊界 \b 是這樣的位置,一邊是單詞字符,一邊不是單詞字符,以下字符串樣例所示

    \brow\b   //row
    \brow     //row, rowdy
    row\b     //row, tomorow

    ^ 行開頭,多行模式下亦匹配每一個換行符後的位置,即行首
    $ 行結束,多行模式下亦匹配每一個換行符前的位置,即行尾

    //js 中的 $ 只能匹配字符串的結束位置,不會匹配末尾換行符以前的換行符。但開啓多行模式(m)後,^ 和 $ 則能夠匹配中間的換行符。 以下例子可驗證:
    
    // 默認全局模式下,^ 和 $ 直接匹配到了文本最開頭和末尾,忽略了中間的換行符
    'hello\nword'.replace(/^|$/g,'<p>')
    "<p>hello
    word<p>"
    
    // 多行模式下,同時能匹配到結束符中間的換行符
    'hello\nword\nhi'.replace(/^|$/mg,'<p>')
    "<p>hello<p>
    <p>word<p>
    <p>hi<p>"
  2. 環視

    環視是斷言中最強的存在,一樣不佔用字符也不提取任何字符,只匹配文本中的特定位置,與\b, ^ $ 邊界符號類似;但環視更增強大,由於它能夠指定位置和在指定位置處添加向前或向後驗證的條件。

    而環視主要體如今它的不佔位(不消耗匹配字符), 所以又被稱爲零寬斷言。所謂不佔寬度,能夠這樣理解:

    • 環視的匹配結果不歸入數據結果;

    • 環視它匹配過的地方,下次還能用它繼續匹配。

    環視包括順序環視和逆序環視,javascript 在 ES 2018 纔開始支持逆序環視

    • (?=) 順序確定環視 匹配右邊
    • (?!) 順序否認環視
    • (?<=) 逆序確定環視 匹配左邊
    • (?<!) 逆序否認環視

    來看一下具體的樣例

    // 獲取.exe後綴的文件名,不使用分組捕獲,能使捕獲結果不包含.exe後綴,充分利用了環視匹配結果同時不佔位的特性
    'asd.exe'.match(/.+(?=\.exe)/)
    => ["asd", index: 0, input: "asd.exe", groups: undefined]
    
    // 變種否認順序環視,排除特定標籤p/a/img,匹配html標籤
    </?(?!p|a|img)([^> /]+)[^>]*/?> 
    
    //常規逆序環視,一樣利用了環視匹配不佔位的特性
    /(?<=\$)\d+/.exec('Benjamin Franklin is on the $100 bill')  // ["100",index: 29,...]
    /(?<!\$)\d+/.exec('it’s is worth about €90')                // ["90", index: 21,...] 
    
    // 利用環視佔位但不匹配的特性
    '12345678'.replace(/\B(?=(\d{3})+$)/g , ',') 
    => "12,345,678" //分割數字

解析器的編寫

正則表達式相關寫得有點多,但磨刀不誤砍柴工,開始進入主題

markdown格式

hexo 生成的 markdwon 文件格式以下,解析器就是要把它解析成json格式的輸出結果,供小程序輸出 wxml

---
title: Haskell學習-functor
date: 2018-08-15 21:27:15
tags: [haskell]
categories: 技術
banner: https://upload-images.jianshu.io/upload_images/127924-be9013350ffc4b88.jpg
---
<!-- 原文地址:[Haskell學習-functor](https://edwardzhong.github.io/2018/08/15/haskellc/) -->
## 什麼是Functor
**functor** 就是能夠執行map操做的對象,functor就像是附加了語義的表達式,能夠用盒子進行比喻。**functor** 的定義能夠這樣理解:給出a映射到b的函數和裝了a的盒子,結果會返回裝了b的盒子。**fmap** 能夠看做是一個接受一個function 和一個 **functor** 的函數,它把function 應用到 **functor** 的每個元素(映射)。

```haskell
-- Functor的定義
class Functor f where
    fmap :: (a -> b) -> f a -> f b
```
<!-- more -->

入口

使用node進行文件操做,而後調用解析器生成json文件

const { readdirSync, readFileSync, writeFile } = require("fs");
const path = require("path");
const parse = require("./parse");

const files = readdirSync(path.join(__dirname, "posts"));
for (let p of files) {
  let md = readFileSync(path.join(__dirname, "posts", p));
  const objs = parse(md);
  writeFile(path.join(__dirname, "json", p.replace('.md','.json')), JSON.stringify(objs), function( err ){
    err && console.log(err);
  });
}

來看一下解析器入口部分,主要分爲:summary 部分,code代碼部分,markdown文本部分。將文本內容的註釋和空格過濾掉,可是代碼部分的註釋要保留。

module.exports = function analyze(str) {
    let ret = { summary: {}, lines: [] };
    while (str) {
        // 空格
        if (/^([\s\t\r\n]+)/.test(str)) {
            str = RegExp.rightContext;
        }
        // summary 內容塊
        if (/^(\-{3})[\r\n]?([\s\S]+?)\1[\r\n]?/.test(str)) {
            str = RegExp.rightContext;
            ret.summary = summaryParse(RegExp.$2);
            ret.num = new Date(ret.summary.date).getTime();
        }
        // code
        if (/^`{3}(\w+)?([\s\S]+?)`{3}/.test(str)) {
            const codeStr = RegExp.$2 || RegExp.$1;
            const fn = (RegExp.$2 && codeParse[RegExp.$1]) ? codeParse[RegExp.$1] : codeParse.javascript;
            str = RegExp.rightContext;
            ret.lines.push({ type: "code", child: fn(codeStr) });
        }
        // 註釋行
        if (/^<!--[\s\S]*?-->/.test(str)) {
            str = RegExp.rightContext;
        }
        // 提取每行字符串, 利用 . 不匹配換行符的特性
        if (/^(.+)[\r\n]?/.test(str)) {
            str = RegExp.rightContext;
            ret.lines.push(textParse(RegExp.$1));
        }
    }
    return ret;
};

文本內容提取

summary 內容塊的提取比較簡單,不講敘。仍是看 markdown 文本內容的解析吧。這裏匹配 markdown 經常使用類型,好比列表,標題h,連接a,圖片img等。而返回結果的數據結構就是一個列表,列表裏面能夠嵌套子列表。但基本就是正則表達式提取內容,最終消耗完字符行。

function textParse(s) {
    const trans = /^\\(\S)/; //轉義字符
    const italy = /^(\*)(.+?)\1/; //傾斜
    const bold = /^(\*{2})(.+?)\1/; //加粗
    const italyBold = /^(\*{3})(.+?)\1/; //傾斜和加粗
    const headLine = /^(\#{1,6})\s+/; //h1-6
    const unsortList = /^([*\-+])\s+/; //無序列表
    const sortList = /^(\d+)\.\s+/; //有序列表
    const link = /^\*?\[(.+)\]\(([^()]+)\)\*?/; //連接
    const img = /^(?:!\[([^\]]+)\]\(([^)]+)\)|<img(\s+)src="([^"]+)")/; //圖片
    const text =/^[^\\\s*]+/; //普通文本

    if (headLine.test(s)) return { type: "h" + RegExp.$1.length, text: RegExp.rightContext };
    if (sortList.test(s)) return { type: "sl", num: RegExp.$1, child: lineParse(RegExp.rightContext) };
    if (unsortList.test(s)) return { type: "ul", num: RegExp.$1, child: lineParse(RegExp.rightContext) };
    if (img.test(s)) return { type: "img", src: RegExp.$2||RegExp.$4, alt: RegExp.$1||RegExp.$3 };
    if (link.test(s)) return { type: "link", href: RegExp.$2, text: RegExp.$1 };
    return { type: "text", child: lineParse(s) };

    function lineParse(line) {
        let ws = [];
        while (line) {
            if (/^[\s]+/.test(line)) {
                ws.push({ type: "text", text: "&nbsp;" });
                line = RegExp.rightContext;
            }
            if (trans.test(line)) {
                ws.push({ type: "text", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (sortList.test(line)) {
                return { child: lineParse(RegExp.rightContext) };
            }
            if (unsortList.test(line)) {
                return { child: lineParse(RegExp.rightContext) };
            }
            if (link.test(line)) {
                ws.push({ type: "link", href: RegExp.$2, text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (italyBold.test(line)) {
                ws.push({ type: "italybold", text: RegExp.$2 });
                line = RegExp.rightContext;
            }
            if (bold.test(line)) {
                ws.push({ type: "bold", text: RegExp.$2 });
                line = RegExp.rightContext;
            }
            if (italy.test(line)) {
                ws.push({ type: "italy", text: RegExp.$2 });
                line = RegExp.rightContext;
            }
            if (text.test(line)) {
                ws.push({ type: "text", text: RegExp.lastMatch });
                line = RegExp.rightContext;
            }
        }
        return ws;
    }
}

代碼塊顯示

若是隻是解析文本內容,仍是很是簡單的,可是技術博客嘛,代碼塊是少不了的。爲了代碼關鍵字符的顏色顯示效果,爲了方便閱讀,還得繼續解析。我博客目前使用到的語言,基本寫了對應的解析器,其實有些解析器是能夠共用的,好比 style方法不只可應用到 css 上, 還能夠應用到相似的預解析器上好比:scsslesshtml也同樣可應用到相似的標記語言上。

const codeParse = {
  haskell(str){},
  javascript(str){},
  html:html,
  css:style
};

來看一下比較有表明性的 JavaScript 解析器,這裏沒有使用根據換行符(\n)將文本內容切割成字符串數組的方式,由於有些類型須要跨行進行聯合推斷,好比解析塊,方法名稱判斷就是如此。只能將一整塊文本用正則表達式慢慢匹配消耗完。最終的結果相似上面的文本匹配結果 - 嵌套列表,類型就是語法關鍵字,經常使用內置方法,字符串,數字,特殊符號等。

其實根據這個解析器能夠進一步擴展和抽象一下,將它做爲類 C 語言族的基本框架。而後只要傳遞 對應語言的正則表達式規則,就能解析出不一樣語言的結果出來,好比 C#javaC++GO

javascript(str) {
    const comReg = /^\/{2,}.*/;
    const keyReg = /^(import|from|extends|new|var|let|const|return|if|else|switch|case|break|continue|of|for|in|Array|Object|Number|Boolean|String|RegExp|Date|Error|undefined|null|true|false|this|alert|console)(?=([\s.,;(]|$))/;
    const typeReg = /^(window|document|location|sessionStorage|localStorage|Math|this)(?=[,.;\s])/;
    const regReg = /^\/\S+\/[gimuys]?/;
    const sysfunReg = /^(forEach|map|filter|reduce|some|every|splice|slice|split|shift|unshift|push|pop|substr|substring|call|apply|bind|match|exec|test|search|replace)(?=[\s\(])/;
    const funReg = /^(function|class)\s+(\w+)(?=[\s({])/;
    const methodReg = /^(\w+?)\s*?(\([^()]*\)\s*?{)/;
    const symbolReg = /^([!><?|\^$&~%*/+\-]+)/;
    const strReg = /^([`'"])([^\1]*?)\1/;
    const numReg = /^(\d+\.\d+|\d+)(?!\w)/;
    const parseComment = s => {
        const ret = [];
        const lines = s.split(/[\r\n]/g);
        for (let line of lines) {
            ret.push({ type: "comm", text: line });
        }
        return ret;
    };

    let ret = [];

    while (str) {
        if (/^\s*\/\*([\s\S]+?)\*\//.test(str)) {
            str = RegExp.rightContext;
            const coms = parseComment(RegExp.lastMatch);
            ret = ret.concat(coms);
        }
        if (/^(?!\/\*).+/.test(str)) {
            str = RegExp.rightContext;
            ret.push({ type: "text", child:lineParse(RegExp.lastMatch) });
        }
        if(/^[\r\n]+/.test(str)){
            str=RegExp.rightContext;
            ret.push({type:'text',text:RegExp.lastMatch});
        }
    }
    return ret;

    function lineParse(line) {
        let ws = [];
        while (line) {
            if (/^([\s\t\r\n]+)/.test(line)) {
                ws.push({ type: "text", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (comReg.test(line)) {
                ws.push({ type: "comm", text: line });
                break;
            }
            if (regReg.test(line)) {
                ws.push({ type: "fun", text: RegExp.lastMatch });
                line = RegExp.rightContext;
            }
            if (symbolReg.test(line)) {
                ws.push({ type: "keyword", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (keyReg.test(line)) {
                ws.push({ type: "keyword", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (funReg.test(line)) {
                ws.push({ type: "keyword", text: RegExp.$1 });
                ws.push({ type: "text", text: "&nbsp;" });
                ws.push({ type: "fun", text: RegExp.$2 });
                line = RegExp.rightContext;
            }
            if (methodReg.test(line)) {
                ws.push({ type: "fun", text: RegExp.$1 });
                ws.push({ type: "text", text: "&nbsp;" });
                ws.push({ type: "text", text: RegExp.$2 });
                line = RegExp.rightContext;
            }
            if (typeReg.test(line)) {
                ws.push({ type: "fun", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (sysfunReg.test(line)) {
                ws.push({ type: "var", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (strReg.test(line)) {
                ws.push({ type: "var", text: RegExp.$1 + RegExp.$2 + RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (numReg.test(line)) {
                ws.push({ type: "var", text: RegExp.$1 });
                line = RegExp.rightContext;
            }
            if (/^\w+/.test(line)) {
                ws.push({ type: "text", text: RegExp.lastMatch });
                line = RegExp.rightContext;
            }
            if (/^[^`'"!><?|\^$&~%*/+\-\w]+/.test(line)) {
                ws.push({ type: "text", text: RegExp.lastMatch });
                line = RegExp.rightContext;
            }
        }
        return ws;
    }
}

顯示WXML

最後只要運行解析器,就能生成 markdown 對應的 json 文件了,而後把json加載到微信小程序的雲數據庫裏面,剩下的顯示就交由小程序完成。下面就是使用 taro 編寫 jsx 顯示部分

<View className='article'>
    {lines.map(l => (
        <Block>
        <View className='line'>
            {l.type.search("h") == 0 && ( <Text className={l.type}>{l.text}</Text> )}
            {l.type == "link" && ( <Navigator className='link' url={l.href}> {l.text} </Navigator> )}
            {l.type == "img" && ( <Image className='pic' mode='widthFix' src={l.src} /> )}
            {l.type == "sl" && ( <Block> 
                <Text decode className='num'> {l.num}.{" "} </Text>
                <TextChild list={l.child} />
            </Block>
            )}
            {l.type == "ul" && ( <Block> 
                <Text decode className='num'> {" "} &bull;{" "} </Text>
                <TextChild list={l.child} />
            </Block>
            )}
            {l.type == "text" && l.child.length && ( <TextChild list={l.child} /> )}
        </View>
        {l.type == "code" && (
            <View className='code'>
            {l.child.map(c => (
                <View className='code-line'>
                {c.type == 'comm' && <Text decode className='comm'> {c.text} </Text>}
                {c.type == 'text' && c.child.map(i => (
                    <Block>
                    {i.type == "comm" && ( <Text decode className='comm'> {i.text} </Text> )}
                    {i.type == "keyword" && ( <Text decode className='keyword'> {i.text} </Text> )}
                    {i.type == "var" && ( <Text decode className='var'> {i.text} </Text> )}
                    {i.type == "fun" && ( <Text decode className='fun'> {i.text} </Text> )}
                    {i.type == "text" && ( <Text decode className='text'> {i.text} </Text> )}
                    </Block>
                ))}
                </View>
            ))}
            </View>
        )}
        </Block>
    ))}
</View>

後記

通過這個項目的磨練,個人正則表達式的能力又上了一個臺階, 連 環視 都已是信手拈來了😄

小程序預覽

jeffblog_weapp.png

相關文章
相關標籤/搜索