THRIFT-2522 TypeScript extension for Thrift Compiler
add info and format js/README.md
This closes #124
----
commit ada1016fdd6408694f9b82d5de8c1fbbf8d8a528
Author: Pascal Schweizer <pasci@hispeed.ch>
Date: 2014-03-21T16:18:59Z
THRIFT-2522 TypeScript extension for Thrift Compiler
----
diff --git a/compiler/cpp/src/generate/t_js_generator.cc b/compiler/cpp/src/generate/t_js_generator.cc
index 7787dfb..7f53016 100644
--- a/compiler/cpp/src/generate/t_js_generator.cc
+++ b/compiler/cpp/src/generate/t_js_generator.cc
@@ -2185,4 +2185,4 @@
THRIFT_REGISTER_GENERATOR(js, "Javascript",
" jquery: Generate jQuery compatible code.\n"
" node: Generate node.js compatible code.\n"
-" ts: Generate TypeScript Definition Files.\n")
+" ts: Generate TypeScript definition files.\n")
diff --git a/lib/js/README.md b/lib/js/README.md
index bb65050..8c4340b 100644
--- a/lib/js/README.md
+++ b/lib/js/README.md
@@ -31,12 +31,16 @@
require a recent version of Node.js to be installed. To
install the support files for the Grunt build tool execute
the command:
- $ npm install
+
+ npm install
+
This reads the package.json and pulls in the appropriate
sources from the internet. To build the JavaScript branch
of Apache Thrift execute the command:
- $ grunt
-This runs the grunt build tool, linting all of the source
+
+ grunt
+
+This runs therunt build tool, linting all of the source
files, setting up and running the tests, concatenating and
minifying the main libraries and generating the html
documentation.
@@ -127,3 +131,10 @@
server.listen(port);
console.log("Http/Thrift Server running on port: " + port);
+
+TypeScript
+------------------------------------
+TypeScript definition files can also be generated by running:
+
+ thrift --gen js:ts file.thrift
+