acorn.js介紹

一個(gè)用JavaScript編寫的,小巧、快速的JavaScript解析器。

當(dāng)在CommonJS(node.js)或AMD環(huán)境中運(yùn)行時(shí),可直接使用require或import導(dǎo)入。 在瀏覽器中加載時(shí)(Acorn可以在任何啟用JS的瀏覽器中使用,支持IE5以上),無需任何類型的模塊管理,將定義單個(gè)全局對象acorn,并將所有導(dǎo)出的屬性添加到該對象中。

Main parser

parse(input, options) 這個(gè)函數(shù)用來解析JavaScript代碼,返回值將是由ESTree規(guī)范指定的抽象語法樹對象。input為string類型參數(shù)(即js代碼),options可以為undefined或者是如下的值:

  • ecmaVersion 指定要解析的ECMAScript版本。 必須是3,5,6(2015),7(2016)或8(2017)。 這會(huì)影響嚴(yán)格模式、保留字集合、和新的語法特征支持。 默認(rèn)版本為7(ES6)。
    注意:只有“stage4”(finalized)ECMAScript功能正在被Acorn實(shí)現(xiàn)。

  • sourceType 指定代碼應(yīng)該被解析的模式??梢允?code>script或module。 這將影響全局的嚴(yán)格模式,和解析 importexport的聲明。

  • onInsertedSemicolon 如果有回調(diào)函數(shù),則只要解析器插入了一個(gè)缺少的分號(hào),就會(huì)調(diào)用該回調(diào)函數(shù)。 回調(diào)函數(shù)將被賦予插入分號(hào)的點(diǎn)的字符偏移量作為參數(shù),如果locations被設(shè)置,則表示此位置的{line,column}對象。

  • onTrailingCommaonInsertedSemicolon,但是為了跟蹤逗號(hào)插入。

  • allowReserved 如果為false,則使用保留字會(huì)產(chǎn)生錯(cuò)誤。 對于ecmaVersion 3,默認(rèn)為true,對于較高版本,默認(rèn)為false。 當(dāng)value為never時(shí),保留字和關(guān)鍵字也不能用作屬性名稱(如IE低版本瀏覽器)

  • allowReturnOutsideFunction 默認(rèn)情況下,頂層的return語句會(huì)引發(fā)錯(cuò)誤。 將其設(shè)置為true以接受此類代碼。

  • allowImportExportEverywhere 默認(rèn)情況下,導(dǎo)入和導(dǎo)出聲明只能顯示在程序的頂層。 將此選項(xiàng)設(shè)置為true可以允許在允許語句的任何地方

  • allowHashBang 啟用此功能(默認(rèn)情況下關(guān)閉),如果代碼以#! 開始(如在shellscript中),第一行將被視為注釋。

  • locations 當(dāng)為true時(shí),每個(gè)Node都有一個(gè)連接起始和終止子對象的loc對象,每個(gè)對象包含{line,column}形式的一個(gè)行號(hào)和列號(hào)。 默認(rèn)值為false。

  • onToken 如果為此選項(xiàng)傳遞了一個(gè)函數(shù),則每個(gè)發(fā)現(xiàn)的token將以與從tokenizer() getToken()返回的tokens相同的格式傳遞。
    如果參數(shù)是array,則每個(gè)發(fā)現(xiàn)的token將被push到array中。
    注意不能從回調(diào)中調(diào)用解析器,從而破壞其內(nèi)部狀態(tài)。

  • onComment 如果為此選項(xiàng)傳遞函數(shù),每當(dāng)遇到注釋時(shí),將使用以下參數(shù)調(diào)用該函數(shù):

    • block:如果注釋是塊注釋,則為true,如果是行注釋,則為false。
    • text:評(píng)論的內(nèi)容。
    • start:注釋開頭的字符偏移量。
    • end:注釋結(jié)尾的字符偏移量。
      當(dāng)locations參數(shù)被設(shè)置時(shí),注釋的開始和結(jié)束位置{line,column}將作為
      兩個(gè)附加參數(shù)傳遞。
      當(dāng)此選項(xiàng)是array時(shí),每個(gè)注釋被push到它作為對象以Esprima格式:
{
  "type": "Line" | "Block",
  "value": "comment text",
  "start": Number,
  "end": Number,
  // If `locations` option is on:
  "loc": {
     "start": {line: Number, column: Number}
     "end": {line: Number, column: Number}
   },
  // If `ranges` option is on:
  "range": [Number, Number]
}

