Use npm @types/* for 3rd party type definitions (#310)

Author: christopherthielen

package.json

@@ -30,6 +30,13 @@
     "node": ">=0.10.0"
   },
   "dependencies": {
+    "@types/fs-extra": "0.0.33",
+    "@types/handlebars": "^4.0.31",
+    "@types/highlight.js": "^9.1.8",
+    "@types/lodash": "^4.14.37",
+    "@types/marked": "0.0.28",
+    "@types/minimatch": "^2.0.29",
+    "@types/shelljs": "^0.3.32",
     "fs-extra": "^0.30.0",
     "handlebars": "4.0.5",
     "highlight.js": "^9.0.0",

src/lib/converter/context.ts

@@ -230,7 +230,7 @@ export class Context
             return;
         }
 
-        var isDeclaration = ts.isDeclarationFile(node);
+        var isDeclaration = node.isDeclarationFile;
         if (isDeclaration) {
             var lib = this.converter.getDefaultLib();
             var isLib = node.fileName.substr(-lib.length) == lib;

src/lib/converter/converter.ts

@@ -8,6 +8,7 @@ import {Context} from "./context";
 import {ConverterComponent, ConverterNodeComponent, ConverterTypeComponent, ITypeTypeConverter, ITypeNodeConverter} from "./components";
 import {CompilerHost} from "./utils/compiler-host";
 import {Component, Option, ChildableComponent, IComponentClass} from "../utils/component"
+import {normalizePath} from "../utils/fs";
 
 
 /**
@@ -330,7 +331,7 @@ export class Converter extends ChildableComponent<Application, ConverterComponen
      */
     convert(fileNames:string[]):IConverterResult {
         for (var i = 0, c = fileNames.length; i < c; i++) {
-            fileNames[i] = ts.normalizePath(ts.normalizeSlashes(fileNames[i]));
+            fileNames[i] = normalizePath(ts.normalizeSlashes(fileNames[i]));
         }
 
         var program = ts.createProgram(fileNames, this.application.options.getCompilerOptions(), this.compilerHost);

src/lib/converter/plugins/GitHubPlugin.ts

@@ -7,6 +7,16 @@ import {BasePath} from "../utils/base-path";
 import {Converter} from "../converter";
 import {Context} from "../context";
 
+// This should be removed when @typings/shelljs typings are updated to the shelljs version being used
+declare module "shelljs" {
+    // `stdout` was added in:
+    // https://github.com/shelljs/shelljs/commit/8a7f7ceec4d3a77a9309d935755675ac368b1eda#diff-c3bfabb5e6987aa21bc75ffd95a162d6
+    // As of 2016-10-16, DefinitelyTyped's defs are for shelljs v0.3.0, but we're on 0.7.0
+    interface ExecOutputReturnValue {
+        stdout: string;
+        stderr: string;
+    }
+}
 
 /**
  * Stores data of a repository.

src/lib/converter/ts-internal.ts

@@ -0,0 +1,130 @@
+import * as ts from "typescript";
+
+/**
+ * Expose the internal TypeScript APIs that are used by TypeDoc
+ */
+declare module "typescript" {
+  interface Symbol {
+    // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L2166
+    id?: number;
+    // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L2168
+    parent?: ts.Symbol;
+  }
+
+  interface Node {
+    // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L469
+    symbol?: ts.Symbol;
+    // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L472
+    localSymbol?: ts.Symbol;
+    // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L471
+    nextContainer?: ts.Node;
+  }
+
+  /**
+   * These functions are in "core" and are marked as @internal:
+   * https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L4-L5
+   */
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L411
+  // function hasProperty<T>(map: ts.MapLike<T>, key: string): boolean;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L655-L656
+  export function createCompilerDiagnostic(message: ts.DiagnosticMessage, ...args: any[]): ts.Diagnostic;
+  export function createCompilerDiagnostic(message: ts.DiagnosticMessage): ts.Diagnostic;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L701
+  function compareValues<T>(a: T, b: T): number; // Actually returns a ts.Comparison which is internal
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L790
+  function normalizeSlashes(path: string): string;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L795
+  function getRootLength(path: string): number;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L845
+  // function normalizePath(path: string): string;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/core.ts#L852-L854
+  function getDirectoryPath(path: ts.Path): ts.Path;
+  function getDirectoryPath(path: string): string;
+  function getDirectoryPath(path: string): any;
+
+  /**
+   * These functions are in "utilities" and are marked as @internal:
+   * https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L3-L4
+   */
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L188
+  function getSourceFileOfNode(node: ts.Node): ts.SourceFile;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L333
+  function getTextOfNode(node: ts.Node, includeTrivia?: boolean): string;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L438
+  function declarationNameToString(name: ts.DeclarationName);
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L598
+  function getJsDocComments(node: ts.Node, sourceFileOfNode: ts.SourceFile);
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L1487
+  function isBindingPattern(node: ts.Node): node is ts.BindingPattern;
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L1696
+  function getClassExtendsHeritageClauseElement(node: ts.ClassLikeDeclaration | ts.InterfaceDeclaration);
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L1701
+  function getClassImplementsHeritageClauseElements(node: ts.ClassLikeDeclaration);
+
+  // https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/utilities.ts#L1706
+  function getInterfaceBaseTypeNodes(node: ts.InterfaceDeclaration);
+
+
+  /**
+   * https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L2789-L2924
+   * This is large enum of char codes.
+   *
+   * Faking the enum as a var (only certain codes are used by TypeDoc)
+   */
+  var CharacterCodes: {
+    [key: string]: number;
+    doubleQuote: number;
+    space: number;
+    minus: number;
+    at: number;
+  };
+
+  /**
+   * https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L2334
+   * Duplicating the interface definition :(
+   */
+  // interface IntrinsicType extends ts.Type {
+  //   intrinsicName: string;
+  // }
+
+  const optionDeclarations: CommandLineOption[];
+
+  /**
+   * Command line options
+   */
+  interface CommandLineOption {
+    name: string;
+    type: string;
+    shortName: string;
+    description: DiagnosticsEnumValue;
+    paramType: DiagnosticsEnumValue;
+  }
+
+  const Diagnostics: {
+    [key: string]: DiagnosticsEnumValue;
+    FILE: DiagnosticsEnumValue;
+    DIRECTORY: DiagnosticsEnumValue;
+  };
+
+  interface DiagnosticsEnumValue {
+    code: number;
+    category: ts.DiagnosticCategory;
+    key: string;
+    message: string;
+  }
+
+}

src/lib/converter/types/intrinsic.ts

@@ -4,15 +4,22 @@ import {Type, IntrinsicType} from "../../models/index";
 import {Component, ConverterTypeComponent, ITypeTypeConverter} from "../components";
 import {Context} from "../context";
 
+// TypeScript has an @internal enum set for the intrinsic types:
+// https://github.com/Microsoft/TypeScript/blob/v2.0.5/src/compiler/types.ts#L2297-L2298
+// It is not included in the typescript typings, so the enum is cast as `any` to access the `Intrinsic` set.
+const IntrinsicTypeFlags = (ts.TypeFlags as any).Intrinsic;
+if (IntrinsicTypeFlags === undefined) {
+    throw new Error("Internal TypeScript API missing: TypeFlags.Intrinsic");
+}
 
 @Component({name:'type:intrinsic'})
-export class IntrinsicConverter extends ConverterTypeComponent implements ITypeTypeConverter<ts.IntrinsicType>
+export class IntrinsicConverter extends ConverterTypeComponent implements ITypeTypeConverter<ts.Type>
 {
     /**
      * Test whether this converter can handle the given TypeScript type.
      */
-    supportsType(context:Context, type:ts.IntrinsicType):boolean {
-        return !!(type.flags & ts.TypeFlags.Intrinsic);
+    supportsType(context:Context, type:ts.Type):boolean {
+        return !!(type.flags & IntrinsicTypeFlags);
     }
 
 
@@ -28,7 +35,8 @@ export class IntrinsicConverter extends ConverterTypeComponent implements ITypeT
      * @param type  The intrinsic type that should be converted.
      * @returns The type reflection representing the given intrinsic type.
      */
-    convertType(context:Context, type:ts.IntrinsicType):IntrinsicType {
-        return new IntrinsicType(type.intrinsicName);
+    convertType(context:Context, type:ts.Type):IntrinsicType {
+        let intrinsicName = context.program.getTypeChecker().typeToString(type);
+        return new IntrinsicType(intrinsicName);
     }
 }

src/lib/converter/utils/compiler-host.ts

@@ -2,6 +2,7 @@ import * as ts from "typescript";
 import * as Path from "path";
 
 import {ConverterComponent} from "../components";
+import {normalizePath} from "../../utils/fs";
 
 
 /**
@@ -56,7 +57,7 @@ export class CompilerHost extends ConverterComponent implements ts.CompilerHost
      */
     getDefaultLibFileName(options:ts.CompilerOptions):string {
         var lib = this.owner.getDefaultLib();
-        var path = ts.getDirectoryPath(ts.normalizePath(require.resolve('typescript')));
+        var path = ts.getDirectoryPath(normalizePath(require.resolve('typescript')));
         return Path.join(path, lib);
     }
 

src/lib/utils/fs.ts

@@ -15,7 +15,7 @@ var existingDirectories:ts.MapLike<boolean> = {};
  * @returns The normalized path.
  */
 export function normalizePath(path:string) {
-    return ts.normalizePath(path);
+    return path.replace(/\\/g, "/");
 }
 
 
@@ -26,7 +26,7 @@ export function normalizePath(path:string) {
  * @returns TRUE if the given directory exists, FALSE otherwise.
  */
 export function directoryExists(directoryPath: string): boolean {
-    if (ts.hasProperty(existingDirectories, directoryPath)) {
+    if (existingDirectories.hasOwnProperty(directoryPath)) {
         return true;
     }
 
@@ -65,7 +65,7 @@ export function ensureDirectoriesExist(directoryPath: string) {
  */
 export function writeFile(fileName:string, data:string, writeByteOrderMark:boolean, onError?:(message:string) => void) {
     try {
-        ensureDirectoriesExist(ts.getDirectoryPath(ts.normalizePath(fileName)));
+        ensureDirectoriesExist(ts.getDirectoryPath(normalizePath(fileName)));
         ts.sys.writeFile(fileName, data, writeByteOrderMark);
     } catch (e) {
         if (onError) onError(e.message);