tsutils

Bugfixes:

• getSymbolOfClassLikeDeclaration no longer crashes on anonymous mixin classes

Features:

• getSymbolOfClassLikeDeclaration to retrieve the symbol of class declarations and expressions regardless whether they have a name or not
• getBaseOfClassLikeDeclaration to conventiently get the expression after extends
• getBaseClassMemberOfClassElement to look up the declaration of a class member in the base class

Bugfixes:

• getConstructorTypeOfClassLikeDeclaration now really returns the constructor type (the static side of the class), previously it returned the instance type
• hasExhaustiveCaseClauses allows additional case clauses with null, undefined and never

Features:

• Source maps for easier debugging
• JSDoc is preserved in declaration files
• Comments are presered in transpiled code
• Everything you need to handle the control flow changes of TypeScript@3.7
  • callExpressionAffectsControlFlow to determine whether a CallExpression affects control flow by returning never or asserts
  • hasExhaustiveCaseClauses to determine whether a SwitchStatement's CaseClauses handle every possible value
  • endsControlFlow and getControlFlowEnd take an optional checker parameter to recognize exhaustive SwitchStatements and control flow effects of CallExpressions
• formatPseudoBigInt converts TypeScript's representation of a BigInt to its literal representation as you would write it in your source code
• getAstNodeAtPosition similar to getTokenAtPosition, but only operates on AST Nodes
• removeOptionalChainingUndefinedMarkerType and isOptionalChainingUndefinedMarkerType to handle types originating in an optional chain
• findImports and findImportLikeNodes: prepare for import assertions
• getTsCheckDirective as new name for getCheckJsDirective
• getCheckJsDirective is now deprecated

Bugfixes:

• getUsageDomain: handles NamespaceExport and NamedTupleMember
• getPropertyName: handles parentheses and negative numeric literals, excludes RegExp literals and private identifiers
• getSingleLateBoundPropertyNameOfPropertyName and getLateBoundPropertyNamesOfPropertyName: handles private identifiers
• hasAccessModifier: handles JSDoc access modifier
• hasSideEffects: correctly determines side effects of (static) property initializers
• isExpressionValueUsed: handle nullish coalescing and conditional assignment operators
• canHaveJsDoc: aligned with upstream changes in TypeScript
• isCompilerOptionEnabled:
  • noUncheckedIndexedAccess requires strictNullChecks
  • checkJs implies allowJs
  • emitDeclarationOnly requires declaration
• isInConstContext: handle template string interpolations
• excluded unnecessary files from npm package

Bugfixes:

• isValidJsxIdentifier, isValidPropertyAccess, isValidPropertyName: fix unicode character width handling

Features:

• isValidJsxIdentifier added an optional parameter to specify the target ECMAScript version

Bugfixes:

• isValidJsxIdentifier now handles astral plane characters

Features:

• added getIteratorYieldResultFromIteratorResult to extract the yielded type from IteratorResult<TYield, TReturn, TNext>

Features:

• isValidIdentifier, isValidPropertyName, isValidPropertyAccess, isValidNumericLiteral added an optional parameter to specify the target ECMAScript version

Bugfixes:

• isValidPropertyName, isValidPropertyAccess now handle astral plane characters

Bugfixes:

• findImports: fixed crash on nested namespaces

Features:

• added getInstanceTypeOfClassLikeDeclaration and getConstructorTypeOfClassLikeDeclaration
• added AccessKind.Delete to getAccessKind: getAccessKind(node) & AccessKind.Modification can now be used to restore the old behavior of isReassignmentTarget(node)

Features:

• getAccessKind determines whether an expression is read from, written to or both
• optimized getPropertyOfType for unambiguous property names to partially work around https://github.com/microsoft/TypeScript/issues/31565

Bugfixes:

• isReassignmentTarget no longer returns true for DeleteExpression as it doesn't assign a value to the operand

Features:

• getLateBoundPropertyNamesOfPropertyName returns all statically analyzable names of a property, method, ...
• getSingleLateBoundPropertyNameOfPropertyName returns the literal name of a property, method, ... if statically analyzable

Bugfixes:

• fixed circular import

Features:

