skia2/modules/pathkit/npm-asmjs
Kevin Lubick c7d057103e [PathKit] Move from experimental to modules
Add in Code of Conduct and Contributing.md as well.

Docs-Preview: https://skia.org/?cl=150901
Bug: skia:8216
Change-Id: Ia881124f653617ad0b7b91f40ba21de2c13220a6
Reviewed-on: https://skia-review.googlesource.com/150901
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
2018-08-31 14:18:16 +00:00
..
CODE_OF_CONDUCT.md [PathKit] Move from experimental to modules 2018-08-31 14:18:16 +00:00
CONTRIBUTING.md [PathKit] Move from experimental to modules 2018-08-31 14:18:16 +00:00
example.html [PathKit] Move from experimental to modules 2018-08-31 14:18:16 +00:00
LICENSE [PathKit] Move from experimental to modules 2018-08-31 14:18:16 +00:00
package.json [PathKit] Move from experimental to modules 2018-08-31 14:18:16 +00:00
README.md [PathKit] Move from experimental to modules 2018-08-31 14:18:16 +00:00

An asm.js version of Skia's PathOps toolkit.

To use the library, run npm install experimental-pathkit-asmjs and then simply include it:

<script src="/node_modules/experimental-pathkit-asmjs/bin/pathkit.js"></script>
PathKitInit({
    locateFile: (file) => '/node_modules/experimental-pathkit-asmjs/bin/'+file,
}).then((PathKit) => {
    // Code goes here using PathKit
});

PathKit comes in two parts, a JS loader and the actual WASM code. The JS loader creates a global PathKitInit that can be called to load the WASM code. The locateFile function is used to tell the JS loader where to find the .js.mem file. By default, it will look for /pathkit.js.mem, so if this is not the case, use locateFile to configure this properly. The PathKit object returned through the .then() callback is fully loaded and ready to use.

See the API page and example.html for details on how to use the library.

Using PathKit and WebPack

WebPack's support for asm.js should be straight-forward, since it's just another JS library. PathKit can be used with just a few configuration changes.

In the JS code, use require():

const PathKitInit = require('experimental-pathkit-asmjs/bin/pathkit.js')
PathKitInit().then((PathKit) => {
    // Code goes here using PathKit
})

Since WebPack does not expose the entire /node_modules/ directory, but instead packages only the needed pieces, we have to copy pathkit.mem into the build directory. One such solution is to use CopyWebpackPlugin. For example, add the following plugin:

config.plugins.push(
    new CopyWebpackPlugin([
        { from: 'node_modules/experimental-pathkit-asmjs/bin/pathkit.js.mem' }
    ])
);

If webpack gives an error similar to:

ERROR in ./node_modules/experimental-pathkit-asmjs/bin/pathkit.js
Module not found: Error: Can't resolve 'fs' in '...'

Then, add the following configuration change to the node section of the config:

config.node = {
    fs: 'empty'
};