https://github.com/devappd/emscripten-sdk-npm
Install the Emscripten SDK using NPM. Provides a CLI and API for Node.js.
https://github.com/devappd/emscripten-sdk-npm
emscripten emscripten-sdk emsdk nodejs npm wasm webassembly
Last synced: 5 months ago
JSON representation
Install the Emscripten SDK using NPM. Provides a CLI and API for Node.js.
- Host: GitHub
- URL: https://github.com/devappd/emscripten-sdk-npm
- Owner: devappd
- License: mit
- Fork: true (bvibber/emsdk-npm)
- Created: 2020-12-20T02:35:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T21:39:41.000Z (over 3 years ago)
- Last Synced: 2026-01-12T12:14:48.313Z (5 months ago)
- Topics: emscripten, emscripten-sdk, emsdk, nodejs, npm, wasm, webassembly
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/emscripten-sdk
- Size: 178 KB
- Stars: 3
- Watchers: 0
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# emscripten-sdk
[](https://github.com/devappd/emsdk-npm/actions?query=workflow%3Atest-branch) [](https://www.npmjs.com/package/emscripten-sdk) [](https://github.com/devappd/emsdk-npm/blob/master/LICENSE)
An NPM wrapper for the [Emscripten SDK](https://emscripten.org/).
This package installs the Emscripten compiler and provides a command line and a JS interface to use in your build scripts.
You may install one of these two packages:
* [emscripten-sdk](https://www.npmjs.com/package/emscripten-sdk) -- Control the SDK version via the NPM package version. Recommended.
* [emscripten-sdk-npm](https://www.npmjs.com/package/emscripten-sdk-npm) -- Control the SDK version via CLI/API parameters. For advanced use.
## Command line usage
```sh
npx emsdk-checkout
# To update SDK tags, run both `npx emsdk-pull` and `npx emsdk update-tags`
npx emsdk install
npx emsdk activate
npx emsdk-run emcc test/test.c -o test/test.html
```
The `version` parameter is not required when using the `emscripten-sdk` package.
## JavaScript usage
```js
const emsdk = require('emsdk-npm');
emsdk.checkout()
.then(() => emsdk.update())
.then(() => emsdk.install(version))
.then(() => emsdk.activate(version))
.then(() => emsdk.run(
'emcc',
[
// Arguments
'test/test.c', '-o', 'test/test.html'
],
{
// child_process.spawn options, e.g., cwd
}
))
.catch((err) => {
// handle err...
});
```
The JS interface will skip installing the SDK and version if they already exist.
The `version` parameter is not required when using the `emscripten-sdk` package.
## Install
```sh
npm install --save-dev emscripten-sdk
```
Before you install this package, you must install Python 3.6+ on your system. You may download it at [python.org](https://www.python.org/downloads/) or your OS's package manager.
By default, the SDK is installed into your `node_modules` tree. You may specify a custom path by
[modifying your NPM config](https://docs.npmjs.com/cli/v6/using-npm/config) via one of the commands below. Do this **before** you install the package:
|Action|Command
|------|-------
| Save the path to your project `.npmrc` | `npm config --userconfig "/your/project/root/.npmrc" set emsdk "/your/absolute/custom/path"`
| Save the path to your user `.npmrc` | `npm config set emsdk "/your/absolute/custom/path"`
| Set an environment variable | `set NPM_CONFIG_EMSDK=/your/absolute/custom/path`
| Use a config argument to NPM temporarily | `npm [command] --emsdk="/your/absolute/custom/path"`
## Version selection
If you install the `emscripten-sdk` package, then the Emscripten version is selected via the NPM
package version. Change the version you need by editing your `package.json`.
For example, to force version `1.40.1`, you specify the NPM tag as `sdk-1.40.1`. On the command line:
```sh
npm install --save-dev emscripten-sdk@sdk-1.40.1
```
You may only specify single versions this way. You may not specify version ranges. If you do not specify a version, then the latest version will be selected.
If you install the `emscripten-sdk-npm` package, then you will specify the `version` parameter in the command line and JS API. To force version `1.40.1`, you specify `1.40.1`. To select the most recent version, you specify `latest`.
### Upgrading the SDK
If you install the `emscripten-sdk` package, then you are locked into your selected SDK version unless
you opt-in to a newer version. If you selected `latest`, then you are locked into the most recent
version at the time of installation.
To upgrade, enter this command once a new version is published:
```sh
npm install --save-dev emscripten-sdk@latest
```
If you install the `emscripten-sdk-npm` package, then you will receive updates so long as you update
the SDK store via `npx emsdk-pull` or the API `emscripten.update()`, then install the `latest` SDK version.
## License
MIT License.