acorn.js介紹

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

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

Main parser

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

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

  • sourceType 指定代碼應該被解析的模式。可以是scriptmodule。 這將影響全局的嚴格模式,和解析 importexport的聲明。

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

  • onTrailingCommaonInsertedSemicolon,但是為了跟蹤逗號插入。

  • allowReserved 如果為false,則使用保留字會產生錯誤。 對于ecmaVersion 3,默認為true,對于較高版本,默認為false。 當value為never時,保留字和關鍵字也不能用作屬性名稱(如IE低版本瀏覽器)

  • allowReturnOutsideFunction 默認情況下,頂層的return語句會引發錯誤。 將其設置為true以接受此類代碼。

  • allowImportExportEverywhere 默認情況下,導入和導出聲明只能顯示在程序的頂層。 將此選項設置為true可以允許在允許語句的任何地方

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

  • locations 當為true時,每個Node都有一個連接起始和終止子對象的loc對象,每個對象包含{line,column}形式的一個行號和列號。 默認值為false。

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

  • onComment 如果為此選項傳遞函數,每當遇到注釋時,將使用以下參數調用該函數:

    • block:如果注釋是塊注釋,則為true,如果是行注釋,則為false。
    • text:評論的內容。
    • start:注釋開頭的字符偏移量。
    • end:注釋結尾的字符偏移量。
      locations參數被設置時,注釋的開始和結束位置{line,column}將作為
      兩個附加參數傳遞。
      當此選項是array時,每個注釋被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]
}

請注意,您不能從回調函數中調用解析器,從而破壞其內部狀態。

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

  • program 通過解析第一個文件生成的樹, 作為后續解析中的程序選項傳遞多個文件,可以將多個文件解析為單個AST。 會將已解析的文件以toplevel形式添加到現有解析樹的“Program”(program即頂部節點)節點。

  • sourceFilelocations選項為true時,您可以傳遞此選項以在每個節點的loc對象中添加一個源屬性。 請注意,此選項的內容不以任何方式進行檢查或處理; 您可以隨意使用您選擇的任何格式。

  • directSourceFilesourceFile一樣,但是一個sourceFile屬性將直接添加到節點,而不是loc對象。

  • preserveParens 如果此選項為true,則括號表達式由(非標準)括號化表達式節點表示,該節點具有包含括號內的表達式的單個表達式屬性。

parseExpressionAt(input, offset, options)

將解析字符串中的單個表達式,并返回其AST。 如果表達式之后還有更多的字符串,不會去解析。

getLineInfo(input, offset)

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

tokenizer(input, options)

返回具有getToken方法的對象,該方法可以重復調用以獲取下一個token和{start,end,type,value}對象(啟用了location選項時添加了loc屬性,并且啟用了range選項時的range屬性)。 當令牌的類型為tokTypes.eof時,您應該停止調用該方法,因為它將永遠返回相同的token。

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

在 type 對應的對象中,label 表示當前標識的一個類型,keyword 就是關鍵詞,像例子中的require,或者 function 之類的。
value 則是當前標識的值,start/end 分別是開始和結束的位置。

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

在ES6環境中,返回的結果可以用作任何其他符合協議的迭代:

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'
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容