• typeguards: isNumericOrStringLikeLiteral, isTupleTypeReference
• intersectionTypeParts as counterpart to unionTypeParts
• someTypePart to execute a callback for each union or intersection constituent until the callback returns true
• getPropertyOfType looks up a property by its escaped name
• isPropertyReadonlyInType determines whether a property in a given type cannot be written to
• symbolHasReadonlyDeclaration determines if a Symbol has any readonly or constant declaration
• isNumericPropertyName determines whether a property name would match an index signature
• isBindableObjectDefinePropertyCall returns true for statically analyzable forms of Object.defineProperty(o, 'p', {value, writable})
• isReadonlyAssignmentDeclaration determines whether an Object.defineProperty call is known to result in a readonly property
• getLateBoundPropertyNames returns all known property names of an expression
• getPropertyNameFromType extracts the property name of literal types
• isWellKnownSymbolLiterally to recognize expressions in the form of Symbol.<name>
• getPropertyNameOfWellKnownSymbol returns the escaped name for a well known symbol literal
• unwrapParentheses returns the first child expression that is not a ParenthesizedExpression

Features:

• isCompilerOptionEnabled: incremental is implicitly enabled by composite

Bugfixes:

• collectVariableUsage/getUsageDomain: no longer treat as const as type usage

Bugfixes:

• reverted invalid deprecation of canHaveJsdoc
• fixed condition in parseJsdocOfNode

Features:

• added typeguards: isNullLiteral and isBooleanLiteral

Features:

• exposes typeguards for typescript@3.2 by default
• added utilities: isConstAssertion and isInConstContext

Features:

• added isBlockScopedDeclarationStatement
• added isInSingleStatementContext

Features:

• added getCheckJsDirective utility to parse // @ts-check and // @ts-nocheck pragmas

Bugfixes:

• Published declaration files no longer contain const enum. They are now declared as regular enums instead.

Bugfixes:

• isThenableType allows Node instead of Expression as parameter
• isBlockScopeBoundary and isScopeBoundary consider WithStatement as scope boundary

Features:

• correctly handle BigInt literals
  • added typeguard isBigIntLiteral
  • isLiteralType recognises BigInt
  • getPropertyName adds special handling for BigInt

Features:

• added utility commentText to get the actual text content of a comment excluding the characters needed to start and end the comment

Bugfixes:

• findImports: fixed handling of ImportEqualsDeclaration

Features:

• isCompilerOptionEnabled: recognizes strictBindCallApply
• getTokenAtPosition: optionally includes JSDoc during lookup

Bugfixes:

• isCompilerOptionEnabled: correctly implements logic for allowSyntheticDefaultImports
• findImportLikeNodes: correctly finds imports in namespaces
• findImportLikeNodes / findImports: finds import types in JSDoc of JS files

Features:

• added utility findImportLikeNodes that works similar to findImports but returns the import statement or expression instead of the module specifier and doesn't filter non-string module specifiers

Features:

• added utilities: isKeywordKind and isValidJsxIdentifier
• exposes typeguards for typescript@3.0 by default

:warning: Breaking Changes:

• Dropped support for typescript@<2.8.0
• Dropped support for Node.js 4
• Removed deprecated APIs:
  • getIdentifierText, isJsxFramgment, ImportOptions
  • deprected overloads of isModifierFlagSet, findImports and getControlFlowEnd
• control flow related symbols can no longer be imported from 'tsutils/util/util', import directly from 'tsutils/util/control-flow' or 'tsutils/util'
• isFunctionScopeBoundary and isBlockScopeBoundary now return a enum member of ScopeBoundary instead of a boolean
• isFunctionScopeBoundary no longer returns a truthy value for InterfaceDeclaration, TypeAliasDeclaration

Features:

• added utility isTypeScopeBoundary returning ScopeBoundary.Type or ScopeBoundary.ConditionalType
• added enum ScopeBoundarySelector whose members can be used to determine if a declaration belongs to a given ScopeBoundary by using bitwise AND

Bugfixes:

• collectVariableUsage now correctly handles infer T nested inside function signatures or mapped types
• isCompilerOptionEnabled correctly handles skipDefaultLibCHeck and suppressImplicitAnyIndexErrors

Features:

• added utility isCompilerOptionEnabled

Typeguards are now split into multiple submodules for each version of TypeScript (starting with 2.8.0). That means you can now import directly from "tsutils/typeguard/2.8" to get compatible declaraton files for TypeScript@2.8. For more information please read the relevant section in README.md.

Features:

• added typeguards: isTupleType, isOptionalTypeNode, isRestTypeNode, isSyntheticExpression (currently available from "tsutils/typeguard/3.0")
• added utility isStrictCompilerOptionEnabled

