From 24312e56eb6b8b2d6d7dd529c4d2dc40a4e33bda Mon Sep 17 00:00:00 2001 From: Renaud Pawlak Date: Mon, 25 Jan 2016 15:29:05 +0100 Subject: [PATCH] added a note on WebJars --- doc/jsweet-language-specifications.md | 6 ++++-- doc/jsweet-language-specifications.tex | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/jsweet-language-specifications.md b/doc/jsweet-language-specifications.md index cb47e47e..e8ce5142 100644 --- a/doc/jsweet-language-specifications.md +++ b/doc/jsweet-language-specifications.md @@ -1020,9 +1020,11 @@ Here is an example of the `META-INF/candy-metadata.json` file: Typically, `d.ts` files shall be generated by the JSweet transpiler using the following options: -- `–declaration`: turns on the generation of the `d.ts` files. +- `declaration`: turns on the generation of the `d.ts` files. -- `–dtsout`: tells where to put the generated `d.ts` files (for packaging, place them in `RESOURCES/src/typings`, where `RESOURCES` is your Maven project resources directory). +- `dtsout`: tells where to put the generated `d.ts` files (for packaging, place them in `RESOURCES/src/typings`, where `RESOURCES` is your Maven project resources directory). + +Note: this section only described how to package JSweet jars for compilation. For execution, the generated JavaScript must be accessible to the using project too. A way is to package the JavaScript following the WebJar conventions: . Appendix 1: JSweet transpiler options ------------------------------------- diff --git a/doc/jsweet-language-specifications.tex b/doc/jsweet-language-specifications.tex index f23e1708..5517e3e9 100644 --- a/doc/jsweet-language-specifications.tex +++ b/doc/jsweet-language-specifications.tex @@ -1049,10 +1049,12 @@ Here is an example of the \texttt{META-INF/candy-metadata.json} file: Typically, \texttt{d.ts} files shall be generated by the JSweet transpiler using the following options: \begin{itemize} -\item \texttt{--declaration}: turns on the generation of the \texttt{d.ts} files. -\item \texttt{--dtsout}: tells where to put the generated \texttt{d.ts} files (for packaging, place them in \texttt{RESOURCES/src/typings}, where \texttt{RESOURCES} is your Maven project resources directory). +\item \texttt{declaration}: turns on the generation of the \texttt{d.ts} files. +\item \texttt{dtsout}: tells where to put the generated \texttt{d.ts} files (for packaging, place them in \texttt{RESOURCES/src/typings}, where \texttt{RESOURCES} is your Maven project resources directory). \end{itemize} +Note: this section only described how to package JSweet jars for compilation. For execution, the generated JavaScript must be accessible to the using project too. A way is to package the JavaScript following the WebJar conventions: \url{http://www.webjars.org/}. + \chapter*{Appendix 1: JSweet transpiler options} \begin{verbatim}