Added special README.md to distributions and updated gulp tasks to help.

Added publish.cmd to automatically publish all of them.
electricessence · Jun 11, 2016 · 6c07c26 · 6c07c26
1 parent f2516bc
commit 6c07c26
Show file tree

Hide file tree

Showing 16 changed files with 111 additions and 18 deletions.
diff --git a/.npmignore b/.npmignore
@@ -11,7 +11,7 @@ tests
 coverage
 documentation
 typings
-coverage.bat
+coverage.cmd
 .npmignore
 test.js
 tsc-flags.txt

diff --git a/README.md b/README.md
@@ -59,20 +59,18 @@ Version 2.5 was the first NPM release.  The goal is to get this as user friendly
 ***All distributions contain source-maps.***  
 https://www.npmjs.com/search?q=typescript-dotnet  
 
-#### Universal Module Definition (UMD)
+#### [Universal Module Definition (UMD)](https://www.npmjs.com/package/typescript-dotnet-umd)
 ```
 npm install typescript-dotnet-umd
 ```
 
 It's highly recommended to use the UMD (minified) version for most cases since it works for AMD and CommonJS.
 
 #### Other Published NPM Module Types
-```
-typescript-dotnet-es6
-typescript-dotnet-commonjs
-typescript-dotnet-amd
-typescript-dotnet-system
-```
+* [```typescript-dotnet-es6```](https://www.npmjs.com/package/typescript-dotnet-es6)
+* [```typescript-dotnet-commonjs```](https://www.npmjs.com/package/typescript-dotnet-commonjs)
+* [```typescript-dotnet-amd```](https://www.npmjs.com/package/typescript-dotnet-amd)
+* [```typescript-dotnet-system```](https://www.npmjs.com/package/typescript-dotnet-system)
 
 Install on only the module type you need in order to avoid type collisions.
 

diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
 	"name": "typescript-dotnet",
-	"version": "3.0.1",
+	"version": "3.0.2",
 	"ignore": [
 		".bowercc",
 		".gitignore",

diff --git a/coverage.bat → coverage.cmd b/coverage.bat → coverage.cmd
diff --git a/dist/README.md b/dist/README.md
@@ -0,0 +1,21 @@
+This package is a distribution for [typescript-dotnet](https://www.npmjs.com/package/typescript-dotnet).  
+https://www.npmjs.com/package/typescript-dotnet
+
+The [typescript-dotnet](https://www.npmjs.com/package/typescript-dotnet) package includes the source code along with unminified UMD JavaScript and will function perfectly within another project but requires a reference to the ```/source/``` folder.
+
+It is recommended you select the module type that you intend to use:
+
+* [```typescript-dotnet-umd```](https://www.npmjs.com/package/typescript-dotnet-umd)
+* [```typescript-dotnet-es6```](https://www.npmjs.com/package/typescript-dotnet-es6)
+* [```typescript-dotnet-commonjs```](https://www.npmjs.com/package/typescript-dotnet-commonjs)
+* [```typescript-dotnet-amd```](https://www.npmjs.com/package/typescript-dotnet-amd)
+* [```typescript-dotnet-system```](https://www.npmjs.com/package/typescript-dotnet-system)
+
+**Example:**
+
+The following example will install the UMD version which works with both CommonJS and AMD module types.
+
+```
+npm install typescript-dotnet-umd
+```
+
diff --git a/dist/amd/package.json b/dist/amd/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-dotnet-amd",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "author": "electricessence <npm@electrified.net>",
   "description": "A JavaScript-Friendly .NET Based TypeScript Library.",
@@ -19,6 +19,7 @@
     "Regex",
     "TypeValidator",
     "Promise",
+    "Parallel",
     "IDisposable",
     "IEnumerable",
     "ICollection",

diff --git a/dist/commonjs/package.json b/dist/commonjs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-dotnet-commonjs",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "author": "electricessence <npm@electrified.net>",
   "description": "A JavaScript-Friendly .NET Based TypeScript Library.",
@@ -19,6 +19,7 @@
     "Regex",
     "TypeValidator",
     "Promise",
+    "Parallel",
     "IDisposable",
     "IEnumerable",
     "ICollection",

diff --git a/dist/es6/README.md b/dist/es6/README.md
@@ -0,0 +1,21 @@
+This package is a distribution for [typescript-dotnet](https://www.npmjs.com/package/typescript-dotnet).  
+https://www.npmjs.com/package/typescript-dotnet
+
+The [typescript-dotnet](https://www.npmjs.com/package/typescript-dotnet) package includes the source code along with unminified UMD JavaScript and will function perfectly within another project but requires a reference to the ```/source/``` folder.
+
+It is recommended you select the module type that you intend to use:
+
+* [```typescript-dotnet-umd```](https://www.npmjs.com/package/typescript-dotnet-umd)
+* [```typescript-dotnet-es6```](https://www.npmjs.com/package/typescript-dotnet-es6)
+* [```typescript-dotnet-commonjs```](https://www.npmjs.com/package/typescript-dotnet-commonjs)
+* [```typescript-dotnet-amd```](https://www.npmjs.com/package/typescript-dotnet-amd)
+* [```typescript-dotnet-system```](https://www.npmjs.com/package/typescript-dotnet-system)
+
+**Example:**
+
+The following example will install the UMD version which works with both CommonJS and AMD module types.
+
+```
+npm install typescript-dotnet-umd
+```
+
diff --git a/dist/es6/package.json b/dist/es6/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-dotnet-es6",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "author": "electricessence <npm@electrified.net>",
   "description": "A JavaScript-Friendly .NET Based TypeScript Library.",
@@ -19,6 +19,7 @@
     "Regex",
     "TypeValidator",
     "Promise",
+    "Parallel",
     "IDisposable",
     "IEnumerable",
     "ICollection",

diff --git a/dist/system/package.json b/dist/system/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-dotnet-system",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "author": "electricessence <npm@electrified.net>",
   "description": "A JavaScript-Friendly .NET Based TypeScript Library.",
@@ -19,6 +19,7 @@
     "Regex",
     "TypeValidator",
     "Promise",
+    "Parallel",
     "IDisposable",
     "IEnumerable",
     "ICollection",

diff --git a/dist/umd.min/package.json b/dist/umd.min/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-dotnet-umd",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "author": "electricessence <npm@electrified.net>",
   "description": "A JavaScript-Friendly .NET Based TypeScript Library.",
@@ -19,6 +19,7 @@
     "Regex",
     "TypeValidator",
     "Promise",
+    "Parallel",
     "IDisposable",
     "IEnumerable",
     "ICollection",

diff --git a/gulp/dist.js b/gulp/dist.js
diff --git a/gulp/dist.js.map b/gulp/dist.js.map
diff --git a/gulp/dist.ts b/gulp/dist.ts
@@ -2,6 +2,7 @@
 
 import * as TARGET from "./constants/Targets";
 import * as MODULE from "./constants/ModuleTypes";
+import * as EVENT from "./constants/Events";
 import * as gulp from "gulp";
 import * as tsc from "./tsc";
 import * as TASK from "./constants/TaskNames";
@@ -63,7 +64,19 @@ function savePackage(dist:string, folder:string = dist):PromiseLike<void>
 						if(err) reject(err);
 						else resolve();
 					})
-			}));
+			}))
+		.then(()=>
+			copyReadme(folder));
+}
+
+function copyReadme(folder:string):PromiseLike<void>
+{
+	return new Promise<void>((resolve)=>
+	{
+		gulp.src("./dist/README.md")
+			.pipe(gulp.dest(`./dist/${folder}/`))
+			.on(EVENT.END, resolve);
+	});
 }
 
 gulp.task(

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-dotnet",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "author": "electricessence <npm@electrified.net>",
   "description": "A JavaScript-Friendly .NET Based TypeScript Library.",

diff --git a/publish.cmd b/publish.cmd
@@ -0,0 +1,24 @@
+call npm publish
+cd dist
+
+cd es6
+call npm publish
+cd ..
+
+cd commonjs
+call npm publish
+cd ..
+
+cd amd
+call npm publish
+cd ..
+
+cd umd.min
+call npm publish
+cd ..
+
+cd system.js
+call npm publish
+cd ..
+
+cd ..