一個(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)。 這會影響嚴(yán)格模式种柑、保留字集合岗仑、和新的語法特征支持。 默認(rèn)版本為7(ES6)聚请。
注意:只有“stage4”(finalized)ECMAScript功能正在被Acorn實(shí)現(xiàn)荠雕。sourceType 指定代碼應(yīng)該被解析的模式∈簧停可以是
script
或module
炸卑。 這將影響全局的嚴(yán)格模式,和解析import
和export
的聲明煤傍。onInsertedSemicolon 如果有回調(diào)函數(shù)盖文,則只要解析器插入了一個(gè)缺少的分號,就會調(diào)用該回調(diào)函數(shù)蚯姆。 回調(diào)函數(shù)將被賦予插入分號的點(diǎn)的字符偏移量作為參數(shù)五续,如果
locations
被設(shè)置洒敏,則表示此位置的{line,column}對象返帕。onTrailingComma 像
onInsertedSemicolon
桐玻,但是為了跟蹤逗號插入。allowReserved 如果為
false
荆萤,則使用保留字會產(chǎn)生錯誤镊靴。 對于ecmaVersion 3,默認(rèn)為true
链韭,對于較高版本偏竟,默認(rèn)為false
。 當(dāng)value為never
時(shí)敞峭,保留字和關(guān)鍵字也不能用作屬性名稱(如IE低版本瀏覽器)allowReturnOutsideFunction 默認(rèn)情況下踊谋,頂層的return語句會引發(fā)錯誤。 將其設(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è)行號和列號葫松。 默認(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:評論的內(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。 會將已解析的文件以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)行檢查或處理; 您可以隨意使用您選擇的任何格式义辕。directSourceFile 像
sourceFile
一樣,但是一個(gè)sourceFile
屬性將直接添加到節(jié)點(diǎn)酿联,而不是loc
對象。preserveParens 如果此選項(xiàng)為
true
夺巩,則括號表達(dá)式由(非標(biāo)準(zhǔn))括號化表達(dá)式節(jié)點(diǎn)表示贞让,該節(jié)點(diǎn)具有包含括號內(nèi)的表達(dá)式的單個(gè)表達(dá)式屬性。
parseExpressionAt(input, offset, options)
將解析字符串中的單個(gè)表達(dá)式柳譬,并返回其AST喳张。 如果表達(dá)式之后還有更多的字符串,不會去解析美澳。
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');
在 type 對應(yīng)的對象中,label 表示當(dāng)前標(biāo)識的一個(gè)類型狰右,keyword 就是關(guān)鍵詞杰捂,像例子中的require,或者 function 之類的棋蚌。
value 則是當(dāng)前標(biāo)識的值嫁佳,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
的對象脱拼,該對象最終在token
的type
屬性中。
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'