#185 - Add documentation about includeTsNodes. Change includeCompilerNodes -> includeTsNodes.

Author: dsherret

readme.md

@@ -8,7 +8,7 @@
 
 Uses the [TypeScript Compiler API](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API) to get information about TypeScript code in an easy to use format.
 
-* [Version 6.0 information](https://github.com/dsherret/ts-type-info/wiki/What%27s-New) - TypeScript 2.0 support
+* [Version 6.1 information](https://github.com/dsherret/ts-type-info/wiki/What%27s-New)
 
 ```
 npm install ts-type-info --save-dev
@@ -123,3 +123,20 @@ abstract class MyClass {
 
 * [Server Bridge](https://github.com/dsherret/server-bridge) - Automatically generates client side code to communicate with the server from the server side code.
 * [TsObjectCreate](https://github.com/dsherret/ts-object-create) - Code generation that writes functions for creating objects with their types.
+
+## Include tsNodes
+
+In case there's something you need from the compiler that's not implemented in this library, set the `includeTsNodes` option to true.
+This will include the TypeScript compiler nodes in the `tsNode` property of most objects.
+
+```typescript
+import * as ts from "typescript";
+import * as TsTypeInfo from "ts-type-info";
+
+const result = TsTypeInfo.getInfoFromFiles(["V:\\TestFile.ts"], { includeTsNodes: true });
+const typeChecker = result.getTypeChecker(); // ts.TypeChecker in case you need it
+const myMethod = result.getFile("TestFile.ts").getClass("MyClass").getMethod("myMethod");
+const myMethodNode = myMethod.tsNode as ts.MethodDeclaration;
+
+console.log(myMethodNode.body.statements[0].getText()); // "return `Test: ${myParameter}`;"
+```

src/binders/ts/base/TsNodedBinder.ts

@@ -8,6 +8,6 @@ export class TsNodedBinder extends NodedBinder {
     }
 
     getTsNode() {
-        return this.factory.getShouldIncludeCompilerNodes() ? this.node.getUnderlyingNode() : undefined;
+        return this.factory.getShouldincludeTsNodes() ? this.node.getUnderlyingNode() : undefined;
     }
 }

src/factories/TsFactory.ts

@@ -14,11 +14,11 @@ export class TsFactory {
     private readonly deferredBindings: { binder: binders.IBaseBinder; definition: definitions.BaseDefinition; }[] = [];
     private readonly createdTypesWithDefinition: { type: TsType; definition: definitions.BaseTypeDefinition; }[] = [];
 
-    constructor(private readonly settings: { includeCompilerNodes: boolean; }) {
+    constructor(private readonly settings: { includeTsNodes: boolean; }) {
     }
 
-    getShouldIncludeCompilerNodes() {
-        return this.settings.includeCompilerNodes;
+    getShouldincludeTsNodes() {
+        return this.settings.includeTsNodes;
     }
 
     getCallSignatureFromNode(node: TsNode) {

src/main.ts

@@ -20,12 +20,12 @@ export function getInfoFromFiles(fileNames: string[], options?: Options): Global
     }
 
     options = options || {};
-    const {includeCompilerNodes = false, showDebugMessages = false} = options;
+    const {includeTsNodes = false, showDebugMessages = false} = options;
 
     Logger.toggleEnabled(showDebugMessages);
 
     const tsMain = new TsMain(fileNames, options);
-    const tsFactory = new TsFactory({ includeCompilerNodes });
+    const tsFactory = new TsFactory({ includeTsNodes });
 
     const fileDefinitions = tsMain.getSourceFiles().map(sourceFile => tsFactory.getFileDefinition(sourceFile));
 
@@ -34,7 +34,7 @@ export function getInfoFromFiles(fileNames: string[], options?: Options): Global
 
     const globalDef = new GlobalDefinition();
     globalDef.files = fileDefinitions;
-    if (includeCompilerNodes)
+    if (includeTsNodes)
         globalDef.typeChecker = tsMain.getTypeScriptTypeChecker();
     return globalDef;
 }

src/options.ts

@@ -1,7 +1,7 @@
 export interface Options {
     compilerOptions?: CompilerOptions;
     showDebugMessages?: boolean;
-    includeCompilerNodes?: boolean;
+    includeTsNodes?: boolean;
 }
 
 // options copied from typescript.d.ts

src/tests/definitions/globalDefinitionTests.ts

@@ -208,13 +208,13 @@ describe("GlobalDefinition", () => {
     describe("typeChecker", () => {
         const fileName = path.join(__dirname, "../../../src/tests/testFiles/nonTsFile.js");
 
-        describe("includeCompilerNodes true", () => {
-            const result = getInfoFromFiles([fileName], { includeCompilerNodes: true });
+        describe("includeTsNodes true", () => {
+            const result = getInfoFromFiles([fileName], { includeTsNodes: true });
             assert.equal(typeof result.typeChecker !== "undefined", true);
         });
 
-        describe("includeCompilerNodes false", () => {
-            const result = getInfoFromFiles([fileName], { includeCompilerNodes: false });
+        describe("includeTsNodes false", () => {
+            const result = getInfoFromFiles([fileName], { includeTsNodes: false });
             assert.equal(typeof result.typeChecker === "undefined", true);
         });
     });

src/tests/issues/184/184.ts

@@ -5,7 +5,7 @@ import {getInfoFromFiles} from "./../../../main";
 
 describe("Issue #184", () => {
     const fileName = path.join(__dirname, "../../../../src/tests/issues/184/testFile.ts");
-    const result = getInfoFromFiles([fileName], { includeCompilerNodes: true });
+    const result = getInfoFromFiles([fileName], { includeTsNodes: true });
     const classDef = result.getFile("testFile.ts")!.getClass("MyClass")!;
 
     classDef.methods.forEach(methodDef => {

src/tests/languageTests/class/classNodedTests.ts

@@ -15,7 +15,7 @@ class MyClass {
 }`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.classes[0]);

src/tests/languageTests/enum/enumNodedTests.ts

@@ -8,7 +8,7 @@ enum MyEnum {
 }`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.enums[0]);

src/tests/languageTests/expression/typeNodeNodedTests.ts

@@ -5,7 +5,7 @@ describe("type node noded tests", () => {
     const code = `var test: string;`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTestsForNonNamed(def.variables[0].type.node!);

src/tests/languageTests/file/fileNodedTests.ts

@@ -10,7 +10,7 @@ export * from "./file";
 `;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTestsForNonNamed(def);

src/tests/languageTests/function/functionNodedTests.ts

@@ -7,7 +7,7 @@ function myFunction(param: string): void;
 function myFunction(param: any) { }`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.functions[0]);

src/tests/languageTests/general/decoratorNodedTests.ts

@@ -11,7 +11,7 @@ class MyClass1 {
 }`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.classes[0].decorators[0]);

