[Bugfix] Fix for whitespace rule requiring extra space in ImportType in TS 2.9 #3992

Tenga · 2018-06-24T01:23:53Z

PR checklist

Addresses an existing issue: [Bug][TS 2.9] Whitespace required between import and parens with the type import syntax #3987
New feature, bugfix, or enhancement
- Includes tests
Documentation update

Overview of change:

Fixes the bug where the new ImportType syntax required extra spacing when whitespace rule was enabled.

Is there anything you'd like reviewers to focus on?

Beware, my first dive into TSLint and the AST. 😄
Might have overdone or missed the test cases
As this seems to be only relevant in TS 2.9 and above, not sure how you usually deal with cases like this if you want to support older TS versions?
- I've done the first thing that came to mind and typecasted the SyntaxKind as any and let the ImportKind end up undefined to fail the check.
- Is there an standard way on how this is handled usually?
- I've extracted the tests for this to a file which is only ran on TS 2.9, I'm assuming that's fine as the syntax for this to work should get struck down by the TS compiler for users of the older TS anyway?

CHANGELOG.md entry:

[bugfix] whitespace rule no longer requires extra spaces with the TS 2.9 import type syntax

suchanlee · 2018-06-28T21:24:42Z

src/rules/whitespaceRule.ts

@@ -296,6 +296,10 @@ function walk(ctx: Lint.WalkContext<Options>) {
                }
                break;
            case ts.SyntaxKind.ImportKeyword:
