added example

.gitignore

@@ -192,4 +192,4 @@ typescript-json-schema/dist/typescript-json-schema.js.map
 .ntvs_analysis.dat
 dist/typescript-json-schema.js.map
 typescript-json-schema.sln
-typescript-json-schema.sln
+local.ts

README.md

@@ -6,11 +6,14 @@ Inspired and builds upon [Typson](https://github.com/lbovet/typson/).
 
 ## Features
 * Compiles your Typescript program to get complete type information.
-* Translates required properties, extends, enums, maps, annotation keywords.
+* Translates required properties, extends, annotation keywords, property intializers as defaults.
 
 ## Usage
 
 ### Node.js
 
 * Install with `npm install typescript-json-schema -g`
-* Generate schema from a typescript type: `typescript-json-schema project/directory/**/*.ts fully.qualified.type.to.generate`
+* Generate schema from a typescript type: `typescript-json-schema project/directory/**/*.ts fully.qualified.type.to.generate`
+
+## TODO
+* better support for maps, enums

example/invoice/line.ts

@@ -0,0 +1,38 @@
+/// <reference path="../misc/dimension.ts"/>
+/// <reference path="../product.ts"/>
+
+/**
+ * Represents the document sent to the customer for payment.
+ */
+interface Invoice {
+    /**
+     * Who will pay?
+     * Not me!
+     */
+    customer: string;
+
+    /**
+     * Invoice content
+     * @minItems 1
+     * @maxItems 50
+     */
+    lines: InvoiceLine[];
+
+    dimension: Dimension; // Total dimension of the order
+
+    blob: any; // Additional stuff
+}
+
+interface InvoiceLine {
+
+    product: Product;
+
+    /**
+     * @minimum 0
+     * @exclusiveMinimum true
+     * @maximum 10
+     * @exclusiveMaximum false
+     * @multipleOf 2
+     */
+    quantity: number;
+}

example/misc/dimension.ts

@@ -0,0 +1,11 @@
+// Typescript-JSON-Schema can handle defaults in classes as illustrated below
+class Dimension {
+    /** Width in cm */
+        width: number = 10;
+
+    /** Height in cm */
+        height: number = 10;
+
+    /** Length in cm */
+        length:  number = 10;
+}

example/product.ts

@@ -0,0 +1,28 @@
+/// <reference path="misc/dimension.ts"/>
+
+interface Product {
+    /**
+     * Uniquely defines the product
+     * @pattern [A-Z][a-z][0-9]_
+     */
+    name: string;
+
+    /** How big it is */
+    dimension?: Dimension;
+
+    /** Classification */
+    category: Category;
+}
+
+interface WeightedProduct extends Product {
+    weight: number;
+}
+
+interface Category {
+    /** Uniquely identifies the category */
+    name: string;
+
+    /** Classification level from 1 to 5 (highest)
+     * @type integer */
+    level: number;
+}

typescript-json-schema.njsproj

@@ -59,7 +59,6 @@
   <!-- Do not delete the following Import Project.  While this appears to do nothing it is a marker for setting TypeScript properties before our import that depends on them. -->
   <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
     <TypeScriptOutDir>dist</TypeScriptOutDir>
-    <TypeScriptOutFile>typescript-json-schema.js</TypeScriptOutFile>
   </PropertyGroup>
   <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TypeScript\Microsoft.TypeScript.targets" Condition="False" />
   <Import Project="$(VSToolsPath)\Node.js Tools\Microsoft.NodejsTools.targets" />

typescript-json-schema.ts

@@ -244,12 +244,11 @@ export module TJS {
 
             program.getSourceFiles().forEach(sourceFile => {
                 function inspect(node: ts.Node, tc: ts.TypeChecker) {
-                    if (node.kind == ts.SyntaxKind.ClassDeclaration) {
-                        let clazz = <ts.ClassDeclaration>node;
-                        let clazzType = tc.getTypeAtLocation(clazz);
-                        let fullName = tc.typeToString(clazzType, undefined, ts.TypeFormatFlags.UseFullyQualifiedType);
-                        allSymbols[fullName] = clazzType;
-                        clazzType.getBaseTypes().forEach(baseType => {
+                    if (node.kind == ts.SyntaxKind.ClassDeclaration || node.kind == ts.SyntaxKind.InterfaceDeclaration) {
+                        let nodeType = tc.getTypeAtLocation(node);
+                        let fullName = tc.typeToString(nodeType, undefined, ts.TypeFormatFlags.UseFullyQualifiedType);
+                        allSymbols[fullName] = nodeType;
+                        nodeType.getBaseTypes().forEach(baseType => {
                             let baseName = tc.typeToString(baseType, undefined, ts.TypeFormatFlags.UseFullyQualifiedType);
                             if (!inheritingTypes[baseName]) {
                                 inheritingTypes[baseName] = [];
@@ -288,9 +287,6 @@ if (typeof window === "undefined" && require.main === module) {
     }
 }
 
-
-//var files: string[] = glob.sync("C:/Users/Yousef/Documents/Programming/tweetbeam-client/Beam/**/*.ts");
-//var outFile = "C:/Users/Yousef/Documents/Programming/JavaWorkspace/TweetBeam/resources/schemas/settings.json";
-//var fullTypeName = "beam.Settings";
-
-//node typescript-json-schema.js C:/Users/Yousef/Documents/Programming/tweetbeam-client/Beam/**/*.ts beam.Settings
+//TJS.exec("example/**/*.ts", "Invoice");
+//node typescript-json-schema.js example/**/*.ts Invoice
+debugger;