coffeelib
v0.3.0
Published
A tool to create isomorphic libraries with CoffeeScript
Downloads
135
Readme
Introduction
coffeelib
is a tool to create isomorphic libraries with CoffeeScript. You can install it globally with
npm install coffeelib -g
and then use
coffeelib new NAME
to create a directory named NAME and a new library inside of it. For example, coffeelib new name0
.
After entering the directory with cd name0
, you can use
npm test
;coffeelib build
;coffeelib watch
;
npm test
is to run the tests. coffeelib
creates all new libraries with a basic function and a basic test for it.
coffeelib build
is to build the library. It compiles the sources in the src
directory to the lib
directory.
It creates automatically a ES module wrapper for a CommonJS module.
This allows to use the library both with require
and import
.
coffeelib watch
(or npm start
)
is to rebuild the library when the sources in the src
directory change.
Usage examples
- https://github.com/ch1c0t/fun
- https://github.com/ch1c0t/pascalize.lispcase
- https://github.com/ch1c0t/hyphenate.pascalcase
Development
To work on coffeelib
itself, you can use the following commands.
npm start
to start a development session.
npm test
to run the tests.