Skip to content

Commit 3644db6

Browse files
committed
Readme revisions.
1 parent b21b54f commit 3644db6

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# babel-sublime
22

3-
> Only supports **Sublime Text 3**. Sublime Text 2 is no longer supported.
4-
5-
Language definitions for [ES6+ JavaScript](http://kangax.github.io/compat-table/es6/) with [React JSX syntax](http://facebook.github.io/react/docs/jsx-in-depth.html) extensions.
3+
Language definition for [modern JavaScript](http://kangax.github.io/compat-table/es2016plus/) with [JSX syntax](http://facebook.github.io/react/docs/jsx-in-depth.html), [Flow typing](https://flow.org/), and [Styled Components](https://styled-components.com/).
64

75
## Installation
86

@@ -11,20 +9,21 @@ Find it as [**Babel**](https://packagecontrol.io/packages/Babel) through [Packag
119
#### Setting as the default syntax
1210

1311
To set it as the default syntax for a particular extension:
14-
1. Open a file with that extension,
15-
2. Select `View` from the menu,
16-
3. Then `Syntax` `->` `Open all with current extension as...` `->` `Babel` `->` `JavaScript (Babel)`.
17-
4. Repeat this for each extension (e.g.: `.js` and `.jsx`).
12+
13+
1. Open a file with that extension,
14+
2. From the `View` menu, select `Syntax``Open all with current extension as` `Babel` `JavaScript (Babel)`
15+
3. Repeat this for each extension (e.g.: `.js` and `.jsx`).
1816

1917
#### Setting a Color Scheme
2018

21-
`Babel` comes bundled with `Next` and `Monokai` from [Benvie/JavaScriptNext.tmLanguage](https://github.com/Benvie/JavaScriptNext.tmLanguage). Select one from `Preferences` `->` `Color Scheme` `->` `Babel`
19+
`Babel` comes bundled with `Next` from [Benvie/JavaScriptNext.tmLanguage](https://github.com/Benvie/JavaScriptNext.tmLanguage). From the command palette, select `UI: Select Color Scheme` and select `Next`.
2220

2321
#### Advanced usage
2422

2523
It's possible to set `Babel` as the _only_ JavaScript package by disabling the stock one. To do so, add `"ignored_packages": ["JavaScript"]` to your `Preferences.sublime-settings`. The benefits include:
26-
* extension-less node scripts will automatically be recognized as `JavaScript (Babel)`,
27-
* and reduced clutter in the syntax menu.
24+
25+
* extension-less node scripts will automatically be recognized as `JavaScript (Babel)`,
26+
* and reduced clutter in the syntax menu.
2827

2928
**Keep in mind**, the stock snippets will no longer work (you may still use your own), and other third-party packages that depend on the stock package may break (no known ones so far).
3029

@@ -38,8 +37,10 @@ Find them separately at [babel/babel-sublime-snippets](https://github.com/babel/
3837

3938
## About
4039

41-
Under the hood, _babel-sublime_ is based on the excellent [Benvie/JavaScriptNext.tmLanguage](https://github.com/Benvie/JavaScriptNext.tmLanguage) with JSX syntax support built on top. The initial definitions for JSX came from [reactjs/sublime-react](https://github.com/reactjs/sublime-react) via [yungters/sublime](https://github.com/yungsters/sublime.git) - special thanks go to [@jgebhardt](https://github.com/jgebhardt) and [@zpao](https://github.com/zpao).
40+
Under the hood, `babel-sublime`'s syntax definition is built using [JS Custom](https://github.com/Thom1729/Sublime-JS-Custom). JS Custom is based on Sublime's [core JavaScript syntax](https://github.com/sublimehq/Packages), which is in turn descended from [Benvie/JavaScriptNext.tmLanguage](https://github.com/Benvie/JavaScriptNext.tmLanguage). Special thanks go to [@jgebhardt](https://github.com/jgebhardt) and [@zpao](https://github.com/zpao).
4241

4342
## Contributing
4443

45-
Pull Requests should include your changes to the respective `YAML-tmKittens` file as well as the converted `tmKittens` file. Use [AAAPackageDev](https://github.com/SublimeText/AAAPackageDev) to convert the `YAML-tmKittens` files.
44+
The `JavaScript (Babel).sublime-syntax` file itself is generated by JS Custom and should not be manually modified — any bug fixes or enhancements to the syntax itself should go through [JS Custom](https://github.com/Thom1729/Sublime-JS-Custom).
45+
46+
If you modify the commenting rules or Next theme, make sure to do so by editing the appropriate `YAML-tmPreferences` or `YAML-tmTheme` file and converting that file using [PackageDev](https://github.com/SublimeText/PackageDev). Then, commit both the source (YAML) file and the converted (XML) file.

0 commit comments

Comments
 (0)