Avoid crash caused by removed function in typescript@3.0.0.

Added support for TypeScript@3.0.0 nightly builds.

Features:

• added getIIFE utility

Bugfixes:

• forEachComment and forEachTokenWithTrivia no longer duplicate comments around missing nodes

Bugfixes:

• fixed crash in hasSideEffects with tagged template literal without substitution: tag`template`

Features:

• added typeguard isLiteralTypeNode
• added support for type imports (type T = import('foo')) to findImports via ImportKind.ImportType

Bugfixes:

• collectVariableUsage: fixed name lookup in function signatures to match runtime behavior. Note that this is not completely fixed in TypeScript, yet. See: Microsoft/TypeScript#22825 and Microsoft/TypeScript#22769

Features:

• added utilities: isStatementInAmbientContext and isAmbientModuleBlock

Features:

• added typeguards for typescript@2.8: isConditionalTypeNode, isInferTypeNode, isConditionalType, isInstantiableType, isSubstitutionType

Features:

• added typeguard isForInOrOfStatement

Bugfixes:

• correctly handle comments in generic JSX elements: <MyComponent<string>/*comment*/></MyComponent>
• fixed a bug with false positive trailing comments at the end of JSX self closing element: <div><br/>/*no comment*/</div>

Bugfixes:

• collectVariableUsage: handle ConditionalTypes and infer T, which will be introduced in TypeScript@2.8.0 and are already available in nightly builds
• isLiteralType no longer returns true for ts.TypeFlags.BooleanLiteral as this is not a ts.LiteralType

Bugfixes:

• endsControlFlow:
  • handle loops that might not even run a single iteration
  • handle constant boolean conditions in loops and if

Features:

• added isFalsyType utility

Bugfixes:

• fixed compile error with typescript@2.8.0-dev

Bugfixes:

• isReassignmentTarget: handle type assertions and non-null assertion

Bugfixes:

• forEachDeclaredVariable uses a more precise type for the callback parameter to make it useable again with typescript@2.7.1

Features:

• added isUniqueESSymbolType typeguard

Features:

• added isThenableType utility
• added unionTypeParts utility

Bugfixes:

• forEachComment, getCommentAtPosition and isPositionInComment: skip shebang (#! something) to not miss following comments at the start of the file

Features:

• added WrappedAst interface that models the type of a wrapped SourceFile more accurate
• added getWrappedNodeAtPosition utiltiy that takes a NodeWrap and returns the most deeply nested NodeWrap that contains the given position

Features:

• getControlFlowEnd accepts BlockLike as argument

Bugfixes:

• getControlFlowEnd and endsControlFlow: correctly handle nested LabeledStatements
• endsControlFlow removed erroneous special case when an IterationStatement is passed as argument whose parent is a LabeledStatement.
  • if you want labels of an IterationStatement (or SwitchStatement) to be handled, you need to pass the LabeledStatement as argument.
  • :warning: this fix may change the returned value if you relied on the buggy behavior

Deprecations:

• deprecated overload of getControlFlowEnd that contains the label parameter. This parameter is no longer used and should no longer be passed to the function.

Bugfixes:

• getControlFlowEnd and endsControlFlow (#22)
  • ThrowStatements inside try are filtered out if there is a catch clause
  • TryStatements with catch only end control flow if try AND catch definitely end control flow

Features:

• added kind property to NodeWrap
• added getControlFlowEnd to public API

Features:

• added isDecorator and isCallLikeExpression typeguards

Features:

• added convertAst utility to produce a flattened and wrapped version of the AST

Features:

• added isDeleteExpression
• added getLineBreakStyle

Bugfixes:

• fixed name of isJsxFragment

Features:

• added support for JsxFragment introduced in typescript@2.6.2
• added corresponding typeguard functions

Bugfixes:

• endsControlFlow
  • added missing logic for labeled statement, iteration statements and try-catch
  • added missing logic for break and continue with labels
  • take all jump statements into account, not only the last statement
• isValidIdentifier and isValidNumericLiteral handle irregular whitespace
• findImports searches in ambient modules inside regular .ts files (not only .d.ts)
• canHaveJsDoc is now a typeguard

Bugfixes:

• forEachTokenWithTrivia
  • handles irregular whitespace and no longer visits some tokens twice
  • correctly calculates the range of JsxText