typecheck updates & fixes in src/language-js

cspell.json

@@ -354,6 +354,7 @@
         "Transloadit",
         "TSAs",
         "tsep",
+        "TSESTree",
         "TSJS",
         "tslib",
         "typeahead",

package.json

@@ -85,13 +85,17 @@
   "devDependencies": {
     "@babel/core": "7.11.1",
     "@babel/preset-env": "7.11.0",
+    "@babel/types": "7.11.0",
     "@glimmer/reference": "0.56.1",
     "@rollup/plugin-alias": "3.1.1",
     "@rollup/plugin-babel": "5.2.0",
     "@rollup/plugin-commonjs": "14.0.0",
     "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-node-resolve": "9.0.0",
     "@rollup/plugin-replace": "2.3.3",
+    "@types/estree": "0.0.45",
+    "@types/node": "14.6.0",
+    "@typescript-eslint/types": "3.9.1",
     "babel-loader": "8.1.0",
     "benchmark": "2.1.4",
     "builtin-modules": "3.1.0",
@@ -139,7 +143,7 @@
     "lint:typecheck": "tsc",
     "lint:eslint": "cross-env EFF_NO_LINK_RULES=true eslint . --format friendly",
     "lint:changelog": "node ./scripts/lint-changelog.js",
-    "lint:prettier": "prettier \"**/*.{md,json,yml,html,css,js}\" \"!test*\" --check",
+    "lint:prettier": "prettier \"**/*.{md,json,yml,html,css,js,d.ts}\" \"!test*\" --check",
     "lint:dist": "eslint --no-eslintrc --no-ignore --env=es6,browser --parser-options=ecmaVersion:2016 \"dist/!(bin-prettier|index|third-party).js\"",
     "lint:spellcheck": "cspell \"**/*\" \".github/**/*\"",
     "lint:deps": "node ./scripts/check-deps.js",

src/document/index.js

@@ -1,5 +1,9 @@
 "use strict";
 
+/**
+ * @typedef {import("./doc-builders").Doc} Doc
+ */
+
 module.exports = {
   builders: require("./doc-builders"),
   printer: require("./doc-printer"),

src/language-js/comments.js

@@ -578,7 +578,7 @@ function handleCommentAfterArrowParams(text, enclosingNode, comment, options) {
     comment,
     options.locEnd
   );
-  if (text.slice(index, index + 2) === "=>") {
+  if (index !== false && text.slice(index, index + 2) === "=>") {
     addDanglingComment(enclosingNode, comment);
     return true;
   }
@@ -672,9 +672,12 @@ function handleLastFunctionArgComments(
         text,
         options.locEnd(enclosingNode.id)
       );
-      return getNextNonSpaceNonCommentCharacterIndexWithStartIndex(
-        text,
-        functionParamLeftParenIndex + 1
+      return (
+        functionParamLeftParenIndex !== false &&
+        getNextNonSpaceNonCommentCharacterIndexWithStartIndex(
+          text,
+          functionParamLeftParenIndex + 1
+        )
       );
     })();
     if (options.locStart(comment) > functionParamRightParenIndex) {
@@ -930,6 +933,11 @@ function isBlockComment(comment) {
   return comment.type === "Block" || comment.type === "CommentBlock";
 }
 
+/**
+ * @param {any} node
+ * @param {(comment: any) => boolean} fn
+ * @returns boolean
+ */
 function hasLeadingComment(node, fn = () => true) {
   if (node.leadingComments) {
     return node.leadingComments.some(fn);

src/language-js/needs-parens.js

@@ -1,5 +1,6 @@
 "use strict";
 
+/** @type {import("assert")} */
 const assert = require("assert");
 
 const {

src/language-js/print/call-arguments.js

@@ -159,7 +159,7 @@ function printCallArguments(path, options, print) {
       shouldBreakForArrowFunction;
 
     // We want to print the last argument with a special flag
-    let printedExpanded;
+    let printedExpanded = [];
     let i = 0;
     const printArgument = (argPath) => {
       if (shouldGroupFirst && i === 0) {

src/language-js/print/member-chain.js

@@ -80,10 +80,9 @@ function printMemberChain(path, options, print) {
     // if it is cut off by a parenthesis, we only account for one typed empty
     // line after that parenthesis
     if (nextChar === ")") {
-      return isNextLineEmptyAfterIndex(
-        originalText,
-        nextCharIndex + 1,
-        options.locEnd
+      return (
+        nextCharIndex !== false &&
+        isNextLineEmptyAfterIndex(originalText, nextCharIndex + 1)
       );
     }
 

src/language-js/print/module.js

@@ -3,15 +3,22 @@
 const {
   builders: { concat, softline, group, indent, join, line, ifBreak },
 } = require("../../document");
+
 const { shouldPrintComma } = require("../utils");
 
+/**
+ * @typedef {import("../../document").Doc} Doc
+ */
+
 function printModuleSource(path, options, print) {
   const node = path.getValue();
   return node.source ? concat([" from ", path.call(print, "source")]) : "";
 }
 
 function printModuleSpecifiers(path, options, print) {
   const node = path.getValue();
+
+  /** @type{Doc[]} */
   const parts = [node.type === "ImportDeclaration" ? " " : ""];
 
   if (node.specifiers && node.specifiers.length > 0) {

src/language-js/print/ternary.js

@@ -19,6 +19,22 @@ const {
   },
 } = require("../../document");
 
+/**
+ * @typedef {import("../../document").Doc} Doc
+ * @typedef {import("../../common/fast-path")} FastPath
+ *
+ * @typedef {any} Options - Prettier options (TBD ...)
+ *
+ * @typedef {Object} OperatorOptions
+ * @property {() => Array<string | Doc>} beforeParts - Parts to print before the `?`.
+ * @property {(breakClosingParen: boolean) => Array<string | Doc>} afterParts - Parts to print after the conditional expression.
+ * @property {boolean} shouldCheckJsx - Whether to check for and print in JSX mode.
+ * @property {string} conditionalNodeType - The type of the conditional expression node, ie "ConditionalExpression" or "TSConditionalType".
+ * @property {string} consequentNodePropertyName - The property at which the consequent node can be found on the main node, eg "consequent".
+ * @property {string} alternateNodePropertyName - The property at which the alternate node can be found on the main node, eg "alternate".
+ * @property {string[]} testNodePropertyNames - The properties at which the test nodes can be found on the main node, eg "test".
+ */
+
 // If we have nested conditional expressions, we want to print them in JSX mode
 // if there's at least one JSXElement somewhere in the tree.
 //
@@ -118,16 +134,7 @@ function conditionalExpressionChainContainsJSX(node) {
  * The following is the shared logic for
  * ternary operators, namely ConditionalExpression
  * and TSConditionalType
- * @typedef {import("../../document/doc-builders").Doc} Doc
- * @typedef {Object} OperatorOptions
- * @property {() => Array<string | Doc>} beforeParts - Parts to print before the `?`.
- * @property {(breakClosingParen: boolean) => Array<string | Doc>} afterParts - Parts to print after the conditional expression.
- * @property {boolean} shouldCheckJsx - Whether to check for and print in JSX mode.
- * @property {string} conditionalNodeType - The type of the conditional expression node, ie "ConditionalExpression" or "TSConditionalType".
- * @property {string} consequentNodePropertyName - The property at which the consequent node can be found on the main node, eg "consequent".
- * @property {string} alternateNodePropertyName - The property at which the alternate node can be found on the main node, eg "alternate".
- * @property {string[]} testNodePropertyNames - The properties at which the test nodes can be found on the main node, eg "test".
- * @param {import("../../common/fast-path")} path - The path to the ConditionalExpression/TSConditionalType node.
+ * @param {FastPath} path - The path to the ConditionalExpression/TSConditionalType node.
  * @param {Options} options - Prettier options
  * @param {Function} print - Print function to call recursively
  * @param {OperatorOptions} operatorOptions

src/language-js/printer-estree.js

@@ -1,5 +1,8 @@
 "use strict";
 
+/** @typedef {import("../document").Doc} Doc */
+
+/** @type {import("assert")} */
 const assert = require("assert");
 
 // TODO(azz): anything that imports from main shouldn't be in a `language-*` dir.
@@ -256,7 +259,9 @@ function printPathNoParens(path, options, print, args) {
     return htmlBinding;
   }
 
+  /** @type{Doc[]} */
   let parts = [];
+
   switch (n.type) {
     case "JsExpressionRoot":
       return path.call(print, "node");
@@ -481,17 +486,23 @@ function printPathNoParens(path, options, print, args) {
       //   )
 
       const hasJSX = isJSXNode(n.right);
-      const firstGroupIndex = parts.findIndex((part) => part.type === "group");
+
+      const firstGroupIndex = parts.findIndex(
+        (part) => typeof part !== "string" && part.type === "group"
+      );
+
       // Separate the leftmost expression, possibly with its leading comments.
       const headParts = parts.slice(
         0,
         firstGroupIndex === -1 ? 1 : firstGroupIndex + 1
       );
+
       const rest = concat(
         parts.slice(headParts.length, hasJSX ? -1 : undefined)
       );
 
       const groupId = Symbol("logicalChain-" + ++uid);
+
       const chain = group(
         concat([
           // Don't include the initial expression in the indentation
@@ -672,8 +683,9 @@ function printPathNoParens(path, options, print, args) {
             options.locEnd
           );
           return (
+            nextCharacter !== false &&
             options.originalText.slice(nextCharacter, nextCharacter + 2) ===
-            "=>"
+              "=>"
           );
         }
       );
@@ -4046,7 +4058,10 @@ function printReturnType(path, print, options) {
 
 function printExportDeclaration(path, options, print) {
   const decl = path.getValue();
+
   const semi = options.semi ? ";" : "";
+
+  /** @type{Doc[]} */
   const parts = ["export "];
 
   const isDefault = decl.default || decl.type === "ExportDefaultDeclaration";
@@ -4769,7 +4784,9 @@ function printBinaryishExpressions(
   isNested,
   isInsideParenthesis
 ) {
+  /** @type{Doc[]} */
   let parts = [];
+
   const node = path.getValue();
 
   // We treat BinaryExpression and LogicalExpression nodes the same.

src/language-js/types/estree.d.ts

@@ -0,0 +1,97 @@
+import * as ESTree from "estree";
+import * as Babel from "@babel/types";
+import { TSESTree } from "@typescript-eslint/types";
+import * as NGTree from "angular-estree-parser/lib/types";
+
+// WORKAROUND HACK for typescript-eslint issue:
+// https://github.com/typescript-eslint/typescript-eslint/issues/2388
+// MUST REMOVE to avoid errors with TypeScript 4.0.0:
+import * as ts from "typescript";
+declare module "typescript" {
+  type NamedTupleMember = Node;
+}
+
+type AdditionalFields = {
+  extra?: {
+    parenthesized?: boolean;
+    parenStart?: number;
+    raw?: string;
+  };
+  comments?: Comment[];
+  trailingComments?: ReadonlyArray<Comment> | Comment[];
+  leadingComments?: ReadonlyArray<Comment> | Comment[];
+};
+
+export type Comment = (ESTree.Comment | Babel.Comment | TSESTree.Comment) & {
+  printed?: boolean;
+  trailing?: boolean;
+  leading?: boolean;
+};
+
+export type Node = (ESTree.Node | Babel.Node | TSESTree.Node | NGTree.NGNode) &
+  AdditionalFields;
+
+export type TemplateLiteral = (
+  | ESTree.TemplateLiteral
+  | Babel.TemplateLiteral
+  | TSESTree.TemplateLiteral
+) &
+  AdditionalFields;
+
+export type CallExpression = (
+  | ESTree.CallExpression
+  | Babel.CallExpression
+  | TSESTree.CallExpression
+) &
+  AdditionalFields;
+
+export type OptionalCallExpression = (
+  | Babel.OptionalCallExpression
+  | TSESTree.OptionalCallExpression
+) &
+  AdditionalFields;
+
+export type MemberExpression = (
+  | ESTree.MemberExpression
+  | Babel.MemberExpression
+  | TSESTree.MemberExpression
+) &
+  AdditionalFields;
+
+export type OptionalMemberExpression = (
+  | Babel.OptionalMemberExpression
+  | TSESTree.OptionalMemberExpression
+) &
+  AdditionalFields;
+
+export type Expression = (
+  | ESTree.Expression
+  | Babel.Expression
+  | TSESTree.Expression
+) &
+  AdditionalFields;
+
+export type BindExpression = Babel.BindExpression & AdditionalFields;
+
+export type Property = (ESTree.Property | Babel.Property | TSESTree.Property) &
+  AdditionalFields;
+
+export type ClassPrivateProperty = Babel.ClassPrivateProperty &
+  AdditionalFields;
+
+export type ObjectTypeProperty = Babel.ObjectTypeProperty & AdditionalFields;
+
+export type JSXElement = (Babel.JSXElement | TSESTree.JSXElement) &
+  AdditionalFields;
+
+export type TaggedTemplateExpression = (
+  | ESTree.TaggedTemplateExpression
+  | Babel.TaggedTemplateExpression
+  | TSESTree.TaggedTemplateExpression
+) &
+  AdditionalFields;
+
+export type Literal = (ESTree.Literal | Babel.Literal | TSESTree.Literal) &
+  AdditionalFields;
+
+export { ESTree, Babel, TSESTree, NGTree };