src/tests/languageTests/general/objectPropertyNodedTests.ts

@@ -5,7 +5,7 @@ describe("object property noded tests", () => {
     const code = `function myFunc({ t = 4 }: { t: number; }) {}`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.functions[0].parameters[0].destructuringProperties[0]);

src/tests/languageTests/general/typeAliasNodedTests.ts

@@ -5,7 +5,7 @@ describe("type alias noded tests", () => {
     const code = `type MyType = "string";`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.typeAliases[0]);

src/tests/languageTests/general/typeParameterNodedTests.ts

@@ -5,7 +5,7 @@ describe("type parameter noded tests", () => {
     const code = `interface MyInterface<T> {}`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.interfaces[0].typeParameters[0]);

src/tests/languageTests/general/userDefinedTypeGuardNodedTests.ts

@@ -5,7 +5,7 @@ describe("user defined type guard noded tests", () => {
     const code = `function myFunction(obj: MyClass): obj is MyOtherClass {}`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTestsForNonNamed(def.functions[0].userDefinedTypeGuard!);

src/tests/languageTests/interface/interfaceNodedTests.ts

@@ -12,7 +12,7 @@ interface MyInterface {
 `;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.interfaces[0]);

src/tests/languageTests/namespace/namespaceNodedTests.ts

@@ -5,7 +5,7 @@ describe("namespace noded tests", () => {
     const code = `namespace MyNamespace{}`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.namespaces[0]);

src/tests/languageTests/variable/variableNodedTests.ts

@@ -5,7 +5,7 @@ describe("variable noded tests", () => {
     const code = `var myVar: any;`;
 
     const def = getInfoFromString(code, {
-        includeCompilerNodes: true
+        includeTsNodes: true
     });
 
     runNodedDefinitionTests(def.variables[0]);

ts-type-info.d.ts

@@ -8,7 +8,7 @@ export function getInfoFromString(code: string, options?: Options | undefined):
 export interface Options {
     compilerOptions?: CompilerOptions | undefined;
     showDebugMessages?: boolean | undefined;
-    includeCompilerNodes?: boolean | undefined;
+    includeTsNodes?: boolean | undefined;
 }
 
 export interface CompilerOptions {
@@ -720,6 +720,7 @@ export const VariableDeclarationType: { Var: VariableDeclarationType; Let: Varia
 
 export class GlobalDefinition {
     files: FileDefinition[];
+    typeChecker?: ts.TypeChecker | undefined;
 
     addDefinitionAsImportToFile(opts: { definition: ExportableDefinitions; file: FileDefinition; alias?: string | undefined; }): void;
     addFile(structure: FileStructure): FileDefinition;