123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374 |
- "use strict";
- var Module = require("module");
- var path = require("path");
- var t = require("@babel/types");
- function getModules() {
- try {
- // avoid importing a local copy of eslint, try to find a peer dependency
- var eslintLoc = Module._resolveFilename("eslint", module.parent);
- } catch (err) {
- try {
- // avoids breaking in jest where module.parent is undefined
- eslintLoc = require.resolve("eslint");
- } catch (err) {
- throw new ReferenceError("couldn't resolve eslint");
- }
- }
- // get modules relative to what eslint will load
- var eslintMod = new Module(eslintLoc);
- eslintMod.filename = eslintLoc;
- eslintMod.paths = Module._nodeModulePaths(path.dirname(eslintLoc));
- try {
- var escope = eslintMod.require("eslint-scope");
- var Definition = eslintMod.require("eslint-scope/lib/definition")
- .Definition;
- var referencer = eslintMod.require("eslint-scope/lib/referencer");
- } catch (err) {
- escope = eslintMod.require("escope");
- Definition = eslintMod.require("escope/lib/definition").Definition;
- referencer = eslintMod.require("escope/lib/referencer");
- }
- var estraverse = eslintMod.require("estraverse");
- if (referencer.__esModule) referencer = referencer.default;
- return {
- Definition,
- escope,
- estraverse,
- referencer,
- };
- }
- function monkeypatch(modules) {
- var Definition = modules.Definition;
- var escope = modules.escope;
- var estraverse = modules.estraverse;
- var referencer = modules.referencer;
- Object.assign(estraverse.VisitorKeys, t.VISITOR_KEYS);
- estraverse.VisitorKeys.MethodDefinition.push("decorators");
- estraverse.VisitorKeys.Property.push("decorators");
- // if there are decorators, then visit each
- function visitDecorators(node) {
- if (!node.decorators) {
- return;
- }
- for (var i = 0; i < node.decorators.length; i++) {
- if (node.decorators[i].expression) {
- this.visit(node.decorators[i]);
- }
- }
- }
- // iterate through part of t.VISITOR_KEYS
- var flowFlippedAliasKeys = t.FLIPPED_ALIAS_KEYS.Flow.concat([
- "ArrayPattern",
- "ClassDeclaration",
- "ClassExpression",
- "FunctionDeclaration",
- "FunctionExpression",
- "Identifier",
- "ObjectPattern",
- "RestElement",
- ]);
- var visitorKeysMap = Object.keys(t.VISITOR_KEYS).reduce(function(acc, key) {
- var value = t.VISITOR_KEYS[key];
- if (flowFlippedAliasKeys.indexOf(value) === -1) {
- acc[key] = value;
- }
- return acc;
- }, {});
- var propertyTypes = {
- // loops
- callProperties: { type: "loop", values: ["value"] },
- indexers: { type: "loop", values: ["key", "value"] },
- properties: { type: "loop", values: ["argument", "value"] },
- types: { type: "loop" },
- params: { type: "loop" },
- // single property
- argument: { type: "single" },
- elementType: { type: "single" },
- qualification: { type: "single" },
- rest: { type: "single" },
- returnType: { type: "single" },
- // others
- typeAnnotation: { type: "typeAnnotation" },
- typeParameters: { type: "typeParameters" },
- id: { type: "id" },
- };
- function visitTypeAnnotation(node) {
- // get property to check (params, id, etc...)
- var visitorValues = visitorKeysMap[node.type];
- if (!visitorValues) {
- return;
- }
- // can have multiple properties
- for (var i = 0; i < visitorValues.length; i++) {
- var visitorValue = visitorValues[i];
- var propertyType = propertyTypes[visitorValue];
- var nodeProperty = node[visitorValue];
- // check if property or type is defined
- if (propertyType == null || nodeProperty == null) {
- continue;
- }
- if (propertyType.type === "loop") {
- for (var j = 0; j < nodeProperty.length; j++) {
- if (Array.isArray(propertyType.values)) {
- for (var k = 0; k < propertyType.values.length; k++) {
- var loopPropertyNode = nodeProperty[j][propertyType.values[k]];
- if (loopPropertyNode) {
- checkIdentifierOrVisit.call(this, loopPropertyNode);
- }
- }
- } else {
- checkIdentifierOrVisit.call(this, nodeProperty[j]);
- }
- }
- } else if (propertyType.type === "single") {
- checkIdentifierOrVisit.call(this, nodeProperty);
- } else if (propertyType.type === "typeAnnotation") {
- visitTypeAnnotation.call(this, node.typeAnnotation);
- } else if (propertyType.type === "typeParameters") {
- for (var l = 0; l < node.typeParameters.params.length; l++) {
- checkIdentifierOrVisit.call(this, node.typeParameters.params[l]);
- }
- } else if (propertyType.type === "id") {
- if (node.id.type === "Identifier") {
- checkIdentifierOrVisit.call(this, node.id);
- } else {
- visitTypeAnnotation.call(this, node.id);
- }
- }
- }
- }
- function checkIdentifierOrVisit(node) {
- if (node.typeAnnotation) {
- visitTypeAnnotation.call(this, node.typeAnnotation);
- } else if (node.type === "Identifier") {
- this.visit(node);
- } else {
- visitTypeAnnotation.call(this, node);
- }
- }
- function nestTypeParamScope(manager, node) {
- var parentScope = manager.__currentScope;
- var scope = new escope.Scope(
- manager,
- "type-parameters",
- parentScope,
- node,
- false
- );
- manager.__nestScope(scope);
- for (var j = 0; j < node.typeParameters.params.length; j++) {
- var name = node.typeParameters.params[j];
- scope.__define(name, new Definition("TypeParameter", name, name));
- if (name.typeAnnotation) {
- checkIdentifierOrVisit.call(this, name);
- }
- }
- scope.__define = function() {
- return parentScope.__define.apply(parentScope, arguments);
- };
- return scope;
- }
- // visit decorators that are in: ClassDeclaration / ClassExpression
- var visitClass = referencer.prototype.visitClass;
- referencer.prototype.visitClass = function(node) {
- visitDecorators.call(this, node);
- var typeParamScope;
- if (node.typeParameters) {
- typeParamScope = nestTypeParamScope.call(this, this.scopeManager, node);
- }
- // visit flow type: ClassImplements
- if (node.implements) {
- for (var i = 0; i < node.implements.length; i++) {
- checkIdentifierOrVisit.call(this, node.implements[i]);
- }
- }
- if (node.superTypeParameters) {
- for (var k = 0; k < node.superTypeParameters.params.length; k++) {
- checkIdentifierOrVisit.call(this, node.superTypeParameters.params[k]);
- }
- }
- visitClass.call(this, node);
- if (typeParamScope) {
- this.close(node);
- }
- };
- // visit decorators that are in: Property / MethodDefinition
- var visitProperty = referencer.prototype.visitProperty;
- referencer.prototype.visitProperty = function(node) {
- if (node.value && node.value.type === "TypeCastExpression") {
- visitTypeAnnotation.call(this, node.value);
- }
- visitDecorators.call(this, node);
- visitProperty.call(this, node);
- };
- function visitClassProperty(node) {
- if (node.typeAnnotation) {
- visitTypeAnnotation.call(this, node.typeAnnotation);
- }
- this.visitProperty(node);
- }
- // visit ClassProperty as a Property.
- referencer.prototype.ClassProperty = visitClassProperty;
- // visit ClassPrivateProperty as a Property.
- referencer.prototype.ClassPrivateProperty = visitClassProperty;
- // visit OptionalMemberExpression as a MemberExpression.
- referencer.prototype.OptionalMemberExpression =
- referencer.prototype.MemberExpression;
- // visit flow type in FunctionDeclaration, FunctionExpression, ArrowFunctionExpression
- var visitFunction = referencer.prototype.visitFunction;
- referencer.prototype.visitFunction = function(node) {
- var typeParamScope;
- if (node.typeParameters) {
- typeParamScope = nestTypeParamScope.call(this, this.scopeManager, node);
- }
- if (node.returnType) {
- checkIdentifierOrVisit.call(this, node.returnType);
- }
- // only visit if function parameters have types
- if (node.params) {
- for (var i = 0; i < node.params.length; i++) {
- var param = node.params[i];
- if (param.typeAnnotation) {
- checkIdentifierOrVisit.call(this, param);
- } else if (t.isAssignmentPattern(param)) {
- if (param.left.typeAnnotation) {
- checkIdentifierOrVisit.call(this, param.left);
- }
- }
- }
- }
- // set ArrayPattern/ObjectPattern visitor keys back to their original. otherwise
- // escope will traverse into them and include the identifiers within as declarations
- estraverse.VisitorKeys.ObjectPattern = ["properties"];
- estraverse.VisitorKeys.ArrayPattern = ["elements"];
- visitFunction.call(this, node);
- // set them back to normal...
- estraverse.VisitorKeys.ObjectPattern = t.VISITOR_KEYS.ObjectPattern;
- estraverse.VisitorKeys.ArrayPattern = t.VISITOR_KEYS.ArrayPattern;
- if (typeParamScope) {
- this.close(node);
- }
- };
- // visit flow type in VariableDeclaration
- var variableDeclaration = referencer.prototype.VariableDeclaration;
- referencer.prototype.VariableDeclaration = function(node) {
- if (node.declarations) {
- for (var i = 0; i < node.declarations.length; i++) {
- var id = node.declarations[i].id;
- var typeAnnotation = id.typeAnnotation;
- if (typeAnnotation) {
- checkIdentifierOrVisit.call(this, typeAnnotation);
- }
- }
- }
- variableDeclaration.call(this, node);
- };
- function createScopeVariable(node, name) {
- this.currentScope().variableScope.__define(
- name,
- new Definition("Variable", name, node, null, null, null)
- );
- }
- referencer.prototype.InterfaceDeclaration = function(node) {
- createScopeVariable.call(this, node, node.id);
- var typeParamScope;
- if (node.typeParameters) {
- typeParamScope = nestTypeParamScope.call(this, this.scopeManager, node);
- }
- // TODO: Handle mixins
- for (var i = 0; i < node.extends.length; i++) {
- visitTypeAnnotation.call(this, node.extends[i]);
- }
- visitTypeAnnotation.call(this, node.body);
- if (typeParamScope) {
- this.close(node);
- }
- };
- referencer.prototype.TypeAlias = function(node) {
- createScopeVariable.call(this, node, node.id);
- var typeParamScope;
- if (node.typeParameters) {
- typeParamScope = nestTypeParamScope.call(this, this.scopeManager, node);
- }
- if (node.right) {
- visitTypeAnnotation.call(this, node.right);
- }
- if (typeParamScope) {
- this.close(node);
- }
- };
- referencer.prototype.DeclareModule = referencer.prototype.DeclareFunction = referencer.prototype.DeclareVariable = referencer.prototype.DeclareClass = function(
- node
- ) {
- if (node.id) {
- createScopeVariable.call(this, node, node.id);
- }
- var typeParamScope;
- if (node.typeParameters) {
- typeParamScope = nestTypeParamScope.call(this, this.scopeManager, node);
- }
- if (typeParamScope) {
- this.close(node);
- }
- };
- referencer._babelEslintPatched = true;
- }
- // To patch for each call.
- var escope = null;
- var escopeAnalyze = null;
- module.exports = function(parserOptions) {
- // Patch `Referencer.prototype` once.
- if (!escope) {
- const modules = getModules();
- monkeypatch(modules);
- // Store to patch for each call.
- escope = modules.escope;
- escopeAnalyze = modules.escope.analyze;
- }
- // Patch `escope.analyze` based on the current parserOptions.
- escope.analyze = function(ast, opts) {
- opts = opts || {};
- opts.ecmaVersion = parserOptions.ecmaVersion;
- opts.sourceType = parserOptions.sourceType;
- opts.nodejsScope =
- ast.sourceType === "script" &&
- (parserOptions.ecmaFeatures &&
- parserOptions.ecmaFeatures.globalReturn) === true;
- return escopeAnalyze.call(this, ast, opts);
- };
- };
|