Feature: interface plugin (#12)

Author: DeividasBakanas

common/config/rush/npm-shrinkwrap.json

@@ -52,9 +52,9 @@ public GetFoo(arg: string | number): string
 ```
 #### Parameters
 
-| Name | Type             |
-| ---- | ---------------- |
-| arg  | string \| number |
+| Name | Type                 |
+| ---- | -------------------- |
+| arg  | string | number |
 
 
 ## Properties

packages/ts-docs-gen/examples/simple/docs/api/index.md

@@ -1,5 +1,94 @@
 // tslint:disable
 
+export interface ExtendedBar extends Foo<number>, Boo {
+    OtherStuff: string[];
+}
+
+export interface Foo<TType> {
+    Name: string;
+    Surname: string;
+    Type: TType;
+}
+
+export interface Boo {
+    Boos: string[];
+}
+
+export interface AnotherInterface {
+    <TValue>(param1: TValue, param2: TValue): boolean;
+}
+
+export interface MyConstraintType {
+    myProperty: string;
+}
+
+export interface MyDefaultType extends MyConstraintType {
+    anotherProperty: number;
+}
+
+export interface ObjectsInterface {
+    objectOne: Object;
+    objectTwo: Object;
+}
+
+export interface InterfaceWithCall {
+    <T>(): { someProperty: T };
+}
+
+export interface InterfaceWithConstraintType extends Dictionary<string> {
+    someProperty: string;
+}
+
+export interface InterfaceWithMethod<T> {
+    someMethodOne(): T;
+    someMethodTwo<TReturn>(): TReturn;
+}
+
+export interface Dictionary<TValue> {
+    new(): Dictionary<TValue>;
+    [key: string]: TValue;
+}
+
+export interface MethodsInterface {
+    someMethod<T>(): string;
+    <TValue>(arg: TValue): void;
+}
+
+/**
+ * Monster interface
+ * @beta
+ * @deprecated
+ */
+export interface MonsterInterface<TValue extends Object = {}> extends ObjectsInterface {
+    new <T>(): MonsterInterface<T>;
+    new(someParameter: string): string;
+
+    readonly [key: string]: TValue;
+
+    <T>(): { someProperty: T };
+    <T>(key?: string): { someProperty: T };
+    <T>(key: number): { someProperty: T };
+
+    readonly objectOne: TValue;
+    objectTwo: TValue;
+}
+
+export interface SomeInterface {
+    [key: string]: string | number;
+    [key: number]: string;
+}
+
+export interface StringsDictionary {
+    [key: string]: string;
+}
+
+export interface MyInterface {
+    MyPropertyOne: string;
+    MyPropertyTwo: Object;
+    MyPropertyThree: number;
+}
+
+
 // import { Foo } from "./exported-functions";
 
 // export class World { }
@@ -211,18 +300,18 @@
 //     }
 // }
 
-export class Hello {
-    /**
-     * This is a constructor
-     * @param arg This is an argument ;)
-     */
-    constructor(arg: string) { }
+// export class Hello {
+//     /**
+//      * This is a constructor
+//      * @param arg This is an argument ;)
+//      */
+//     constructor(arg: string) { }
 
-    GetFoo(arg: number): string
-    GetFoo(arg: string): string
-    GetFoo(arg: string | number): string {
-        throw new Error("Method not implemented.");
-    }
+//     GetFoo(arg: number): string
+//     GetFoo(arg: string): string
+//     GetFoo(arg: string | number): string {
+//         throw new Error("Method not implemented.");
+//     }
 
-    public Foo: string;
-}
+//     public Foo: string;
+// }

packages/ts-docs-gen/examples/simple/docs/api/index/hello.md

@@ -15,12 +15,12 @@
   "engine": "node >= 7.5.0",
   "author": "simplrjs <simplr@quatrodev.com> (https://github.com/simplrjs)",
   "dependencies": {
-    "@simplrjs/markdown": "^1.0.3",
+    "@simplrjs/markdown": "^1.0.7",
     "@types/fs-extra": "^5.0.0",
     "fast-glob": "^1.0.1",
     "fs-extra": "^5.0.0",
     "simplr-logger": "^1.0.1",
-    "ts-extractor": "^3.0.1",
+    "ts-extractor": "^3.0.3",
     "typescript": "^2.6.2"
   },
   "devDependencies": {

packages/ts-docs-gen/examples/simple/index.ts

@@ -4,6 +4,9 @@ import { ApiEnumPlugin } from "./plugins/api-enum-plugin";
 import { ApiFunctionPlugin } from "./plugins/api-function-plugin";
 import { ApiTypePlugin } from "./plugins/api-type-plugin";
 import { ApiNamespacePlugin } from "./plugins/api-namespace-plugin";
+import { ApiInterfacePlugin } from "./plugins/api-interface-plugin";
+import { ApiCallablePlugin } from "./plugins/api-callable-plugin";
+import { ApiIndexPlugin } from "./plugins/api-index-plugin";
 import { ApiClassPlugin } from "./plugins/api-class-plugin";
 import { ApiClassConstructorPlugin } from "./plugins/api-class-constructor-plugin";
 import { ApiClassMethodPlugin } from "./plugins/api-class-method-plugin";
@@ -16,6 +19,9 @@ export const DefaultPlugins = [
     new ApiFunctionPlugin(),
     new ApiTypePlugin(),
     new ApiNamespacePlugin(),
+    new ApiInterfacePlugin(),
+    new ApiCallablePlugin(),
+    new ApiIndexPlugin(),
     new ApiClassPlugin(),
     new ApiClassConstructorPlugin(),
     new ApiClassMethodPlugin(),