請注意,您不能從回調(diào)函數(shù)中調(diào)用解析器,從而破壞其內(nèi)部狀態(tài)。

  • ranges 節(jié)點(diǎn)的起始和終止字符偏移記錄在起始和結(jié)束屬性中(直接在節(jié)點(diǎn)上,而不是保存行/列數(shù)據(jù)的loc對象),還要添加一個(gè)保持[start,end]數(shù)組的半標(biāo)準(zhǔn)化范圍屬性, 使用相同的數(shù)字,將ranges設(shè)置為true

  • program 通過解析第一個(gè)文件生成的樹, 作為后續(xù)解析中的程序選項(xiàng)傳遞多個(gè)文件,可以將多個(gè)文件解析為單個(gè)AST。 會(huì)將已解析的文件以toplevel形式添加到現(xiàn)有解析樹的“Program”(program即頂部節(jié)點(diǎn))節(jié)點(diǎn)。

  • sourceFile 當(dāng)locations選項(xiàng)為true時(shí),您可以傳遞此選項(xiàng)以在每個(gè)節(jié)點(diǎn)的loc對象中添加一個(gè)源屬性。 請注意,此選項(xiàng)的內(nèi)容不以任何方式進(jìn)行檢查或處理; 您可以隨意使用您選擇的任何格式。

  • directSourceFilesourceFile一樣,但是一個(gè)sourceFile屬性將直接添加到節(jié)點(diǎn),而不是loc對象。

  • preserveParens 如果此選項(xiàng)為true,則括號(hào)表達(dá)式由(非標(biāo)準(zhǔn))括號(hào)化表達(dá)式節(jié)點(diǎn)表示,該節(jié)點(diǎn)具有包含括號(hào)內(nèi)的表達(dá)式的單個(gè)表達(dá)式屬性。

parseExpressionAt(input, offset, options)

將解析字符串中的單個(gè)表達(dá)式,并返回其AST。 如果表達(dá)式之后還有更多的字符串,不會(huì)去解析。

getLineInfo(input, offset)

可用于獲取給定程序字符串和字符偏移量的{line,column}對象。

tokenizer(input, options)

返回具有g(shù)etToken方法的對象,該方法可以重復(fù)調(diào)用以獲取下一個(gè)token和{start,end,type,value}對象(啟用了location選項(xiàng)時(shí)添加了loc屬性,并且啟用了range選項(xiàng)時(shí)的range屬性)。 當(dāng)令牌的類型為tokTypes.eof時(shí),您應(yīng)該停止調(diào)用該方法,因?yàn)樗鼘⒂肋h(yuǎn)返回相同的token。

var a = require('./a.js');
image.png

在 type 對應(yīng)的對象中,label 表示當(dāng)前標(biāo)識(shí)的一個(gè)類型,keyword 就是關(guān)鍵詞,像例子中的require,或者 function 之類的。
value 則是當(dāng)前標(biāo)識(shí)的值,start/end 分別是開始和結(jié)束的位置。

更多type解釋https://segmentfault.com/a/1190000007473065

在ES6環(huán)境中,返回的結(jié)果可以用作任何其他符合協(xié)議的迭代:

for (let token of acorn.tokenizer(str)) {
  // iterate over the tokens
}

// transform code to array of tokens:
var tokens = [...acorn.tokenizer(str)];

tokTypes擁有將name映射到token object的對象,該對象最終在tokentype屬性中。

using with Escodegen
Escodegen支持從AST生成注釋,附加在特定于Esprima-specific的格式。 為了在Acorn中模擬相同的格式,請考慮以下示例:

var comments = [], tokens = [];

var ast = acorn.parse('var x = 42; // answer', {
    // collect ranges for each node
    ranges: true,
    // collect comments in Esprima's format
    onComment: comments,
    // collect token ranges
    onToken: tokens
});

// attach comments using collected information
escodegen.attachComments(ast, comments, tokens);

// generate code
console.log(escodegen.generate(ast, {comment: true}));
// > 'var x = 42;    // answer'
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容