https://github.com/joelburget/haste-commonjs
Write CommonJS (Browserify, Webpack) modules in Haste
https://github.com/joelburget/haste-commonjs
Last synced: about 2 months ago
JSON representation
Write CommonJS (Browserify, Webpack) modules in Haste
- Host: GitHub
- URL: https://github.com/joelburget/haste-commonjs
- Owner: joelburget
- Fork: true (RudolfVonKrugstein/haste-ffi-parser)
- Created: 2015-01-24T16:59:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-01-28T21:23:29.000Z (over 10 years ago)
- Last Synced: 2024-08-03T15:06:43.847Z (11 months ago)
- Language: Haskell
- Homepage:
- Size: 153 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
haste-commonjs
==============
Easily use CommonJS modules from Haste.
Example
-------
```haskell
foreign import commonjs "require('adder')" adder :: Int -> Int -> Int
```
This allows us to use CommonJS imports, avoiding globals. For example, before haste-commonjs, importing adder from a CommonJS module would require
haskell:
```haskell
foreign import ccall "global_adder" adder :: Int -> Int -> Int
```
javascript:
```javascript
global_adder = require('adder');
```
Specifying Options
------------------
Haste-commonjs uses npm's [package.json](https://docs.npmjs.com/files/package.json) to specify a few Haste options.
### Example (from [material-ui-hs](https://github.com/joelburget/material-ui-hs))
```json
{
"name": "material-ui-hs",
"version": "0.0.1",
"haste-options": {
"in": "Main.hs",
"out": "out.js",
"stubs": ["hs-stubs.js"],
"conversions": [
{
"hsTy": "String",
"jsTy": "JSString",
"hsToJs": "fromJS",
"jsToHs": "toJS"
}
]
}
}
```
* `in`: The source Haskell file we're transforming into a module
* `out`: Where to put the resulting JavaScript
* `stubs`: Javascript stubs to be included by Haste with `--with-js`.
* `conversions`: haste-commonjs can perform some type conversions automatically for you! Here I'm declaring that Haskell's `String` is equivalent to a JavaScript `JSString`.
running
-------
Now that we've specified the options it couldn't be simpler to compile our Haskell to JavaScript:
```shell
> haste-commonjs
```
This uses `package.json` to package `Main.hs` into `out.js`, a CommonJS module:
`out.js`:
```javascript
(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o Prop -> IO ()
foreign import commonjs
"React.createElement(require('material-ui').LeftNav, %1, %2)"
mui_leftNav :: RawAttrs -> ReactArray -> IO ForeignNode
```