tsc-ts 0.0.3 → 0.0.4

package/README.md

@@ -38,3 +38,17 @@ npx tsc-ts --noEmit src/index.ts
 The native executable never frees syntax trees, types, signatures or symbols: it keeps them until it exits, which saves the cost of tracking them during a build. A one-shot build is unaffected, but a long-running process grows with each rebuild or project update. Native `--watch` (also with `--build`) runs in a child process, and when a change arrives while that process holds more than 2.5 times the memory it held after its first build, a new process replaces it and builds the change, reporting what the old process would have. `TSC_TS_WATCH_MEMORY` sets that limit in megabytes, and `TSC_TS_WATCH_MEMORY=0` turns the replacement off. A `--api` process grows with each project update; restart it to reclaim the memory.
 
 The default lib files (`lib.*.d.ts`) ship next to the executable. Set `TSC_TS_LIB_DIR` to use another directory.
+
+## Programmatic API
+
+`tsc-ts/api` describes tsc-ts's programs, checkers, nodes, symbols, types and signatures in TypeScript, with the names and numbering of TypeScript 7's API (`typescript/unstable/sync`): the node interfaces, `Symbol`, `Type` and its kinds, `Signature`, `IndexInfo`, `TypePredicate`, `Diagnostic`, `Program`, `TypeChecker`, `CompilerOptions`, and the enums `SyntaxKind`, `NodeFlags`, `ModifierFlags`, `TokenFlags`, `SymbolFlags`, `TypeFlags`, `ObjectFlags`, `ElementFlags`, `SignatureFlags`, `SignatureKind`, `IndexKind`, `TypePredicateKind`, `TypeFormatFlags`, `NodeBuilderFlags`, `ScriptTarget`, `ModuleKind`, `ModuleResolutionKind`, `ModuleDetectionKind`, `ScriptKind`, `LanguageVariant`, `JsxEmit`, `NewLineKind`, `DiagnosticCategory` and `InternalSymbolName`.
+
+```ts
+import { SyntaxKind, type Node } from 'tsc-ts/api';
+
+const isIdentifier = (node: Node): boolean => node.kind === SyntaxKind.Identifier;
+```
+
+Lists of child nodes are `NodeList` objects: `node.arguments.nodes` holds the nodes, and `pos` and `end` the list's range. `symbolName(symbol)` gives a symbol's name as TypeScript 7's API does (`__call`, `export=`).
+
+The package has a JavaScript build with declaration files for Node.js, and the TypeScript sources of the API (the `source` export condition) for compilers that build it from source.

package/dist/api/library/ast.d.ts

@@ -0,0 +1,73 @@
+import type { EndOfFile, EntityName, Identifier, KeywordSyntaxKind, ModifierSyntaxKind, PropertyAccessExpression, PunctuationSyntaxKind, Statement, ThisExpression, Token } from './ast.generated.js';
+import type { LanguageVariant, ModifierFlags, NodeFlags, ScriptKind, SyntaxKind } from './enums.generated.js';
+export interface TextRange {
+    readonly pos: number;
+    readonly end: number;
+}
+/**
+ * A node. `pos` is where the node's leading trivia starts and `end` where the node ends, as UTF-16
+ * offsets into the file's text; `tokenStartOfNode` gives the start of its first token. `parent` is the
+ * enclosing node, and the source file for its statements; a source file's `parent` is undefined.
+ */
+export interface Node extends TextRange {
+    readonly kind: SyntaxKind;
+    readonly flags: NodeFlags;
+    readonly parent: Node;
+}
+/** The children of a node in one list: `nodes`, and the range from the list's opening to its closing token. */
+export interface NodeList<T extends Node = Node> extends TextRange {
+    readonly nodes: readonly T[];
+    /** Whether a comma follows the last node before the list's end. */
+    hasTrailingComma(): boolean;
+}
+/** The modifiers of a declaration, with the flags of all of them. */
+export interface ModifierList<T extends Node = Node> extends NodeList<T> {
+    readonly modifierFlags: ModifierFlags;
+}
+/** A `/// <reference path>`, `types` or `lib` directive. */
+export interface FileReference extends TextRange {
+    readonly fileName: string;
+    /** The `resolution-mode` attribute: ModuleKind.ESNext, ModuleKind.CommonJS, or ModuleKind.None without one. */
+    readonly resolutionMode: number;
+    readonly preserve: boolean;
+}
+export interface LineAndCharacter {
+    /** 0-based line number. */
+    readonly line: number;
+    /** 0-based character offset, in UTF-16 code units, from the start of the line. */
+    readonly character: number;
+}
+export interface SourceFile extends Node {
+    readonly kind: SyntaxKind.SourceFile;
+    readonly statements: NodeList<Statement>;
+    readonly endOfFileToken: EndOfFile;
+    readonly text: string;
+    readonly fileName: string;
+    /** The file's path: its absolute, normalized file name, lower-cased where file names are case-insensitive. */
+    readonly path: string;
+    readonly languageVariant: LanguageVariant;
+    readonly scriptKind: ScriptKind;
+    readonly isDeclarationFile: boolean;
+    readonly referencedFiles: readonly FileReference[];
+    readonly typeReferenceDirectives: readonly FileReference[];
+    readonly libReferenceDirectives: readonly FileReference[];
+    /** The module specifiers of the file's imports, exports, `require` calls and import types, in source order. */
+    readonly imports: readonly Node[];
+    readonly moduleAugmentations: readonly Node[];
+    readonly ambientModuleNames: readonly string[];
+    /** The first import or export that makes the file a module, or undefined for a script. */
+    readonly externalModuleIndicator: Node | undefined;
+}
+export type PunctuationToken<TKind extends PunctuationSyntaxKind> = Token<TKind>;
+export type KeywordToken<TKind extends KeywordSyntaxKind> = Token<TKind>;
+export type ModifierToken<TKind extends ModifierSyntaxKind> = KeywordToken<TKind>;
+export interface PropertyAccessEntityNameExpression extends PropertyAccessExpression {
+    readonly expression: EntityNameExpression;
+    readonly name: Identifier;
+}
+export type EntityNameExpression = Identifier | PropertyAccessEntityNameExpression;
+export type EntityNameOrEntityNameExpression = EntityName | EntityNameExpression;
+export interface JsxTagNamePropertyAccess extends PropertyAccessExpression {
+    readonly expression: Identifier | ThisExpression | JsxTagNamePropertyAccess;
+}
+export * from './ast.generated.js';