Update for TypeScript 2.0

Author: michaelkourlas

.gitignore

@@ -4,7 +4,6 @@
 # JavaScript and TypeScript
 lib/
 test/lib/
-typings/
 
 # Documentation
 docs/

.travis.yml

@@ -4,9 +4,8 @@ node_js:
   - 6
   - 5
   - 4
+  - 4.0.0
 install:
   - npm install -g gulp
-  - npm install -g typings
   - npm install
-  - typings install
 script: gulp

CHANGES.md

@@ -1,3 +1,7 @@
+## 0.2.0 ##
+
+* Add null and undefined in type declarations
+
 ## 0.1.1 ##
 
 * Re-write in TypeScript

README.md

@@ -1,6 +1,7 @@
 # xmlcreate #
 
 [![Build Status](https://travis-ci.org/michaelkourlas/node-xmlcreate.svg?branch=master)](https://travis-ci.org/michaelkourlas/node-xmlcreate)
+[![npm version](https://badge.fury.io/js/xmlcreate.svg)](https://badge.fury.io/js/xmlcreate)
 
 ## Overview ##
 

gulpfile.js

@@ -17,8 +17,6 @@
 "use strict";
 
 var doc = require("gulp-typedoc");
-var filter = require("gulp-filter");
-var fs = require("fs");
 var gulp = require("gulp");
 var merge2 = require("merge2");
 var mocha = require("gulp-mocha");
@@ -28,66 +26,54 @@ var tslint = require("gulp-tslint");
 
 gulp.task("default", ["prod", "test-prod", "docs"]);
 
-var tsLibOptions = {
-    "module": "commonjs",
-    "target": "es5",
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "declaration": true
-};
+var tsProject = ts.createProject("tsconfig.json");
 gulp.task("prod", function() {
-    var tsResult = gulp.src("src/**/*.ts")
-                       .pipe(tslint({formatter: "verbose"}))
-                       .pipe(tslint.report())
-                       .pipe(ts(tsLibOptions));
+    var tsResult = tsProject.src()
+                            .pipe(tslint())
+                            .pipe(tslint.report())
+                            .pipe(tsProject(ts.reporter.longReporter()));
     return merge2([tsResult.js
                            .pipe(gulp.dest("lib")),
                    tsResult.dts
                            .pipe(gulp.dest("lib"))]);
 });
 gulp.task("dev", function() {
-    var tsResult = gulp.src("src/**/*.ts")
-                       .pipe(tslint({formatter: "verbose"}))
-                       .pipe(tslint.report())
-                       .pipe(sourcemaps.init())
-                       .pipe(ts(tsLibOptions));
+    var tsResult = tsProject.src()
+                            .pipe(tslint())
+                            .pipe(tslint.report())
+                            .pipe(sourcemaps.init())
+                            .pipe(tsProject(ts.reporter.longReporter()));
     return merge2([tsResult.js
                            .pipe(sourcemaps.write())
                            .pipe(gulp.dest("lib")),
                    tsResult.dts
                            .pipe(gulp.dest("lib"))]);
 });
 
+var testTsProject = ts.createProject("test/tsconfig.json");
+var test = function() {
+    return testTsProject.src()
+                        .pipe(tslint())
+                        .pipe(tslint.report())
+                        .pipe(sourcemaps.init())
+                        .pipe(testTsProject(ts.reporter.longReporter()))
+                        .pipe(sourcemaps.write())
+                        .pipe(gulp.dest("test/lib"))
+                        .pipe(mocha());
+};
+gulp.task("test", ["prod"], test);
+gulp.task("test-prod", ["prod"], test);
+gulp.task("test-dev", ["dev"], test);
+
 var docOptions = {
+    mode: "file",
     module: "commonjs",
-    target: "es5",
     out: "docs",
-    mode: "file"
+    target: "es5",
+    // TODO: Remove this option once TypeDoc supports TypeScript 2.0
+    ignoreCompilerErrors: true
 };
 gulp.task("docs", function() {
     return gulp.src("src")
                .pipe(doc(docOptions));
 });
-
-var tsTestOptions = {
-    "module": "commonjs",
-    "target": "es5",
-    "noImplicitAny": true,
-    "noImplicitReturns": true
-};
-var dtsFilter = filter(["**/*.ts", "!**/*.d.ts"], {restore: true});
-var test = function() {
-    return gulp.src(["test/src/**/*.ts", "typings/index.d.ts"])
-               .pipe(dtsFilter)
-               .pipe(tslint({formatter: "verbose"}))
-               .pipe(tslint.report())
-               .pipe(dtsFilter.restore)
-               .pipe(sourcemaps.init())
-               .pipe(ts(tsTestOptions))
-               .pipe(sourcemaps.write())
-               .pipe(gulp.dest("test/lib"))
-               .pipe(mocha());
-};
-gulp.task("test", ["prod"], test);
-gulp.task("test-prod", ["prod"], test);
-gulp.task("test-dev", ["dev"], test);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "xmlcreate",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Simple XML builder for Node.js",
   "keywords": [
     "build",
@@ -29,18 +29,22 @@
     "url": "git://github.com/michaelkourlas/node-xmlcreate.git"
   },
   "devDependencies": {
+    "@types/chai": "^3.4.34",
+    "@types/mocha": "^2.2.32",
     "chai": "^3.5.0",
     "gulp": "^3.9.1",
-    "gulp-filter": "^4.0.0",
     "gulp-mocha": "^3.0.1",
     "gulp-sourcemaps": "^1.6.0",
-    "gulp-tslint": "^6.1.1",
+    "gulp-tslint": "^6.1.2",
     "gulp-typedoc": "^2.0.0",
-    "gulp-typescript": "^2.13.6",
+    "gulp-typescript": "^3.0.1",
     "merge2": "^1.0.2",
-    "mocha": "^3.0.2",
+    "mocha": "^3.1.0",
     "tslint": "^3.15.1",
     "typedoc": "^0.4.5",
-    "typings": "^1.3.3"
+    "typescript": "^2.0.3"
+  },
+  "engines": {
+    "node": ">=4.0.0"
   }
 }

src/escape.ts

@@ -17,9 +17,9 @@
 /**
  * Replaces ampersands (&) with the appropriate XML character reference.
  *
- * @param {string} str The string to escape.
+ * @param str The string to escape.
  *
- * @returns {string} A copy of the specified string with ampersands escaped.
+ * @returns A copy of the specified string with ampersands escaped.
  *
  * @private
  */
@@ -31,10 +31,9 @@ export function escapeAmpersands(str: string): string {
  * Replaces left angle brackets (<) with the appropriate XML character
  * reference.
  *
- * @param {string} str The string to escape.
+ * @param str The string to escape.
  *
- * @returns {string} A copy of the specified string with left angle brackets
- *                   escaped.
+ * @returns A copy of the specified string with left angle brackets escaped.
  *
  * @private
  */
@@ -45,9 +44,9 @@ export function escapeLeftAngleBrackets(str: string): string {
 /**
  * Replaces single quotes (") with the appropriate XML character reference.
  *
- * @param {string} str The string to escape.
+ * @param str The string to escape.
  *
- * @returns {string} A copy of the specified string with single quotes escaped.
+ * @returns A copy of the specified string with single quotes escaped.
  *
  * @private
  */
@@ -58,9 +57,9 @@ export function escapeSingleQuotes(str: string): string {
 /**
  * Replaces double quotes (") with the appropriate XML character reference.
  *
- * @param {string} str The string to escape.
+ * @param str The string to escape.
  *
- * @returns {string} A copy of the specified string with double quotes escaped.
+ * @returns A copy of the specified string with double quotes escaped.
  *
  * @private
  */

src/main.ts

@@ -42,9 +42,9 @@ export {
 /**
  * Creates a new XML document.
  *
- * @param {string} root The name of the root element of the document.
+ * @param root The name of the root element of the document.
  *
- * @returns {XmlDocument} The new XML document.
+ * @returns The new XML document.
  */
 export function document(root: string): XmlDocument {
     return new XmlDocument(root);