From f9b3f9121f8f6f0fee915fe0755f879831ce85bc Mon Sep 17 00:00:00 2001 From: Joshua Sierles Date: Fri, 29 May 2015 22:39:24 +0200 Subject: [PATCH] update JS environment documentation for Babel, and explain what a transpiler does. --- docs/JavaScriptEnvironment.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/JavaScriptEnvironment.md b/docs/JavaScriptEnvironment.md index cccf3800e..157458d8f 100644 --- a/docs/JavaScriptEnvironment.md +++ b/docs/JavaScriptEnvironment.md @@ -17,9 +17,13 @@ When using React Native, you're going to be running your JavaScript code in two While both environments are very similar, you may end up hitting some inconsistencies. We're likely going to experiment with other JS engines in the future, so it's best to avoid relying on specifics of any runtime. -## JavaScript Transforms +## JavaScript Syntax Transformers -React Native ships with many JavaScript transforms to make writing code more enjoyable. If you are curious, you can see the [implementation of all those transformations](https://github.com/facebook/jstransform/tree/master/visitors). Here's the full list: +Syntax transformers make code writing more enjoyable by enabling proposed-but-non-standard javascript syntax. + +As of version 0.5.0, React Native ships with the [Babel javascript compiler](https://babeljs.io). Check [Babel documentation](http://babeljs.io/docs/advanced/transformers/) on its supported transformations for more details. + +Here's a full list of React Native's [enabled transformations](https://github.com/facebook/react-native/blob/master/packager/transformer.js#L21). ES5 @@ -27,18 +31,18 @@ ES5 ES6 -* Arrow function: ` this.setState({pressed: true})}` -* Call spread: `Math.max(...array);` -* Class: `class C extends React.Component { render() { return ; } }` -* Destructuring: `var {isActive, style} = this.props;` -* Iteration: `for (var element of array) { }` -* Computed Properties: `var key = 'abc'; var obj = {[key]: 10};` +* [Arrow functions](http://babeljs.io/docs/learn-es2015/#arrows): ` this.setState({pressed: true})}` +* [Call spread](http://babeljs.io/docs/learn-es2015/#default-rest-spread): `Math.max(...array);` +* [Classes](http://babeljs.io/docs/learn-es2015/#classes): `class C extends React.Component { render() { return ; } }` +* [Destructuring](http://babeljs.io/docs/learn-es2015/#destructuring): `var {isActive, style} = this.props;` +* [Iteration](http://babeljs.io/docs/learn-es2015/#iterators-for-of): `for (var element of array) { }` +* [Computed Properties](http://babeljs.io/docs/learn-es2015/#enhanced-object-literals): `var key = 'abc'; var obj = {[key]: 10};` * Object Consise Method: `var obj = { method() { return 10; } };` -* Object Short Notation: `var name = 'vjeux'; var obj = { name };` -* Rest Params: `function(type, ...args) { }` -* Template: ``var who = 'world'; var str = `Hello ${who}`;`` +* [Object Short Notation](http://babeljs.io/docs/learn-es2015/#enhanced-object-literals): `var name = 'vjeux'; var obj = { name };` +* [Rest Params](https://github.com/sebmarkbage/ecmascript-rest-spread): `function(type, ...args) { }` +* [Template Literals](http://babeljs.io/docs/learn-es2015/#template-strings): ``var who = 'world'; var str = `Hello ${who}`;`` ES7 -* Object Spread: `var extended = { ...obj, a: 10 };` -* Function Trailing Comma: `function f(a, b, c,) { }` +* [Object Spread](https://github.com/sebmarkbage/ecmascript-rest-spread): `var extended = { ...obj, a: 10 };` +* [Function Trailing Comma](https://github.com/jeffmo/es-trailing-function-commas): `function f(a, b, c,) { }`