Skip to content

Commit

Permalink
Added installation messages.
Browse files Browse the repository at this point in the history
  • Loading branch information
jeantimex committed Jul 18, 2016
1 parent 8838467 commit e15d51a
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 32 deletions.
52 changes: 20 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,28 @@ Feeling bored with typing or even copying React codes to write React components

The snippets follow JavaScript ES6 syntax, we don't use the old `React.createClass({...})` anymore, we write class component and functional component. Also we provide snippets to quickly write React Lifecycle functions (e.g. `componentDidMount`).

**Latest Updates (June 27, 2016)**
* Added to [Package Control](https://packagecontrol.io/packages/React%20Development%20Snippets)! Thank you so much [FichteFoll](https://github.com/FichteFoll)!
* Fix **Component Will Mount** snippet command
## Installation ##

### Use Package Control ###

* Make sure you have [Package Manager](https://packagecontrol.io/installation) installed
* Launch the command palette: `⌘+shift+p` on MacOS, `ctrl+shift+p` on Windows
* Type `install`, select `Package Control: Install Package`
* Type `React`, select `React Development Snippets`

### Without Package Control ###

Navigate to your Sublime Text packages folder and git clone our project.

**Updates (June 14, 2016)**
* Rename our project to **React Development Snippets**
#### MacOS ####
"/Users/{user}/Library/Application Support/Sublime Text {2|3}/Packages"

**Updates (May 22, 2016)**
* Reorganized folder structure and grouped snippets to: React, Redux and Test
* Added Redux related snippets to help you write actions, reducers and redux components faster
* Added `<FormattedMessage />` snippet
#### Windows ####
"C:\Users\{user}\AppData\Roaming\Sublime Text {2|3}\Packages"

```
git clone https://github.com/jeantimex/react-sublime-snippet.git "React-Development-Snippets"
```

## Snippets ##

Expand Down Expand Up @@ -334,29 +345,6 @@ it('should ${1:...}', () => {
import ${1:Package} from '${2:path}';
```

## Installation ##

### Use Package Control ###

* Make sure you have [Package Manager](https://packagecontrol.io/installation) installed
* Launch the command palette: `⌘+shift+p` on MacOS, `ctrl+shift+p` on Windows
* Type `install`, select `Package Control: Install Package`
* Type `React`, select `React Development Snippets`

### Without Package Control ###

Navigate to your Sublime Text packages folder and git clone our project.

#### MacOS ####
"/Users/{user}/Library/Application Support/Sublime Text {2|3}/Packages"

#### Windows ####
"C:\Users\{user}\AppData\Roaming\Sublime Text {2|3}\Packages"

```
git clone https://github.com/jeantimex/react-sublime-snippet.git "React-Development-Snippets"
```

## Authors

* **Yong Su** - *Box Inc.* - [jeantimex](https://github.com/jeantimex)
Expand Down
4 changes: 4 additions & 0 deletions messages.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"install": "messages/install.txt",
"3.0.1": "messages/3.0.1.txt"
}
20 changes: 20 additions & 0 deletions messages/3.0.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Package Control Messages
========================

React Development Snippets:
---

## New Features

1. Added to Package Control! Thank you so much FichteFoll!
2. Fix Component Will Mount snippet command
3. Reorganized folder structure and grouped snippets to: React, Redux and Test
4. Added `<FormattedMessage />` snippet

Support
----

To learn more about the features, please visit
https://github.com/jeantimex/react-sublime-snippet

If you are having trouble, please contact me at [email protected]
18 changes: 18 additions & 0 deletions messages/3.0.2.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Package Control Messages
========================

React Development Snippets:
---

## New Features

1. Snippet command should match snippet name, i.e., `rcdu` => Component Did Mount
2. Functional Component is cleaner with one-liner prop.

Support
----

To learn more about the features, please visit
https://github.com/jeantimex/react-sublime-snippet

If you are having trouble, please contact me at [email protected]
71 changes: 71 additions & 0 deletions messages/install.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
Package Control Messages
========================

React Development Snippets:
---

Thanks for installing Sublime React Development Snippets! Below are some quick notes
to get you started with the plugin.

Please see https://github.com/jeantimex/react-sublime-snippet for the full documentation.


----------------------------------------------------------------------------------
About the Snippets
----------------------------------------------------------------------------------

React Development Snippets is for React developers like you, it helps you write React
components, functions, tests faster.

To use the snippets, make sure you are editting a .js file, type `r`, you should see
a list of snippets, choose the one you want and hit Enter.

----------------------------------------------------------------------------------

## Features

The React Development Snippets comes with the following snippets:

1. React
- Class Component
- Class Component with InjectIntl
- Functional Component
- Functional Component with InjectIntl
- Component Did Mount
- Component Did Update
- Component Will Mount
- Component Will Receive Props
- Component Will Unmount
- Component Will Update
- Default Props
- Define Messages
- Formatted Message
- Import
- New Message
- New Prop
- PropTypes
- Should Component Update

2. Redux
- Action
- Reducer
- Redux Component

3. Test
- Test
- Test Describe
- Test It

## Coming Soon

1. ES6 syntax
2. More Redux snippets
3. More Test snippets

Support
----

To learn more about the features, please visit
https://github.com/jeantimex/react-sublime-snippet

If you are having trouble, please contact me at [email protected]

0 comments on commit e15d51a

Please sign in to comment.