Skip to content

feat(experimental-utils): Add types for eslint-scope #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions packages/eslint-plugin/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
{
"extends": "./tsconfig.build.json",
"include": [
"src",
"typings",
// include the parser's ambient typings because the parser exports them in its type defs
"../parser/typings",
"tests",
"tools"
]
"include": ["src", "typings", "tests", "tools"]
}
4 changes: 3 additions & 1 deletion packages/experimental-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
"prebuild": "npm run clean",
"build": "tsc -p tsconfig.build.json",
"clean": "rimraf dist/",
"format": "prettier --write \"./**/*.{ts,js,json,md}\" --ignore-path ../../.prettierignore",
"typecheck": "tsc --noEmit"
},
"dependencies": {
"@typescript-eslint/typescript-estree": "1.9.0"
"@typescript-eslint/typescript-estree": "1.9.0",
"eslint-scope": "^4.0.0"
},
"peerDependencies": {
"eslint": "*",
Expand Down
3 changes: 2 additions & 1 deletion packages/experimental-utils/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import * as ESLintUtils from './eslint-utils';
import * as TSESLint from './ts-eslint';
import * as TSESLintScope from './ts-eslint-scope';

export { ESLintUtils, TSESLint };
export { ESLintUtils, TSESLint, TSESLintScope };

// for convenience's sake - export the types directly from here so consumers
// don't need to reference/install both packages in their code
Expand Down
39 changes: 39 additions & 0 deletions packages/experimental-utils/src/ts-eslint-scope/Definition.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { TSESTree } from '@typescript-eslint/typescript-estree';
import {
Definition as ESLintDefinition,
ParameterDefinition as ESLintParameterDefinition,
} from 'eslint-scope/lib/definition';

interface Definition {
type: string;
name: TSESTree.BindingName;
node: TSESTree.Node;
parent?: TSESTree.Node | null;
index?: number | null;
kind?: string | null;
rest?: boolean;
}
interface DefinitionConstructor {
new (
type: string,
name: TSESTree.BindingName | TSESTree.PropertyName,
node: TSESTree.Node,
parent?: TSESTree.Node | null,
index?: number | null,
kind?: string | null,
): Definition;
}
const Definition = ESLintDefinition as DefinitionConstructor;

// eslint-disable-next-line @typescript-eslint/no-empty-interface
interface ParameterDefinition extends Definition {}
const ParameterDefinition = ESLintParameterDefinition as DefinitionConstructor & {
new (
name: TSESTree.Node,
node: TSESTree.Node,
index?: number | null,
rest?: boolean,
): ParameterDefinition;
};

export { Definition, ParameterDefinition };
21 changes: 21 additions & 0 deletions packages/experimental-utils/src/ts-eslint-scope/Options.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { TSESTree } from '@typescript-eslint/typescript-estree';

type PatternVisitorCallback = (
pattern: TSESTree.Identifier,
info: {
rest: boolean;
topLevel: boolean;
assignments: TSESTree.AssignmentPattern[];
},
) => void;

interface PatternVisitorOptions {
processRightHandNodes?: boolean;
}

interface Visitor {
visitChildren<T extends TSESTree.BaseNode | undefined | null>(node?: T): void;
visit<T extends TSESTree.BaseNode | undefined | null>(node?: T): void;
}

export { PatternVisitorCallback, PatternVisitorOptions, Visitor };
38 changes: 38 additions & 0 deletions packages/experimental-utils/src/ts-eslint-scope/PatternVisitor.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { TSESTree } from '@typescript-eslint/typescript-estree';
import ESLintPatternVisitor from 'eslint-scope/lib/pattern-visitor';
import { ScopeManager } from './ScopeManager';
import {
PatternVisitorCallback,
PatternVisitorOptions,
Visitor,
} from './Options';

interface PatternVisitor extends Visitor {
options: any;
scopeManager: ScopeManager;
parent?: TSESTree.Node;
rightHandNodes: TSESTree.Node[];

Identifier(pattern: TSESTree.Node): void;
Property(property: TSESTree.Node): void;
ArrayPattern(pattern: TSESTree.Node): void;
AssignmentPattern(pattern: TSESTree.Node): void;
RestElement(pattern: TSESTree.Node): void;
MemberExpression(node: TSESTree.Node): void;
SpreadElement(node: TSESTree.Node): void;
ArrayExpression(node: TSESTree.Node): void;
AssignmentExpression(node: TSESTree.Node): void;
CallExpression(node: TSESTree.Node): void;
}
const PatternVisitor = ESLintPatternVisitor as {
new (
options: PatternVisitorOptions,
rootPattern: any,
callback: PatternVisitorCallback,
): PatternVisitor;

// static methods
isPattern(node: TSESTree.Node): boolean;
};

export { PatternVisitor };
27 changes: 27 additions & 0 deletions packages/experimental-utils/src/ts-eslint-scope/Reference.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { TSESTree } from '@typescript-eslint/typescript-estree';
import ESLintReference from 'eslint-scope/lib/reference';
import { Scope } from './Scope';
import { Variable } from './Variable';

interface Reference {
identifier: TSESTree.Identifier;
from: Scope;
resolved: Variable | null;
writeExpr: TSESTree.Node | null;
init: boolean;

isWrite(): boolean;
isRead(): boolean;
isWriteOnly(): boolean;
isReadOnly(): boolean;
isReadWrite(): boolean;
}
const Reference = ESLintReference as {
new (): Reference;

READ: 0x1;
WRITE: 0x2;
RW: 0x3;
};

export { Reference };
80 changes: 80 additions & 0 deletions packages/experimental-utils/src/ts-eslint-scope/Referencer.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import { TSESTree } from '@typescript-eslint/typescript-estree';
import ESLintReferencer from 'eslint-scope/lib/referencer';
import {
PatternVisitorCallback,
PatternVisitorOptions,
Visitor,
} from './Options';
import { Scope } from './Scope';
import { ScopeManager } from './ScopeManager';

interface Referencer<SM extends ScopeManager> extends Visitor {
isInnerMethodDefinition: boolean;
options: any;
scopeManager: SM;
parent?: TSESTree.Node;

currentScope(): Scope;
close(node: TSESTree.Node): void;
pushInnerMethodDefinition(isInnerMethodDefinition: boolean): boolean;
popInnerMethodDefinition(isInnerMethodDefinition: boolean): void;

referencingDefaultValue(
pattern: any,
assignments: any,
maybeImplicitGlobal: any,
init: boolean,
): void;
visitPattern(
node: TSESTree.Node,
options: PatternVisitorOptions,
callback: PatternVisitorCallback,
): void;
visitFunction(node: TSESTree.Node): void;
visitClass(node: TSESTree.Node): void;
visitProperty(node: TSESTree.Node): void;
visitForIn(node: TSESTree.Node): void;
visitVariableDeclaration(
variableTargetScope: any,
type: any,
node: TSESTree.Node,
index: any,
): void;

AssignmentExpression(node: TSESTree.Node): void;
CatchClause(node: TSESTree.Node): void;
Program(node: TSESTree.Node): void;
Identifier(node: TSESTree.Node): void;
UpdateExpression(node: TSESTree.Node): void;
MemberExpression(node: TSESTree.Node): void;
Property(node: TSESTree.Node): void;
MethodDefinition(node: TSESTree.Node): void;
BreakStatement(): void;
ContinueStatement(): void;
LabeledStatement(node: TSESTree.Node): void;
ForStatement(node: TSESTree.Node): void;
ClassExpression(node: TSESTree.Node): void;
ClassDeclaration(node: TSESTree.Node): void;
CallExpression(node: TSESTree.Node): void;
BlockStatement(node: TSESTree.Node): void;
ThisExpression(): void;
WithStatement(node: TSESTree.Node): void;
VariableDeclaration(node: TSESTree.Node): void;
SwitchStatement(node: TSESTree.Node): void;
FunctionDeclaration(node: TSESTree.Node): void;
FunctionExpression(node: TSESTree.Node): void;
ForOfStatement(node: TSESTree.Node): void;
ForInStatement(node: TSESTree.Node): void;
ArrowFunctionExpression(node: TSESTree.Node): void;
ImportDeclaration(node: TSESTree.Node): void;
visitExportDeclaration(node: TSESTree.Node): void;
ExportDeclaration(node: TSESTree.Node): void;
ExportNamedDeclaration(node: TSESTree.Node): void;
ExportSpecifier(node: TSESTree.Node): void;
MetaProperty(): void;
}
const Referencer = ESLintReferencer as {
new <SM extends ScopeManager>(options: any, scopeManager: SM): Referencer<SM>;
};

export { Referencer };
Loading