+                if (parent.kind === (ts.SyntaxKind as any).ImportType) {


can you first check if ts.SyntaxKind.ImportType is defined?

Sure, done. Tho it seems redundant to me in this case, hence why it wasn't there in the first place. 😄

johnwiseheart · 2018-07-16T18:26:56Z

Hi @Tenga, just wanted to check if you have signed the CLA as that appears to be the remaining test left to pass. The cla-bot has been a little confused lately, so if you're unsure what the CLA is, I've copied its message from another PR:

Thanks for your interest in palantir/tslint, @Tenga! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

Tenga · 2018-07-16T20:01:22Z

Hey @johnwiseheart. I'm aware of it, I'm just waiting for the go-ahead from my employer before signing. ⌚️

Tenga · 2018-07-23T13:39:09Z

@johnwiseheart CLA has been signed.

johnwiseheart · 2018-07-25T20:42:10Z

src/rules/whitespaceRule.ts

@@ -296,6 +296,10 @@ function walk(ctx: Lint.WalkContext<Options>) {
                }
                break;
            case ts.SyntaxKind.ImportKeyword:
+                if ((ts.SyntaxKind as any).ImportType !== undefined && parent.kind === (ts.SyntaxKind as any).ImportType) {


Hmm, I don't like having to cast as any. What is the issue here - is it that ts.SyntaxKind.ImportType is a ts2.9+ thing?

@giladgray @suchanlee @jkillian any ideas on how to work around this?

Let's define a shared isImportKeyword in src/utils.ts similar to existing helper functions from tsutils.

JoshuaKGoldberg

Code generally looks good; just one comment on the isImportKeyword function.

JoshuaKGoldberg · 2018-11-07T02:04:01Z

src/rules/whitespaceRule.ts

@@ -296,6 +296,10 @@ function walk(ctx: Lint.WalkContext<Options>) {
                }
                break;
            case ts.SyntaxKind.ImportKeyword:
+                if ((ts.SyntaxKind as any).ImportType !== undefined && parent.kind === (ts.SyntaxKind as any).ImportType) {


Let's define a shared isImportKeyword in src/utils.ts similar to existing helper functions from tsutils.

JoshuaKGoldberg · 2018-11-07T06:30:06Z

Looks like #4243 is the same as this PR but with the comment resolved (and great tests reflected). Thanks for sending this in @Tenga! Closing this now that #4243 went in, but still very much appreciated!

Tenga · 2018-11-07T09:43:07Z

While I'm happy this fairly thin PR will finally be resolved, it leaves a bad taste in my mouth.

This PR has been, with my full understanding, sitting in the queue for months, with me waiting for feedback/advice on how you guys would like to resolve a style problem. The end result is merging a PR that openly rips 90% of the work from this PR, because it was hard to wait a couple of hours to amend this PR with a one-liner change?

¯\_(ツ)_/¯

JoshuaKGoldberg · 2018-11-07T14:04:40Z

@Tenga Thanks for the feedback. You're right, and I'm sorry for marginalizing your contribution here. I should have waited a few days before merging in the other PR.

For context on the sitting in the queue for months, TSLint hasn't had an active maintainer in those months, and I'm coming in now as a new maintainer to clean up the issues and PR queues. My goal here was to minimize the amount of pending work we have, but I went a bit overboard and didn't stop to think about this.

If you send another PR, I can promise the same thing won't happen twice.

Tenga · 2018-11-07T15:19:50Z

@JoshuaKGoldberg Appreciate the response. 👍

If I encounter an opportunity to contribute again, I'll certainly do so.

Just to clarify as I probably should've probably phrased it better. I understand that OSS is hard. "Sitting in queue for months" was not meant to be a diss or dissatisfaction with that, just the understanding of the reality. (Contributing guidelines prepare you for that anyway. 😛)

suchanlee reviewed Jun 28, 2018

View reviewed changes

Fix for requiring extra space for ImportType

4af8da8

Tenga force-pushed the import-type-fix branch from 68a3f74 to 4af8da8 Compare June 28, 2018 21:44

AlCalzone mentioned this pull request Jul 16, 2018

"whitespace" rule forces space when using import('lib').SomeType #4031

Closed

johnwiseheart added the PR: waiting for CLA Waiting for the author to sign the CLA label Jul 18, 2018

johnwiseheart reviewed Jul 25, 2018

View reviewed changes

johnwiseheart removed the PR: waiting for CLA Waiting for the author to sign the CLA label Jul 25, 2018

JoshuaKGoldberg suggested changes Nov 7, 2018

View reviewed changes

JoshuaKGoldberg mentioned this pull request Nov 7, 2018

Add isImportKeyword? ajafff/tsutils#83

Closed

JoshuaKGoldberg added PR: waiting for author PR: merge target branch labels Nov 7, 2018

JoshuaKGoldberg closed this Nov 7, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Bugfix] Fix for whitespace rule requiring extra space in ImportType in TS 2.9 #3992

[Bugfix] Fix for whitespace rule requiring extra space in ImportType in TS 2.9 #3992

Tenga commented Jun 24, 2018

suchanlee Jun 28, 2018 •

edited

Loading

Tenga Jun 28, 2018 •

edited

Loading

johnwiseheart commented Jul 16, 2018

Tenga commented Jul 16, 2018

Tenga commented Jul 23, 2018

johnwiseheart Jul 25, 2018

Tenga Jul 25, 2018

johnwiseheart Jul 25, 2018

JoshuaKGoldberg Nov 7, 2018

JoshuaKGoldberg left a comment

JoshuaKGoldberg Nov 7, 2018

JoshuaKGoldberg commented Nov 7, 2018

Tenga commented Nov 7, 2018

JoshuaKGoldberg commented Nov 7, 2018

Tenga commented Nov 7, 2018

[Bugfix] Fix for whitespace rule requiring extra space in ImportType in TS 2.9 #3992

[Bugfix] Fix for whitespace rule requiring extra space in ImportType in TS 2.9 #3992

Conversation

Tenga commented Jun 24, 2018

PR checklist

Overview of change:

Is there anything you'd like reviewers to focus on?

CHANGELOG.md entry:

suchanlee Jun 28, 2018 • edited Loading

Choose a reason for hiding this comment

Tenga Jun 28, 2018 • edited Loading

Choose a reason for hiding this comment

johnwiseheart commented Jul 16, 2018

Tenga commented Jul 16, 2018

Tenga commented Jul 23, 2018

johnwiseheart Jul 25, 2018

Choose a reason for hiding this comment

Tenga Jul 25, 2018

Choose a reason for hiding this comment

johnwiseheart Jul 25, 2018

Choose a reason for hiding this comment

JoshuaKGoldberg Nov 7, 2018

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg Nov 7, 2018

Choose a reason for hiding this comment

JoshuaKGoldberg commented Nov 7, 2018

Tenga commented Nov 7, 2018

JoshuaKGoldberg commented Nov 7, 2018

Tenga commented Nov 7, 2018

suchanlee Jun 28, 2018 •

edited

Loading

Tenga Jun 28, 2018 •

edited

Loading