Build: add type check using typescript --checkJs #2267

chiawendt · 2019-05-10T13:45:57Z

No description provided.

ljharb

These fixes are fine, but is there some way we could use CI to ensure they stay correct? otherwise i'm not sure they're adding value.

chiawendt · 2019-05-10T19:44:24Z

This errors are found by typescript's --checkJs feature. It pull types from jsdoc and typecheck. It is great. CI can be setup by running tsc.

ljharb · 2019-05-10T19:59:30Z

Let's add an npm run-script for that, then, and a separate travis.yml job that does it, and the appropriate dev deps.

chiawendt · 2019-05-11T11:18:33Z

tsconfig.json

+    /* Strict Type-Checking Options */
+    // "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */


The flag strictNullChecks is left unenabled because there is about 20 places where I need to either use @ts-ignore or write very awkward codes.

chiawendt · 2019-05-11T11:39:34Z

It might make sense to add eslint-plugin-jsdoc. The errors it catches includes: 1. Missing or superfluous jsdoc param. 2. Unmatched Jsdoc param name and actual name. 3. Enforce presence of types annotation.

lib/rules/jsx-closing-bracket-location.js

lib/rules/no-unknown-property.js

lib/rules/no-unused-state.js

lib/types.d.ts

ljharb · 2019-05-11T14:05:59Z

lib/util/linkComponents.js

 */
 'use strict';

+/** @type {any[]}} */


string[]?

Tsc does not accept string[]. The official type declaration requires that in a.concat(b), a and b must have the same type.

when is this array concatted with something that's not also a string[]?

In lines bellow it is concatted with setting.something.

which should be a string[] per the schema, no?

By schema it could be {name: something, linkAttribute: something}[]

ah - then should the type be (string | { name: string, linkAttribute: string })[]?

But settings.linkComponents is not validated, it could be anything.

if it's not that schema tho, the plugin won't work properly, so i think we can assume that's its type.

ljharb · 2019-05-11T14:06:20Z

lib/util/propTypes.js

    UnionTypeAnnotation: function(annotation, parentName, seen) {
      const unionTypeDefinition = {
        type: 'union',
+        /** @type {any} */


lets avoid any use of any :-)

Tsc does not accept any[] and any[]|true.

unknown[]? unknown[] | true? you can certainly do any of those in TS, altho maybe not in jsdoc.

Tsc does not accept unknown[] unknown[]|true also.

just in jsdoc? it certainly works in TS.

unionTypeDefinition.children is at a time assigned true, so it cannot be unknown[]. unionTypeDefinition.children.length is used, so it cannot be unknown[]|true.

then that implies there's a bug, or else type narrowing would have removed true prior to the .length access?

chiawendt · 2019-05-12T09:55:19Z

I somehow closed this by accident. Apologies.

lib/rules/jsx-closing-bracket-location.js

package.json

ljharb

I've explicitly commented on all non-comment changes, just to be thorough.

I'd still like to avoid any use of any.

LGTM pending https://github.com/yannickcr/eslint-plugin-react/pull/2267/files#r283097857

ljharb · 2019-05-12T17:50:49Z

lib/rules/destructuring-assignment.js

        }
        if (classComponent) {
-          handleClassUsage(node, classComponent);
+          handleClassUsage(node);


This is a harmless extra arg being passed - good to clean up. semver-patch.

ljharb · 2019-05-12T17:53:18Z

lib/rules/no-unknown-property.js

    return SVGDOM_ATTRIBUTE_NAMES[name];
  }
-  let i;
+  let i = -1;


This seems to be useless, but I assume tells tsc what the type of i is. It could also be set to 0, but -1 is clearer semantically.

If i is not initialized, it could potentially be undefined, that would make tsc reject DOM_PROPERTY_NAMES[i].

[undefined] on an object without that property is safely undefined, that's just the type system being overly strict :-)

lib/rules/no-unused-state.js

ljharb · 2019-05-12T17:54:06Z

