Mailspring/docs/converting-a-text-mate-bundle.md

## Converting a TextMate Bundle

This guide will show you how to convert a [TextMate][TextMate] bundle to an
Atom package.

Converting a TextMate bundle will allow you to use its editor preferences,
snippets, and colorization inside Atom.

### Install apm

The `apm` command line utility that ships with Atom supports converting
a TextMate bundle to an Atom package.

Check that you have `apm` installed by running the following command in your
terminal:

```sh
apm help init
```

You should see a message print out with details about the `apm init` command.

If you do not, launch Atom and run the _Atom > Install Shell Commands_ menu
to install the `apm` and `atom` commands.

### Convert the Package

Let's convert the TextMate bundle for the [R][R] programming language. You can find other existing TextMate bundles [here][TextMateOrg].

You can convert the R bundle with the following command:

```sh
apm init --package ~/.atom/packages/language-r --convert https://github.com/textmate/r.tmbundle
```

You can now browse to `~/.atom/packages/language-r` to see the converted bundle.

:tada: Your new package is now ready to use, launch Atom and open a `.r` file in
the editor to see it in action!

### Further Reading

* Check out [Publishing a Package](publishing-a-package.html) for more information
  on publishing the package you just created to [atom.io][atomio].

[atomio]: https://atom.io
[CSS]: https://en.wikipedia.org/wiki/Cascading_Style_Sheets
[Less]: http://lesscss.org
[plist]: https://en.wikipedia.org/wiki/Property_list
[R]: https://en.wikipedia.org/wiki/R_(programming_language)
[TextMate]: http://macromates.com
[TextMateOrg]: https://github.com/textmate
fix(drafts): Various improvements and fixes to drafts, draft state management Summary: This diff contains a few major changes: 1. Scribe is no longer used for the text editor. It's just a plain contenteditable region. The toolbar items (bold, italic, underline) still work. Scribe was causing React inconcistency issues in the following scenario: - View thread with draft, edit draft - Move to another thread - Move back to thread with draft - Move to another thread. Notice that one or more messages from thread with draft are still there. There may be a way to fix this, but I tried for hours and there are Github Issues open on it's repository asking for React compatibility, so it may be fixed soon. For now contenteditable is working great. 2. Action.saveDraft() is no longer debounced in the DraftStore. Instead, firing that action causes the save to happen immediately, and the DraftStoreProxy has a new "DraftChangeSet" class which is responsbile for batching saves as the user interacts with the ComposerView. There are a couple big wins here: - In the future, we may want to be able to call Action.saveDraft() in other situations and it should behave like a normal action. We may also want to expose the DraftStoreProxy as an easy way of backing interactive draft UI. - Previously, when you added a contact to To/CC/BCC, this happened: <input> -> Action.saveDraft -> (delay!!) -> Database -> DraftStore -> DraftStoreProxy -> View Updates Increasing the delay to something reasonable like 200msec meant there was 200msec of lag before you saw the new view state. To fix this, I created a new class called DraftChangeSet which is responsible for accumulating changes as they're made and firing Action.saveDraft. "Adding" a change to the change set also causes the Draft provided by the DraftStoreProxy to change immediately (the changes are a temporary layer on top of the database object). This means no delay while changes are being applied. There's a better explanation in the source! This diff includes a few minor fixes as well: 1. Draft.state is gone—use Message.object = draft instead 2. String model attributes should never be null 3. Pre-send checks that can cancel draft send 4. Put the entire curl history and task queue into feedback reports 5. Cache localIds for extra speed 6. Move us up to latest React Test Plan: No new tests - once we lock down this new design I'll write tests for the DraftChangeSet Reviewers: evan Reviewed By: evan Differential Revision: https://review.inboxapp.com/D1125 2015-02-04 08:24:31 +08:00			`## Converting a TextMate Bundle`

			`This guide will show you how to convert a [TextMate][TextMate] bundle to an`
			`Atom package.`

			`Converting a TextMate bundle will allow you to use its editor preferences,`
			`snippets, and colorization inside Atom.`

			`### Install apm`

			The `apm` command line utility that ships with Atom supports converting
			`a TextMate bundle to an Atom package.`

			Check that you have `apm` installed by running the following command in your
			`terminal:`

			```sh
			`apm help init`
			```

			You should see a message print out with details about the `apm init` command.

			`If you do not, launch Atom and run the _Atom > Install Shell Commands_ menu`
			to install the `apm` and `atom` commands.

			`### Convert the Package`

			`Let's convert the TextMate bundle for the [R][R] programming language. You can find other existing TextMate bundles [here][TextMateOrg].`

			`You can convert the R bundle with the following command:`

			```sh
			`apm init --package ~/.atom/packages/language-r --convert https://github.com/textmate/r.tmbundle`
			```

			You can now browse to `~/.atom/packages/language-r` to see the converted bundle.

			:tada: Your new package is now ready to use, launch Atom and open a `.r` file in
			`the editor to see it in action!`

			`### Further Reading`

			`* Check out [Publishing a Package](publishing-a-package.html) for more information`
			`on publishing the package you just created to [atom.io][atomio].`

			`[atomio]: https://atom.io`
			`[CSS]: https://en.wikipedia.org/wiki/Cascading_Style_Sheets`
			`[Less]: http://lesscss.org`
			`[plist]: https://en.wikipedia.org/wiki/Property_list`
			`[R]: https://en.wikipedia.org/wiki/R_(programming_language)`
			`[TextMate]: http://macromates.com`
			`[TextMateOrg]: https://github.com/textmate`