fungus
A functional programming library implemented in ES6.
Build Status
Branch | Node | Browser | Coverage |
---|---|---|---|
master | N/A | ||
dev |
Installation and Use
Node
Install using npm install {--save} fungus
and include in your project:
var fungus = require('fungus');
Browser
Include the script in your HTML:
<script src="dist/fungus.min.js" encoding="utf-8"></script>
Currently Fungus is not distributed via Bower, Component, etc. (This will change soon.) For now you can clone and build the repository.
Development
Requirements:
- Node.js v0.10.x
- [Watchman][watchman] (Optional)
Build Tasks
Task | Description |
---|---|
make |
Runs the default task (make build ). |
make test |
Runs the test suite. Runs both the test.node and test.browser tasks. |
make test.node |
Runs the test suite in a Node environment. |
make test.browser |
Runs the test suite in a browser environment. |
make coverage-report |
Generate an HTML coverage report to .tmp/coverage/lcov-report/index.html . |
make build |
Builds the library into ES5-compatible script (minified and unminified). |
make docs |
Builds the documentation. |
Building
To build the library, run the command listed above.
Testing
To run tests, run the command listed above.
Documentation
To build documentation, run the command listed above. To view the built documentation:
cd .tmp/docs
python -m SimpleHTTPServer
open http://localhost:8000