lib/rules/static-property-placement.js

      const name = classProperties.find(propertyName => {
        if (propertiesToCheck[propertyName](node)) {
-          return propertyName;
+          return !!propertyName;


Assuming the return value of reportNodeIncorrectlyPositioned is always used in a truthy/falsy position, this just returns true instead of "truthy"…

ljharb · 2019-05-12T17:54:15Z

lib/rules/static-property-placement.js

        }

-        return null;
+        return false;


and false instead of "falsy".

lib/types.d.ts

chiawendt · 2019-05-13T06:49:23Z

Thanks for the thorough review!

ljharb reviewed May 10, 2019

View reviewed changes

chiawendt added 2 commits May 11, 2019 18:53

[Build]: add type-check to npm scripts and ci

d7d7446

[Build]: fix type-check errors

3e7c1f6

chiawendt force-pushed the fix-some-jsdoc-errors branch from b189e12 to 084c678 Compare May 11, 2019 11:06

chiawendt changed the title ~~[Chore]: fix some jsdoc errors~~ Build: add type check using typescript --checkJs May 11, 2019

chiawendt force-pushed the fix-some-jsdoc-errors branch from 084c678 to d344dca Compare May 11, 2019 11:11

chiawendt commented May 11, 2019

View reviewed changes

ljharb reviewed May 11, 2019

View reviewed changes

chiawendt closed this May 12, 2019

chiawendt force-pushed the fix-some-jsdoc-errors branch from 084c678 to fce69eb Compare May 12, 2019 09:21

chiawendt reopened this May 12, 2019

ljharb reviewed May 12, 2019

View reviewed changes

lib/rules/jsx-closing-bracket-location.js Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

ljharb approved these changes May 12, 2019

View reviewed changes

ljharb force-pushed the fix-some-jsdoc-errors branch 2 times, most recently from e6509bb to 3e7c1f6 Compare May 14, 2019 05:08

ljharb merged commit a659b63 into jsx-eslint:master May 14, 2019

chiawendt deleted the fix-some-jsdoc-errors branch May 18, 2019 20:36

This was referenced Aug 17, 2019

[Snyk] Upgrade eslint-plugin-react from 7.4.0 to 7.14.3 Financial-Times/ip-material-ui-theme#25

Open

[Snyk] Upgrade eslint-plugin-react from 7.5.1 to 7.14.3 Alexander1984z/chrome-extensions-manager#4

Open

This was referenced Sep 22, 2019

[Snyk] Upgrade eslint-plugin-react from 7.7.0 to 7.14.3 Matthelonianxl/standard#2

Open

[Snyk] Upgrade eslint-plugin-react from 7.4.0 to 7.14.3 Ivajkin/react-redux-action#4

Open

snyk-bot mentioned this pull request Sep 30, 2019

[Snyk] Upgrade eslint-plugin-react from 7.5.1 to 7.14.3 Matthelonianxl/nifty-wallet#2

Open

snyk-bot mentioned this pull request Oct 29, 2019

[Snyk] Upgrade eslint-plugin-react from 7.7.0 to 7.16.0 Matthelonianxl/standard#4

Open

snyk-bot mentioned this pull request Nov 10, 2019

[Snyk] Upgrade eslint-plugin-react from 6.10.3 to 7.16.0 rubarb666/git-sketch-plugin#6

Open

snyk-bot mentioned this pull request Dec 15, 2019

[Snyk] Upgrade eslint-plugin-react from 7.11.1 to 7.17.0 jakeherp/burger-builder#13

Open

Uh oh!

Build: add type check using typescript --checkJs #2267

Build: add type check using typescript --checkJs #2267

Uh oh!

Conversation

chiawendt commented May 10, 2019

Uh oh!

ljharb left a comment

Choose a reason for hiding this comment

Uh oh!

chiawendt commented May 10, 2019

Uh oh!

ljharb commented May 10, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chiawendt commented May 11, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chiawendt commented May 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ljharb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chiawendt commented May 13, 2019

Uh oh!

Reviewers

chiawendt commented May 12, 2019 •

edited

Loading