Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miraks/babel-plugin-implicit-return
Implicitly return function result
https://github.com/miraks/babel-plugin-implicit-return
Last synced: about 2 months ago
JSON representation
Implicitly return function result
- Host: GitHub
- URL: https://github.com/miraks/babel-plugin-implicit-return
- Owner: miraks
- License: mit
- Created: 2016-02-25T18:20:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-08T11:13:31.000Z (over 5 years ago)
- Last Synced: 2024-04-26T00:26:02.213Z (5 months ago)
- Language: JavaScript
- Size: 64.5 KB
- Stars: 25
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-babel - implicit-return - Transforms last statement in a function block to a return statement. (Plugins / Syntax Sugar)
README
# babel-plugin-implicit-return
Implicitly return function result
## Examples
```javascript
// Before
function Pi() {
3.14;
}
// After
function Pi() {
return 3.14;
}
```
```javascript
// Before
function abs(n) {
if (n > 0) {
1;
} else if (n < 0) {
-1;
} else {
0;
}
}
// After
function abs(n) {
if (n > 0) {
return 1;
} else if (n < 0) {
return -1;
} else {
return 0;
}
}
```
```javascript
// Before
function sum(array) {
let result = 0;
for (let i = 0; i < array.length; i++) {
result += array[i]
}
}
// After
function sum(array) {
var _ret;
let result = 0;
for (let i = 0; i < array.length; i++) {
_ret = result += array[i];
}
return _ret;
}
```
```javascript
// Before
function classFactory() {
class Thingy extends Thing {
constructor() {
super();
}
fn() {
() => 1;
}
static fn() {
class Other {};
}
}
}
// After
function classFactory() {
return class Thingy extends Thing {
constructor() {
return super();
}
fn() {
return () => 1;
}
static fn() {
return class Other {};
}
}
}
```
## Requirements
Your compiling enviroment must have support for:
* [Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)
## Installation
```sh
$ npm install --save-dev babel-plugin-implicit-return
```
## Usage
### Via `.babelrc` (Recommended)
**.babelrc**
```json
{
"plugins": ["implicit-return"]
}
```
### Via CLI
```sh
$ babel --plugins implicit-return script.js
```
### Via Node API
```javascript
require("babel-core").transform("code", {
plugins: ["implicit-return"]
});
```
## Quirks
Due to JavaScript syntax limitations this plugin can't make a function to implicitly return:
### Object literal
This won't work:
```javascript
function getObject() {
{ key1: value1, key2: value2 }; // Syntax Error
}
```
There're two workarounds:
```javascript
// first - assign an object to a variable/constant
function getObject() {
const obj = { key1: value1, key2: value2 };
}
// second - wrap an object literal with braces
function getObject() {
({ key1: value1, key2: value2 });
}
```
### Function expression
This won't work:
```javascript
function getFunction() {
function() {}; // Syntax Error
}
```
There're four workarounds:
```javascript
// first - use arrow function
function getFunction() {
() => {};
}
// second - give your function a name
function getObject() {
function fn() {};
}
// third - assign a function to a variable/constant
function getObject() {
const fn = function() {};
}
// fourth - wrap a function with braces
function getObject() {
(function() {});
}
```
# License
MIT