UNPKG

dts2as

Version:

A command line tool that converts TypeScript definitions (d.ts files) to ActionScript 3 classes and interfaces

github.com/bowlerhatllc/dts2as

bowlerhatllc/dts2as

97 lines (55 loc) • 3.98 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# dts2as A command line utility that converts TypeScript definitions (d.ts files) to ActionScript classes and interfaces and generates a SWC file. Use these SWCs with Apache FlexJS for strict compile-time type checking, as if the JavaScript library were written in ActionScript. You can add the SWCs to IDEs, like [Visual Studio Code](https://nextgenactionscript.com/vscode/), Flash Builder, or IntelliJ IDEA, and you'll get helpful code suggestions as you type. ## Installation Requires [Node.js](https://nodejs.org/). ``` npm install -g dts2as ``` ## Usage ``` dts2as hello.d.ts dts2as file1.d.ts file2.d.ts dts2as --outSWC hello.swc hello.d.ts dts2as --outDir ./as3-files file.d.ts dts2as --exclude com.example.SomeType file.d.ts ``` The following arguments are available: * `-outSWC FILE` Generate a compiled SWC file. Requires either `FLEX_HOME` environment variable or `--flexHome` option. * `-outDir DIRECTORY` Generate ActionScript files in a specific output directory. Defaults to `./dts2as_generated`. * `--flexHome DIRECTORY` Specify the directory where Apache FlexJS is located. Defaults to `FLEX_HOME` environment variable, if available. * `--moduleMetadata` Adds `[JSModule]` metadata to CommonJS modules. If a module is used in code, Apache FlexJS will automatically require it. * `-e SYMBOL` or `--exclude SYMBOL` Specify the fully-qualified name of a symbol to exclude when emitting ActionScript. * `-i SYMBOL` or `--include SYMBOL` Specify the fully-qualified name of a symbol to include when emitting ActionScript. Excludes all other symbols. * `-t VERSION` or `--target VERSION` Specify ECMAScript target version for the TypeScript standard library: 'ES3', 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'Latest' (default) * `-v` or `--version` Print the version of `dts2as`. ## Using the SWC with Apache FlexJS To use the generated SWC file with Apache FlexJS, you need to append it to the *external* library path. If you're using the FlexJS framework components, you can compile with `mxmlc`: ``` mxmlc --external-library-path+=generated.swc src/MyProject.mxml ``` For pure ActionScript projects that target native JavaScript APIs, like the HTML DOM, you can compile with `asjsc`: ``` asjsc --external-library-path+=generated.swc src/MyProject.as ``` For more details, please check out the following tutorial: [Introduction to `dts2as`: Using TypeScript definitions with ActionScript](http://nextgenactionscript.com/tutorials/dts2as-typescript-definitions-with-actionscript/) ## Troubleshooting TypeScript definition files support a surprisingly large subset of the TypeScript language. Sometimes, dts2as won't know how to parse some of the more advanced syntax (although it's certainly getting better at it over time!). When dts2as runs into problems, it may not be able to compile a SWC file for you. You have a few options when dts2as fails: * Use the `--exclude` option to remove some symbols that you know you won't need, or use the `--include` option to include only the symbols that you definitely need. * Modify the original d.ts file to simplify the TypeScript syntax or to remove some symbols that you don't need. * Use the `--outDir` option instead of the `--outSWC` option to generate only ActionScript files. Then, modify the ActionScript files and compile them into a SWC yourself. ## Support this project Want to see more ActionScript transpiler tools and utilities like `dts2as`? How about in-depth articles and step-by-step video tutorials that teach you how to use ActionScript with libraries like jQuery, CreateJS, and Pixi.js? Please [become a patron](http://patreon.com/josht) and support the next generation of ActionScript development on the web -- without a plugin! [NextGen ActionScript by Josh Tynjala on Patreon](http://patreon.com/josht) Special thanks to the following sponsors for their generous support: * [YETi CGI](http://yeticgi.com/) * [Moonshine IDE](http://moonshine-ide.com/)