JavascriptParser 钩子

在compiler中找到的parser实例用于解析webpack处理的每个模块。parser是另一个扩展了tapable的webpack类，它提供了多种tapable钩子，插件作者可以使用这些钩子来自定义解析过程。

parser位于NormalModuleFactory内部，因此访问它需要额外的工作。

compiler.hooks.normalModuleFactory.tap('MyPlugin', (factory) => {
  factory.hooks.parser
    .for('javascript/auto')
    .tap('MyPlugin', (parser, options) => {
      parser.hooks.someHook.tap(/* ... */);
    });
});

与编译器一样，tapAsync 和 tapPromise 也可能可用，具体取决于钩子的类型。

钩子

parser暴露了以下生命周期钩子，可以通过以下方式访问它们

evaluateTypeof

SyncBailHook

当评估一个包含自由变量的typeof表达式时触发

• 钩子参数: identifier
• 回调参数: expression

parser.hooks.evaluateTypeof
  .for('myIdentifier')
  .tap('MyPlugin', (expression) => {
    /* ... */
    return expressionResult;
  });

这将触发evaluateTypeof钩子

const a = typeof myIdentifier;

这不会触发

const myIdentifier = 0;
const b = typeof myIdentifier;

evaluate

SyncBailHook

在评估表达式时调用。

• 钩子参数: expressionType
• 回调参数: expression

例如

index.js

const a = new String();

MyPlugin.js

parser.hooks.evaluate.for('NewExpression').tap('MyPlugin', (expression) => {
  /* ... */
  return expressionResult;
});

其中表达式类型包括

• 'ArrowFunctionExpression'
• 'AssignmentExpression'
• 'AwaitExpression'
• 'BinaryExpression'
• 'CallExpression'
• 'ClassExpression'
• 'ConditionalExpression'
• 'FunctionExpression'
• 'Identifier'
• 'LogicalExpression'
• 'MemberExpression'
• 'NewExpression'
• 'ObjectExpression'
• 'SequenceExpression'
• 'SpreadElement'
• 'TaggedTemplateExpression'
• 'TemplateLiteral'
• 'ThisExpression'
• 'UnaryExpression'
• 'UpdateExpression'

evaluateIdentifier

SyncBailHook

在评估作为自由变量的标识符时调用。

• 钩子参数: identifier
• 回调参数: expression

evaluateDefinedIdentifier

SyncBailHook

在评估作为已定义变量的标识符时调用。

• 钩子参数: identifier
• 回调参数: expression

evaluateCallExpressionMember

SyncBailHook

在评估成功评估的表达式的成员函数调用时调用。

• 钩子参数: identifier
• 回调参数: expression param

此表达式将触发钩子

index.js

const a = expression.myFunc();

MyPlugin.js

parser.hooks.evaluateCallExpressionMember
  .for('myFunc')
  .tap('MyPlugin', (expression, param) => {
    /* ... */
    return expressionResult;
  });

statement

SyncBailHook

一个通用钩子，用于代码片段中每个解析的语句。

• 回调参数: statement

parser.hooks.statement.tap('MyPlugin', (statement) => {
  /* ... */
});

其中statement.type可以是

• 'BlockStatement'
• 'VariableDeclaration'
• 'FunctionDeclaration'
• 'ReturnStatement'
• 'ClassDeclaration'
• 'ExpressionStatement'
• 'ImportDeclaration'
• 'ExportAllDeclaration'
• 'ExportDefaultDeclaration'
• 'ExportNamedDeclaration'
• 'IfStatement'
• 'SwitchStatement'
• 'ForInStatement'
• 'ForOfStatement'
• 'ForStatement'
• 'WhileStatement'
• 'DoWhileStatement'
• 'ThrowStatement'
• 'TryStatement'
• 'LabeledStatement'
• 'WithStatement'

statementIf

SyncBailHook

在解析if语句时调用。与statement钩子相同，但仅当statement.type == 'IfStatement'时触发。

• 回调参数: statement

label

SyncBailHook

在解析带有label的语句时调用。这些语句的statement.type === 'LabeledStatement'。

• 钩子参数: labelName
• 回调参数: statement

import

SyncBailHook

为代码片段中的每个import语句调用。source参数包含导入文件的名称。

• 回调参数: statement source

以下import语句将触发钩子一次

index.js

import _ from 'lodash';

MyPlugin.js

