@@ -14,27 +14,49 @@ More detailed documentation and info on writing declarations can be found [on th
1414
1515** Compile Files**
1616
17- ` tstl path/to-my- file.ts path/to-my- other-file.ts `
17+ ` tstl path/to/ file.ts path/to/ other-file.ts `
1818
1919** Compile Projects**
2020
21- ` tstl -p path/to-my /tsconfig.json `
21+ ` tstl -p path/to/tsconfig.json `
2222
2323** Options**
2424```
25- Syntax: tstl [options] [files...]
25+ tstl [options] [files...]
2626
27- In addtion to the options listed below you can also pass options for the
28- typescript compiler (For a list of options use tsc -h). NOTE: The tsc options
29- might have no effect.
27+ In addition to the options listed below you can also pass options for the
28+ typescript compiler (For a list of options use tsc -h).
29+
30+ NOTES:
31+ - The tsc options might have no effect.
32+ - Options in tsconfig.json are prioritized.
3033
3134Options:
32- --version Show version number
33- --luaTarget, -l Specify Lua target version: 'JIT' (Default), '5.1', '5.2',
34- '5.3'
35- --project, -p Compile the project given the path to its configuration file,
36- or to a folder with a 'tsconfig.json'
37- --help Show this message
35+ --help Show help [boolean]
36+ --version Show version number [boolean]
37+ --lt, --luaTarget Specify Lua target version.
38+ [string] [choices: "JIT", "5.1", "5.2", "5.3"] [default: "JIT"]
39+ --lld, --luaLibDir Specify typescript_lualib.lua location relative to outDir.
40+ [string] [default: "./"]
41+ --ah, --addHeader Specify if a header will be added to compiled files.
42+ [boolean] [default: true]
43+
44+ Examples:
45+ tstl path/to/file.ts [...] Compile files
46+ tstl -p path/to/tsconfig.json Compile project
47+ ```
48+
49+ ** Example tsconfig.json**
50+ ```
51+ {
52+ "compilerOptions": {
53+ "noImplicitAny" : true,
54+ "noImplicitThis" : true,
55+ "alwaysStrict" : true,
56+ "strictNullChecks": true,
57+ "luaTarget": "JIT"
58+ }
59+ }
3860```
3961
4062## Sublime Text integration
0 commit comments