1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
Kneden (babel-plugin-async-to-promises)
=======================================
[](https://travis-ci.org/marten-de-vries/kneden)
[](https://david-dm.org/marten-de-vries/kneden)
[](https://david-dm.org/marten-de-vries/kneden#info=devDependencies)
> Transpile ES7 async/await to vanilla ES6 Promise chains
**WARNING: Kneden
[is usable](https://github.com/pouchdb/pouchdb-plugin-helper/pull/9), but it's
also [not complete yet](https://github.com/marten-de-vries/kneden/issues/13).**
Do you want an ES7 async/await transpiling [Babel](https://babeljs.io/) plugin,
that:
- produces readable code - even when generator functions are not available?
- doesn't come with a runtime your users have to download?
Then look no further! **Kneden (babel-plugin-async-to-promises)** can help you.
## Example
**In**
```js
async function test() {
await db.destroy();
}
```
**Out**
```js
function test() {
return Promise.resolve().then(function () {
return db.destroy();
}).then(function () {});
}
```
(The last .then() might seem superfluous at first, but the first function
doesn't actually resolve to anything so it's necessary to make a valid
translation.)
**Kneden** tries to translate ES7 async/await to promises in a manner similar to
how a human would do so. Loops are converted to recursive functions, and your
code is modified in such a way that a return won't just drop you in the next
part of the promise chain, but actually does what you expect it to do.
For more examples, see the
[test/fixtures directory](https://github.com/marten-de-vries/kneden/tree/master/test/fixtures)
for both the input and output **Kneden** takes/produces.
## Installation
```sh
$ npm install babel-plugin-async-to-promises
```
## Usage
Note: Kneden only supports transpiling ES5 with the addition of async/await. If
you're using other ES6 features (like arrow functions, let/const, classes,
etc.), make sure you transpile them down to valid ES5 code first using the
[babel es2015 preset](https://www.npmjs.com/package/babel-preset-es2015). See
[#19](https://github.com/marten-de-vries/kneden/issues/19) for more information.
### Via `.babelrc` (Recommended)
**.babelrc**
```json
{
"plugins": ["async-to-promises"]
}
```
### Via CLI
```sh
$ babel --plugins async-to-promises script.js
```
### Via Node API
```javascript
require("babel-core").transform("code", {
plugins: ["async-to-promises"]
});
```
You can also use the plug-in in [Browserify](http://browserify.org/) using
[babelify](https://github.com/babel/babelify), in [Rollup](http://rollupjs.org/)
by using it in conjunction with
[rollup-plugin-babel](https://github.com/rollup/rollup-plugin-babel), and in
[Webpack](https://webpack.github.io/) using
[babel-loader](https://github.com/babel/babel-loader).
Unsupported
-----------
- Return statements aren't properly supported in switch and try/catch/finally
statements yet ([#13](https://github.com/marten-de-vries/kneden/issues/13))
- No ``eval()``; but that's true for other Babel plugins/presets as well.
Contributing
------------
There are a couple of ways to contribute, for example by:
- Reporting test results with your code base
- Fixing bugs, for a nice starting task see the ones labeled '[good first bug](https://github.com/marten-de-vries/kneden/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+bug%22)'.
Contributions are very welcome! Just open an issue or PR.
What's up with the name?
------------------------
It's Dutch for 'to knead'/'to mold' - the program molds ES7 async/await
constructs into promises. It seemed applicable. [Pronounciation](https://upload.wikimedia.org/wikipedia/commons/0/0e/Nl-kneden.ogg).
The npm package name is a more descriptive one as explained in
[issue #22](https://github.com/marten-de-vries/kneden/issues/22).
License
-------
ISC
---
**Kneden** is a project by [Marten de Vries](https://ma.rtendevri.es/).
|
