|
1 | | -Welcome to Brackets! [](https://travis-ci.org/adobe/brackets) |
| 1 | +Brackets TypeScript Code Intel |
2 | 2 | ------------------- |
3 | 3 |
|
4 | | -Installers for the latest build can be [downloaded here](http://download.brackets.io/). |
| 4 | +This extension adds support for writing **TypeScript in Brackets** ! |
5 | 5 |
|
6 | | -This is an early version of Brackets, a code editor for HTML, CSS |
7 | | -and JavaScript that's *built* in HTML, CSS and JavaScript. |
| 6 | +For the moment, **it includes**: |
8 | 7 |
|
9 | | -What makes Brackets different from other web code editors? |
| 8 | +* Smart code **auto-completion** |
| 9 | +* **External files inclusion** with references ( **.ts** and **.d.ts** ) |
| 10 | +* **Quick Edit** (open the declaration of what you clicked on) |
10 | 11 |
|
11 | | -* **Tools shouldn't get in your way.** Instead of cluttering up your coding |
12 | | -environment with lots of panels and icons, the Quick Edit UI in Brackets puts |
13 | | -context-specific code and tools inline. |
14 | | -* **Brackets is in sync with your browser.** With Live Development, Brackets |
15 | | -works directly with your browser to push code edits instantly and jump |
16 | | -back and forth between your real source code and the browser view. |
17 | | -* **Do it yourself.** Because Brackets is open source, and built with HTML, CSS |
18 | | -and JavaScript, you can help build the best code editor for the web. |
| 12 | + |
19 | 13 |
|
20 | | -You can see some |
21 | | -[screenshots of Brackets](https://github.com/adobe/brackets/wiki/Brackets-Screenshots) |
22 | | -on the wiki. |
| 14 | + |
23 | 15 |
|
24 | | -Brackets is early in development, so many of the features you would |
25 | | -expect in a code editor are missing, and some existing features might be |
26 | | -incomplete or not as useful as you'd want. But if you like the direction |
27 | | -it's going, the [CONTRIBUTING.md](https://github.com/adobe/brackets/blob/master/CONTRIBUTING.md) |
28 | | -file contains some useful links to help you getting started, please contribute! |
| 16 | +##Installation |
29 | 17 |
|
30 | | -The text editor inside Brackets is based on |
31 | | -[CodeMirror](http://github.com/marijnh/CodeMirror)—thanks to Marijn for |
32 | | -taking our pull requests :) See |
33 | | -[Notes on CodeMirror](https://github.com/adobe/brackets/wiki/Notes-on-CodeMirror) |
34 | | -for info on upcoming things we're planning to contribute to CodeMirror. |
| 18 | +* **Download and install Brackets**: http://download.brackets.io/ |
| 19 | +* **Download or clone this extension** from this repository |
| 20 | +* Put it into the **src/extensions/dev directory of Brackets** |
| 21 | +* Edit the file **src/editor/EditorUtils.js**: |
35 | 22 |
|
36 | | -How to run Brackets |
37 | | -------------------- |
38 | | - |
39 | | -**Brackets isn't ready for general use yet.** It's still early in |
40 | | -development, is missing a lot of basic editor features, and *probably* |
41 | | -has bugs. That said, we've actually been using Brackets to develop Brackets |
42 | | -for awhile now, so what's there is reasonably stable. |
43 | | - |
44 | | -Although Brackets is built in HTML/CSS/JS, it currently runs as a desktop |
45 | | -application in a thin native shell, so that it can access your local files. |
46 | | -(If you just try to open the index.html file in a browser, it won't work yet.) |
47 | | -The native shell for Brackets lives in a separate repo, |
48 | | -[adobe/brackets-shell](https://github.com/adobe/brackets-shell/). |
49 | | - |
50 | | -The Brackets native shell currently runs on Mac and Windows. |
51 | | -The community has started working on a Linux port, and is making great progress; |
52 | | -if you're interested, check out the |
53 | | -[discussion thread](https://groups.google.com/forum/?fromgroups=#!topic/brackets-dev/29vOJ6tvl8A) |
54 | | -on the brackets-dev Google Group. |
55 | | - |
56 | | -You can download "stable" builds of Brackets from |
57 | | -[download.brackets.io](http://download.brackets.io). If you want to pull the repo directly via git, see [How to Hack on Brackets](https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets) |
58 | | -for instructions on how to get everything. |
59 | | - |
60 | | -By default, Brackets opens a folder containing some simple "Getting Started" content. |
61 | | -You can choose a different folder to edit from *File > Open Folder*. (Might we |
62 | | -suggest editing the Brackets source code and submitting some pull requests?) |
63 | | - |
64 | | -Most of Brackets should be pretty self-explanatory, but for information on how |
65 | | -to use its unique features, like Quick Edit and Live Development, please read |
66 | | -[How to Use Brackets](http://github.com/adobe/brackets/wiki/How-to-Use-Brackets). |
67 | | -The [extensions wiki page](https://github.com/adobe/brackets/wiki/Brackets-Extensions) |
68 | | -has a list of extensions that have been contributed. |
69 | | -Also, see the [release notes](http://github.com/adobe/brackets/wiki/Release-Notes) |
70 | | -for a list of new features and known issues in each build. |
71 | | - |
72 | | -I found a bug/missing feature! |
73 | | ------------------------------- |
74 | | - |
75 | | -Issues starting Brackets the first time? Please review [Troubleshooting](https://github.com/adobe/brackets/wiki/Troubleshooting). |
76 | | - |
77 | | -Brackets bugs are tracked in [the Brackets github issue tracker](https://github.com/adobe/brackets/issues). |
78 | | -When filing a new bug, please remember to include: |
79 | | - |
80 | | -* Brackets version/sprint number (or commit SHA if you're pulling directly from the repo) |
81 | | -* Platform/OS version |
82 | | -* Steps to reproduce problem with actual and expected results |
83 | | -* Link to test files (you can create a gist on [gist.github.com](https://gist.github.com/) |
84 | | - if that's convenient) |
85 | | - |
86 | | -More details on how to file an issue can be found [here](https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue). |
87 | | -For feature requests, go ahead and file them in the issue tracker; they'll be converted |
88 | | -to user stories on the [public Brackets backlog*](http://bit.ly/BracketsBacklog). |
| 23 | +**Find this lines** at the end of the file: |
89 | 24 |
|
90 | | -\* Please excuse the mess in the "Icebox (To Be Reviewed)" list. We're still importing data from our internal system. |
| 25 | + case "hx": |
| 26 | + return "haxe"; |
91 | 27 |
|
92 | | -I want to help! |
93 | | ---------------- |
| 28 | +**Add below it** this lines: |
94 | 29 |
|
95 | | -Awesome! Please read [How to Hack on Brackets](https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets). |
| 30 | + case "ts": |
| 31 | + return "text/typescript"; |
| 32 | + |
| 33 | +**Save it** and you are done ! |
96 | 34 |
|
97 | | -I want to keep track of how Brackets is doing! |
98 | | ----------------------------------------------- |
| 35 | +Run **Brackets** and try it. |
99 | 36 |
|
100 | | -Not sure you needed the exclamation point there, but I like your enthusiasm. |
| 37 | +You can open a **TypeScript project** or the **sample project** given |
| 38 | +with this extension in the Sample folder. |
101 | 39 |
|
102 | | -* **Twitter:** [@brackets](http://twitter.com/#!/brackets) |
103 | | -* **IRC:** [#brackets on freenode](http://webchat.freenode.net/?channels=brackets) |
104 | | -* **Developers mailing list:** http://groups.google.com/group/brackets-dev |
0 commit comments