Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: improve token types and add missing type guards #1497

Merged
merged 8 commits into from Jan 24, 2020
Merged

fix: improve token types and add missing type guards #1497

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ed9e41c
feat: improve token types and add missing type guards
armano2 Jan 22, 2020
d245d9a
fix: add better type-guards for eslint-utils
armano2 Jan 22, 2020
3c3dee4
fix: simplify computation of return type from options
armano2 Jan 23, 2020
da69d34
fix: correct typo in isNotCommentToken
armano2 Jan 23, 2020
e9cbe19
Merge branch 'master' into type-improvement
armano2 Jan 23, 2020
552a5d7
fix(eslint-plugin): remove unnecessary type casting
armano2 Jan 23, 2020
0d45972
chore(eslint-plugin): remove one more type cast
armano2 Jan 23, 2020
499c705
chore: add missing type guards to astUtils
armano2 Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
View file
Open in desktop
Expand Up @@ -4,5 +4,6 @@ jest.config.js
fixtures
shared-fixtures
coverage
__snapshots__

packages/eslint-plugin-tslint/tests
8 changes: 4 additions & 4 deletions packages/eslint-plugin/typings/eslint-utils.d.ts
View file
Open in desktop
Expand Up @@ -149,10 +149,10 @@ declare module 'eslint-utils' {
): boolean;
export function isCommentToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isNotCommentToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
): token is TSESTree.Comment;
export function isNotCommentToken<T extends TSESTree.Token>(
token: T,
): token is Exclude<T, TSESTree.Comment>;
export function isOpeningBraceToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
Expand Down
115 changes: 70 additions & 45 deletions packages/experimental-utils/src/ts-eslint/SourceCode.ts
View file
Open in desktop
Expand Up @@ -49,83 +49,108 @@ declare interface SourceCode {
// Inherited methods from TokenStore
// ---------------------------------

getTokenByRangeStart(
getTokenByRangeStart<T extends { includeComments?: boolean }>(
offset: number,
options?: { includeComments?: boolean },
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getFirstToken(
getFirstToken<T extends SourceCode.CursorWithSkipOptions>(
node: TSESTree.Node,
options?: SourceCode.CursorWithSkipOptions,
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getFirstTokens(
getFirstTokens<T extends SourceCode.CursorWithCountOptions>(
node: TSESTree.Node,
options?: SourceCode.CursorWithCountOptions,
): TSESTree.Token[];
options?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getLastToken(
getLastToken<T extends SourceCode.CursorWithSkipOptions>(
node: TSESTree.Node,
options?: SourceCode.CursorWithSkipOptions,
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getLastTokens(
getLastTokens<T extends SourceCode.CursorWithCountOptions>(
node: TSESTree.Node,
options?: SourceCode.CursorWithCountOptions,
): TSESTree.Token[];
options?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getTokenBefore(
getTokenBefore<T extends SourceCode.CursorWithSkipOptions>(
node: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithSkipOptions,
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getTokensBefore(
getTokensBefore<T extends SourceCode.CursorWithCountOptions>(
node: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithCountOptions,
): TSESTree.Token[];
options?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getTokenAfter(
getTokenAfter<T extends SourceCode.CursorWithSkipOptions>(
node: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithSkipOptions,
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getTokensAfter(
getTokensAfter<T extends SourceCode.CursorWithCountOptions>(
node: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithCountOptions,
): TSESTree.Token[];
options?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getFirstTokenBetween(
getFirstTokenBetween<T extends SourceCode.CursorWithSkipOptions>(
left: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
right: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithSkipOptions,
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getFirstTokensBetween(
getFirstTokensBetween<T extends SourceCode.CursorWithCountOptions>(
left: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
right: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithCountOptions,
): TSESTree.Token[];
options?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getLastTokenBetween(
getLastTokenBetween<T extends SourceCode.CursorWithSkipOptions>(
left: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
right: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithSkipOptions,
): TSESTree.Token | null;
options?: T,
): T extends { includeComments: true }
? TSESTree.Token | TSESTree.Comment | null
: TSESTree.Token | null;

getLastTokensBetween(
getLastTokensBetween<T extends SourceCode.CursorWithCountOptions>(
left: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
right: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
options?: SourceCode.CursorWithCountOptions,
): TSESTree.Token[];
options?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getTokensBetween(
getTokensBetween<T extends SourceCode.CursorWithCountOptions>(
left: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
right: TSESTree.Node | TSESTree.Token | TSESTree.Comment,
padding?:
| number
| SourceCode.FilterPredicate
| SourceCode.CursorWithCountOptions,
armano2 marked this conversation as resolved.
Show resolved Hide resolved
): TSESTree.Token[];
padding?: T,
): T extends { includeComments: true }
? (TSESTree.Token | TSESTree.Comment)[]
: TSESTree.Token[];

getTokens(
node: TSESTree.Node,
Expand Down
6 changes: 3 additions & 3 deletions packages/typescript-estree/src/convert-comments.ts
View file
Open in desktop
@@ -1,7 +1,7 @@
import * as ts from 'typescript';
import { forEachComment } from 'tsutils/util/util';
import { getLocFor } from './node-utils';
import { TSESTree } from './ts-estree';
import { AST_TOKEN_TYPES, TSESTree } from './ts-estree';

/**
* Convert all comments for the given AST.
Expand All @@ -21,8 +21,8 @@ export function convertComments(
(_, comment) => {
const type =
comment.kind == ts.SyntaxKind.SingleLineCommentTrivia
? 'Line'
: 'Block';
? AST_TOKEN_TYPES.Line
: AST_TOKEN_TYPES.Block;
armano2 marked this conversation as resolved.
Show resolved Hide resolved
const range: TSESTree.Range = [comment.pos, comment.end];
const loc = getLocFor(range[0], range[1], ast);

Expand Down
34 changes: 20 additions & 14 deletions packages/typescript-estree/src/node-utils.ts
View file
Open in desktop
Expand Up @@ -455,7 +455,7 @@ export function isOptional(node: {
*/
export function getTokenType(
token: ts.Identifier | ts.Token<ts.SyntaxKind>,
): AST_TOKEN_TYPES {
): Exclude<AST_TOKEN_TYPES, AST_TOKEN_TYPES.Line | AST_TOKEN_TYPES.Block> {
if ('originalKeywordKind' in token && token.originalKeywordKind) {
if (token.originalKeywordKind === SyntaxKind.NullKeyword) {
return AST_TOKEN_TYPES.Null;
Expand Down Expand Up @@ -561,21 +561,27 @@ export function convertToken(
: token.getStart(ast);
const end = token.getEnd();
const value = ast.text.slice(start, end);
const newToken: TSESTree.Token = {
type: getTokenType(token),
value,
range: [start, end],
loc: getLocFor(start, end, ast),
};

if (newToken.type === AST_TOKEN_TYPES.RegularExpression) {
newToken.regex = {
pattern: value.slice(1, value.lastIndexOf('/')),
flags: value.slice(value.lastIndexOf('/') + 1),
const tokenType = getTokenType(token);

if (tokenType === AST_TOKEN_TYPES.RegularExpression) {
return {
type: tokenType,
value,
range: [start, end],
loc: getLocFor(start, end, ast),
regex: {
pattern: value.slice(1, value.lastIndexOf('/')),
flags: value.slice(value.lastIndexOf('/') + 1),
},
};
} else {
return {
type: tokenType,
value,
range: [start, end],
loc: getLocFor(start, end, ast),
};
}

return newToken;
}

/**
Expand Down
74 changes: 67 additions & 7 deletions packages/typescript-estree/src/ts-estree/ts-estree.ts
View file
Open in desktop
Expand Up @@ -52,20 +52,80 @@ export interface BaseNode {
* They are not included in the `Node` union below on purpose because they
* are not ever included as part of the standard AST tree.
*/

export interface Token extends BaseNode {
type: AST_TOKEN_TYPES;
interface BaseToken extends BaseNode {
value: string;
regex?: {
}

export interface BooleanToken extends BaseToken {
type: AST_TOKEN_TYPES.Boolean;
}
bradzacher marked this conversation as resolved.
Show resolved Hide resolved

export interface IdentifierToken extends BaseToken {
type: AST_TOKEN_TYPES.Identifier;
}

export interface JSXIdentifierToken extends BaseToken {
type: AST_TOKEN_TYPES.JSXIdentifier;
}

export interface JSXTextToken extends BaseToken {
type: AST_TOKEN_TYPES.JSXText;
}

export interface KeywordToken extends BaseToken {
type: AST_TOKEN_TYPES.Keyword;
}

export interface NullToken extends BaseToken {
type: AST_TOKEN_TYPES.Null;
}
bradzacher marked this conversation as resolved.
Show resolved Hide resolved

export interface NumericToken extends BaseToken {
type: AST_TOKEN_TYPES.Numeric;
}

export interface PunctuatorToken extends BaseToken {
type: AST_TOKEN_TYPES.Punctuator;
}

export interface RegularExpressionToken extends BaseToken {
type: AST_TOKEN_TYPES.RegularExpression;
regex: {
pattern: string;
flags: string;
};
}
export interface Comment extends BaseNode {
type: 'Line' | 'Block';
value: string;

export interface StringToken extends BaseToken {
type: AST_TOKEN_TYPES.String;
}

export interface TemplateToken extends BaseToken {
type: AST_TOKEN_TYPES.Template;
}

export interface BlockComment extends BaseToken {
type: AST_TOKEN_TYPES.Block;
}

export interface LineComment extends BaseToken {
type: AST_TOKEN_TYPES.Line;
}

export type Comment = BlockComment | LineComment;
export type Token =
| BooleanToken
| IdentifierToken
| JSXIdentifierToken
| JSXTextToken
| KeywordToken
| NullToken
| NumericToken
| PunctuatorToken
| RegularExpressionToken
| StringToken
| TemplateToken;

export type OptionalRangeAndLoc<T> = Pick<
T,
Exclude<keyof T, 'range' | 'loc'>
Expand Down