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(typescript-estree): correct parenthesized optional chain AST #1141

Merged
merged 4 commits into from Oct 25, 2019
Merged

fix(typescript-estree): correct parenthesized optional chain AST #1141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ebaf7d9
fix(typescript-estree): correct parenthesized optional chain AST
bradzacher Oct 25, 2019
b663612
chore: parser snapshots
bradzacher Oct 25, 2019
f45858f
fix: allow 3.7.1-rc, browser tty
bradzacher Oct 25, 2019
5e21bc0
Merge branch 'master' into parens-opt-chain
bradzacher Oct 25, 2019
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,687 changes: 1,542 additions & 145 deletions packages/parser/tests/lib/__snapshots__/typescript.ts.snap
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions packages/shared-fixtures/fixtures/typescript/basics/optional-chain-call-with-parens.src.ts
View file
Open in desktop
@@ -0,0 +1,13 @@
function processOptionalCallParens(one?: any) {
(one?.fn());
(one?.two).fn();
(one.two?.fn());
(one.two?.three).fn();
(one.two?.three?.fn());

(one?.());
(one?.())();
(one?.())?.();

(one?.()).two;
}
1 change: 1 addition & 0 deletions packages/shared-fixtures/fixtures/typescript/basics/optional-chain-call.src.ts
View file
Open in desktop
Expand Up @@ -6,6 +6,7 @@ function processOptionalCall(one?: any) {
one.two?.three?.fn();

one?.();
one?.()();
one?.()?.();

one?.().two;
Expand Down
8 changes: 8 additions & 0 deletions ...ared-fixtures/fixtures/typescript/basics/optional-chain-element-access-with-parens.src.ts
View file
Open in desktop
@@ -0,0 +1,8 @@
function processOptionalElementParens(one?: any) {
(one?.[2]);
(one?.[2])[3];
(one[2]?.[3]);
(one[2]?.[3])[4];
(one[2]?.[3]?.[4]);
(one[2]?.[3]?.[4])[5];
}
8 changes: 8 additions & 0 deletions packages/shared-fixtures/fixtures/typescript/basics/optional-chain-with-parens.src.ts
View file
Open in desktop
@@ -0,0 +1,8 @@
function processOptionalParens(one?: any) {
(one?.two);
(one?.two).three;
(one.two?.three);
(one.two?.three).four;
(one.two?.three?.four);
(one.two?.three?.four).five;
}
51 changes: 30 additions & 21 deletions packages/typescript-estree/src/convert.ts
View file
Open in desktop
Expand Up @@ -1691,16 +1691,19 @@ export class Converter {
}

case SyntaxKind.PropertyAccessExpression: {
const isLocallyOptional = node.questionDotToken !== undefined;
const object = this.convertChild(node.expression);
const property = this.convertChild(node.name);
const computed = false;
if (
isLocallyOptional ||
// the optional expression should propogate up the member expression tree
object.type === AST_NODE_TYPES.OptionalMemberExpression ||
object.type === AST_NODE_TYPES.OptionalCallExpression
) {

const isLocallyOptional = node.questionDotToken !== undefined;
// the optional expression should propogate up the member expression tree
const isChildOptional =
(object.type === AST_NODE_TYPES.OptionalMemberExpression ||
object.type === AST_NODE_TYPES.OptionalCallExpression) &&
// (x?.y).z is semantically different, and as such .z is no longer optional
node.expression.kind !== ts.SyntaxKind.ParenthesizedExpression;

if (isLocallyOptional || isChildOptional) {
return this.createNode<TSESTree.OptionalMemberExpression>(node, {
type: AST_NODE_TYPES.OptionalMemberExpression,
object,
Expand All @@ -1720,16 +1723,19 @@ export class Converter {
}

case SyntaxKind.ElementAccessExpression: {
const isLocallyOptional = node.questionDotToken !== undefined;
const object = this.convertChild(node.expression);
const property = this.convertChild(node.argumentExpression);
const computed = true;
if (
isLocallyOptional ||
// the optional expression should propogate up the member expression tree
object.type === AST_NODE_TYPES.OptionalMemberExpression ||
object.type === AST_NODE_TYPES.OptionalCallExpression
) {

const isLocallyOptional = node.questionDotToken !== undefined;
// the optional expression should propogate up the member expression tree
const isChildOptional =
(object.type === AST_NODE_TYPES.OptionalMemberExpression ||
object.type === AST_NODE_TYPES.OptionalCallExpression) &&
// (x?.y).z is semantically different, and as such .z is no longer optional
node.expression.kind !== ts.SyntaxKind.ParenthesizedExpression;

if (isLocallyOptional || isChildOptional) {
return this.createNode<TSESTree.OptionalMemberExpression>(node, {
type: AST_NODE_TYPES.OptionalMemberExpression,
object,
Expand All @@ -1749,16 +1755,19 @@ export class Converter {
}

case SyntaxKind.CallExpression: {
const isLocallyOptional = node.questionDotToken !== undefined;
const callee = this.convertChild(node.expression);
const args = node.arguments.map(el => this.convertChild(el));
let result;
if (
isLocallyOptional ||
// the optional expression should propogate up the member expression tree
callee.type === AST_NODE_TYPES.OptionalMemberExpression ||
callee.type === AST_NODE_TYPES.OptionalCallExpression
) {

const isLocallyOptional = node.questionDotToken !== undefined;
// the optional expression should propogate up the member expression tree
const isChildOptional =
(callee.type === AST_NODE_TYPES.OptionalMemberExpression ||
callee.type === AST_NODE_TYPES.OptionalCallExpression) &&
// (x?.y).z() is semantically different, and as such .z() is no longer optional
node.expression.kind !== ts.SyntaxKind.ParenthesizedExpression;

if (isLocallyOptional || isChildOptional) {
result = this.createNode<TSESTree.OptionalCallExpression>(node, {
type: AST_NODE_TYPES.OptionalCallExpression,
callee,
Expand Down
5 changes: 4 additions & 1 deletion packages/typescript-estree/src/create-program/shared.ts
View file
Open in desktop
Expand Up @@ -20,7 +20,10 @@ const DEFAULT_COMPILER_OPTIONS: ts.CompilerOptions = {

// This narrows the type so we can be sure we're passing canonical names in the correct places
type CanonicalPath = string & { __brand: unknown };
const getCanonicalFileName = ts.sys.useCaseSensitiveFileNames
// typescript doesn't provide a ts.sys implementation for browser environments
const useCaseSensitiveFileNames =
ts.sys !== undefined ? ts.sys.useCaseSensitiveFileNames : true;
const getCanonicalFileName = useCaseSensitiveFileNames
? (filePath: string): CanonicalPath =>
path.normalize(filePath) as CanonicalPath
: (filePath: string): CanonicalPath =>
Expand Down
42 changes: 24 additions & 18 deletions packages/typescript-estree/src/parser.ts
View file
Open in desktop
Expand Up @@ -16,11 +16,18 @@ import { TSESTree } from './ts-estree';
* This needs to be kept in sync with the top-level README.md in the
* typescript-eslint monorepo
*/
const SUPPORTED_TYPESCRIPT_VERSIONS = '>=3.2.1 <3.8.0 || >3.7.0-dev.0';
const SUPPORTED_TYPESCRIPT_VERSIONS = '>=3.2.1 <3.8.0';
/*
* The semver package will ignore prerelease ranges, and we don't want to explicitly document every one
* List them all separately here, so we can automatically create the full string
*/
const SUPPORTED_PRERELEASE_RANGES = ['>3.7.0-dev.0', '3.7.1-rc'];
const ACTIVE_TYPESCRIPT_VERSION = ts.version;
const isRunningSupportedTypeScriptVersion = semver.satisfies(
ACTIVE_TYPESCRIPT_VERSION,
SUPPORTED_TYPESCRIPT_VERSIONS,
[SUPPORTED_TYPESCRIPT_VERSIONS]
.concat(SUPPORTED_PRERELEASE_RANGES)
.join(' || '),
);

let extra: Extra;
Expand Down Expand Up @@ -224,22 +231,21 @@ function applyParserOptionsToExtra(options: TSESTreeOptions): void {
}

function warnAboutTSVersion(): void {
if (
!isRunningSupportedTypeScriptVersion &&
!warnedAboutTSVersion &&
process.stdout.isTTY
) {
const border = '=============';
const versionWarning = [
border,
'WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.',
'You may find that it works just fine, or you may not.',
`SUPPORTED TYPESCRIPT VERSIONS: ${SUPPORTED_TYPESCRIPT_VERSIONS}`,
`YOUR TYPESCRIPT VERSION: ${ACTIVE_TYPESCRIPT_VERSION}`,
'Please only submit bug reports when using the officially supported version.',
border,
];
extra.log(versionWarning.join('\n\n'));
if (!isRunningSupportedTypeScriptVersion && !warnedAboutTSVersion) {
const isTTY = typeof process === undefined ? false : process.stdout.isTTY;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Prettier's build configuration, we have process, but not process.stdout. 🤷‍♂️

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

darn...

probably just better to do what parser does, and clear the logger function:

typescript-eslint/packages/parser/src/parser.ts

Lines 87 to 93 in d4703e1

const warnOnUnsupportedTypeScriptVersion = validateBoolean(
options.warnOnUnsupportedTypeScriptVersion,
true,
);
if (!warnOnUnsupportedTypeScriptVersion) {
parserOptions.loggerFn = false;
}

(note that this logger function isn't used anywhere else, it's only used to log the warning)

if (isTTY) {
const border = '=============';
const versionWarning = [
border,
'WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.',
'You may find that it works just fine, or you may not.',
`SUPPORTED TYPESCRIPT VERSIONS: ${SUPPORTED_TYPESCRIPT_VERSIONS}`,
`YOUR TYPESCRIPT VERSION: ${ACTIVE_TYPESCRIPT_VERSION}`,
'Please only submit bug reports when using the officially supported version.',
border,
];
extra.log(versionWarning.join('\n\n'));
}
warnedAboutTSVersion = true;
}
}
Expand Down
3 changes: 3 additions & 0 deletions packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts
View file
Open in desktop
Expand Up @@ -583,8 +583,11 @@ tester.addFixturePatternConfig('typescript/basics', {
*/
// optional chaining
'optional-chain',
'optional-chain-with-parens',
'optional-chain-call',
'optional-chain-call-with-parens',
'optional-chain-element-access',
'optional-chain-element-access-with-parens',
'async-function-expression',
'class-with-accessibility-modifiers',
'class-with-mixin',
Expand Down
6 changes: 6 additions & 0 deletions packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.ts.snap
View file
Open in desktop
Expand Up @@ -1922,8 +1922,14 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/optional-chain-call.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/optional-chain-call-with-parens.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/optional-chain-element-access.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/optional-chain-element-access-with-parens.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/optional-chain-with-parens.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/parenthesized-use-strict.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/readonly-arrays.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
Expand Down