basic docs and a demo JS file.

Author: nycdotnet

README.md

@@ -0,0 +1,65 @@
+# csproj2ts
+
+Queries a Visual Studio project file (.csproj or .vbproj) for TypeScript configuration information.  Will also find default config in a `Microsoft.TypeScript.Default.props` file, if referenced.
+
+Tested with project configuration settings in TypeScript 1.4.
+
+Run `node demo.js` for a working example (assumes `csproj2ts.csproj` in current folder).
+
+## Example Usage:
+```javascript
+
+    var csproj2ts = require('csproj2ts');
+    
+    var vsProjInfo = {
+        ProjectFileName: "path/to/my/project.csproj", // the name and path to the project file
+        ActiveConfiguration: "Release"                // the MSBuild config to query
+    }
+
+    csproj2ts.getTypeScriptSettings(vsProjInfo).then(function (settings) {
+        console.log(settings.files);          // will output the array of files
+        console.log(settings.RemoveComments); // will output true or false.
+        console.log(settings.OutDir);         // will output the OutDir string or undefined.
+    });
+
+```
+
+## API:
+
+The returned settings object has the following documented properties:
+
+  * files: string[] - This is an array of the files that will be compiled.
+  * VSProjectDetails - This object has the following properties:
+    * ProjectFileName: string
+    * MSBuildExtensionsPath32: string
+    * VisualStudioVersion: string
+    * ActiveConfiguration: string
+    * DefaultProjectConfiguration?: string;
+    * DefaultVisualStudioVersion?: string;
+    * TypeScriptDefaultPropsFilePath: string;
+    * NormalizedTypeScriptDefaultPropsFilePath: string;
+    * TypeScriptDefaultConfiguration: - this property has the settings (seen below) that correspond to the defaults on the referenced .props file.
+
+
+The returned settings object has the following properties that correspond to TypeScript configuration settings:
+
+  * AdditionalFlags?: string;
+  * Charset?: string;
+  * CodePage?: string;
+  * CompileOnSaveEnabled?: boolean;
+  * EmitBOM?: boolean;
+  * GeneratesDeclarations?: boolean;
+  * MapRoot?: string;
+  * ModuleKind?: string;
+  * NoEmitOnError?: boolean;
+  * NoImplicitAny?: boolean;
+  * NoLib?: boolean;
+  * NoResolve?: boolean;
+  * OutFile?: string;
+  * OutDir?: string;
+  * PreserveConstEnums?: boolean;
+  * RemoveComments?: boolean;
+  * SourceMap?: boolean;
+  * SourceRoot?: string;
+  * SuppressImplicitAnyIndexErrors?: boolean;
+  * Target?: string;

csproj2ts.csproj

@@ -64,6 +64,7 @@
     <TypeScriptCompile Include="typings\xml2js\xml2js.d.ts" />
   </ItemGroup>
   <ItemGroup>
+    <Content Include="demo.js" />
     <Content Include="gruntfile.js" />
   </ItemGroup>
   <ItemGroup>
@@ -72,6 +73,9 @@
   <ItemGroup>
     <Content Include="tsd.json" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="README.md" />
+  </ItemGroup>
   <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
     <TypeScriptModuleKind>commonjs</TypeScriptModuleKind>
     <TypeScriptNoImplicitAny>True</TypeScriptNoImplicitAny>

demo.js

@@ -0,0 +1,12 @@
+var csproj2ts = require('./csproj2ts');
+
+var vsProjInfo = {
+    ProjectFileName: "csproj2ts.csproj",
+    ActiveConfiguration: "Debug"
+}
+
+csproj2ts.getTypeScriptSettings(vsProjInfo).then(function (settings) {
+    console.log(settings);
+}).catch(function (error) {
+    console.log(error);
+});