parser.hooks.import.tap('MyPlugin', (statement, source) => {
  // source == 'lodash'
});

importSpecifier

SyncBailHook

为每个import语句的每个说明符调用。

• 回调参数: statement source exportName identifierName

以下import语句将触发钩子两次

index.js

import _, { has } from 'lodash';

MyPlugin.js

parser.hooks.importSpecifier.tap(
  'MyPlugin',
  (statement, source, exportName, identifierName) => {
    /* First call
    source == 'lodash'
    exportName == 'default'
    identifierName == '_'
  */
    /* Second call
    source == 'lodash'
    exportName == 'has'
    identifierName == 'has'
  */
  }
);

export

SyncBailHook

为代码片段中的每个export语句调用。

• 回调参数: statement

exportImport

SyncBailHook

为每个export-import语句（例如：export * from 'otherModule';）调用。

• 回调参数: statement source

exportDeclaration

SyncBailHook

为每个导出声明的export语句调用。

• 回调参数: statement declaration

这些导出将触发此钩子

export const myVar = 'hello'; // also var, let
export function FunctionName() {}
export class ClassName {}

exportExpression

SyncBailHook

为每个导出表达式的export语句（例如export default expression;）调用。

• 回调参数: statement declaration

exportSpecifier

SyncBailHook

为每个export语句的每个说明符调用。

• 回调参数: statement identifierName exportName index

exportImportSpecifier

SyncBailHook

为每个export-import语句的每个说明符调用。

• 回调参数: statement source identifierName exportName index

varDeclaration

SyncBailHook

在解析变量声明时调用。

• 回调参数: declaration

varDeclarationLet

SyncBailHook

在解析使用let定义的变量声明时调用

• 回调参数: declaration

varDeclarationConst

SyncBailHook

在解析使用const定义的变量声明时调用

• 回调参数: declaration

varDeclarationVar

SyncBailHook

在解析使用var定义的变量声明时调用

• 回调参数: declaration

canRename

SyncBailHook

在重命名标识符之前触发，以确定是否允许重命名。这通常与rename钩子一起使用。

• 钩子参数: identifier
• 回调参数: expression

var a = b;

parser.hooks.canRename.for('b').tap('MyPlugin', (expression) => {
  // returning true allows renaming
  return true;
});

rename

SyncBailHook

在重命名时触发，以获取新的标识符。此钩子仅当canRename返回true时才会被调用。

• 钩子参数: identifier
• 回调参数: expression

var a = b;

parser.hooks.rename.for('b').tap('MyPlugin', (expression) => {});

assigned

SyncBailHook

在解析AssignmentExpression之前，先解析被赋值的表达式时调用。

• 钩子参数: identifier
• 回调参数: expression

a += b;

parser.hooks.assigned.for('a').tap('MyPlugin', (expression) => {
  // this is called before parsing b
});

assign

SyncBailHook

在解析AssignmentExpression之前，先解析赋值表达式时调用。

• 钩子参数: identifier
• 回调参数: expression

a += b;

parser.hooks.assigned.for('a').tap('MyPlugin', (expression) => {
  // this is called before parsing a
});

typeof

SyncBailHook

在解析标识符的typeof时触发

• 钩子参数: identifier
• 回调参数: expression

call

SyncBailHook

在解析函数调用时调用。

• 钩子参数: identifier
• 回调参数: expression

eval(/* something */);

parser.hooks.call.for('eval').tap('MyPlugin', (expression) => {});

callMemberChain

SyncBailHook

在解析对对象成员函数的调用时触发。

• 钩子参数: objectIdentifier
• 回调参数: expression, properties

myObj.anyFunc();

parser.hooks.callMemberChain
  .for('myObj')
  .tap('MyPlugin', (expression, properties) => {});

new

SyncBailHook

在解析new表达式时调用。

• 钩子参数: identifier
• 回调参数: expression

new MyClass();

parser.hooks.new.for('MyClass').tap('MyPlugin', (expression) => {});

expression

SyncBailHook

在解析表达式时调用。

• 钩子参数: identifier
• 回调参数: expression

const a = this;

parser.hooks.expression.for('this').tap('MyPlugin', (expression) => {});

expressionConditionalOperator

SyncBailHook

在解析ConditionalExpression（例如condition ? a : b）时调用

• 回调参数: expression

program

SyncBailHook

访问代码片段的抽象语法树（AST）

• 参数: ast comments