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)。 這會影響嚴(yán)格模式种柑、保留字集合岗仑、和新的語法特征支持。 默認(rèn)版本為7(ES6)聚请。
    注意:只有“stage4”(finalized)ECMAScript功能正在被Acorn實(shí)現(xiàn)荠雕。

  • sourceType 指定代碼應(yīng)該被解析的模式∈簧停可以是scriptmodule炸卑。 這將影響全局的嚴(yán)格模式,和解析 importexport的聲明煤傍。

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

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

  • 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)行檢查或處理; 您可以隨意使用您選擇的任何格式义辕。

  • directSourceFilesourceFile一樣,但是一個(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');
image.png

在 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的對象脱拼,該對象最終在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)系作者
  • 序言:七十年代末省撑,一起剝皮案震驚了整個(gè)濱河市赌蔑,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌竟秫,老刑警劉巖娃惯,帶你破解...
    沈念sama閱讀 217,907評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異肥败,居然都是意外死亡趾浅,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評論 3 395
  • 文/潘曉璐 我一進(jìn)店門馒稍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來皿哨,“玉大人,你說我怎么就攤上這事纽谒≈づ颍” “怎么了?”我有些...
    開封第一講書人閱讀 164,298評論 0 354
  • 文/不壞的土叔 我叫張陵鼓黔,是天一觀的道長央勒。 經(jīng)常有香客問我,道長澳化,這世上最難降的妖魔是什么崔步? 我笑而不...
    開封第一講書人閱讀 58,586評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮缎谷,結(jié)果婚禮上刷晋,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好眼虱,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,633評論 6 392
  • 文/花漫 我一把揭開白布喻奥。 她就那樣靜靜地躺著,像睡著了一般捏悬。 火紅的嫁衣襯著肌膚如雪撞蚕。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,488評論 1 302
  • 那天过牙,我揣著相機(jī)與錄音甥厦,去河邊找鬼。 笑死寇钉,一個(gè)胖子當(dāng)著我的面吹牛刀疙,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播扫倡,決...
    沈念sama閱讀 40,275評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼谦秧,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了撵溃?” 一聲冷哼從身側(cè)響起疚鲤,我...
    開封第一講書人閱讀 39,176評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎缘挑,沒想到半個(gè)月后集歇,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,619評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡语淘,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,819評論 3 336
  • 正文 我和宋清朗相戀三年诲宇,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片惶翻。...
    茶點(diǎn)故事閱讀 39,932評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡姑蓝,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出维贺,到底是詐尸還是另有隱情它掂,我是刑警寧澤巴帮,帶...
    沈念sama閱讀 35,655評論 5 346
  • 正文 年R本政府宣布溯泣,位于F島的核電站,受9級特大地震影響榕茧,放射性物質(zhì)發(fā)生泄漏垃沦。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,265評論 3 329
  • 文/蒙蒙 一用押、第九天 我趴在偏房一處隱蔽的房頂上張望肢簿。 院中可真熱鬧,春花似錦、人聲如沸池充。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽收夸。三九已至坑匠,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間卧惜,已是汗流浹背厘灼。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留咽瓷,地道東北人设凹。 一個(gè)月前我還...
    沈念sama閱讀 48,095評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像茅姜,于是被迫代替她去往敵國和親闪朱。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,884評論 2 354

推薦閱讀更多精彩內(nèi)容