@vkontakte/elephize

typescript -> php basic transpiler

Usage no npm install needed!

<script type="module">
  import vkontakteElephize from 'https://cdn.skypack.dev/@vkontakte/elephize';
</script>

README

Elephize

Library and tool for transpiling limited set of React & Typescript constructions into PHP for use in server-side rendering.

Usage

NPM:

npm install -D @vkontakte/elephize or yarn add -D @vkontakte/elephize

Check error messages for peerDependencies errors, as elephize requires typescript to work.

Play with lib and demo (github):

git clone https://github.com/VKCOM/elephize.git

cd elephize && yarn

yarn demo_start

This will set up demo files in demo/public folder and run two servers:

  • React node server with native ReactDOM on port 3000
  • Php simple server with transpiled sources on port 8000

To see help, use bin/elephize --help or ./node_modules/.bin/elephize --help if you've installed elephize as a module.

You can use debugger; statement in your ts code to debug transpilation process and check context variables. When run with node debugger, this statement will pause the execution process when source file transpilation reaches the statement. It's useful to combine it with manual breakpoints to check particular cases.

Documentation (ru)

Documentation (en)

Help wanted! If you have time to translate docs to english, please feel free to send us your PRs.