eris's Introduction

Eris

Eustia official module repository.

To check all current available functions, see doc.md.

Another Lodash?

No. The goal of Eustia is to provide a huge number of useful and small JavaScript codes, not just functions, but also modules and classes. Think of it as a mini version of npm suitable for tiny packages.

Usage

It is recommended to use the official bundler eustia to easily build a customized utility library for your project. But if you don't like it, just install eustia-module and use it like any other npm utility modules such as lodash.

npm i eustia-module --save

var uuid = require('eustia-module/uuid');

console.log(uuid()); // -> 0e3b84af-f911-4a55-b78a-cedf6f0bd815

Submitting New Modules

Unable to find one suitable? Fork it on GitHub, add the module and submit a pull request.

Please check Eustia Documentation about how to write an eustia module.

Rules

Must have full documentation about usage.
Must have test.
Must named with a-zA-Z$ characters only.
Must not be repeated. (e.g. leftPad is not allowed because there is already a module called lpad)
Must within a file, less than 500 lines. (with comments and blank lines counted)

How to Add

Fork and clone the repository.
npm i && npm link to register eris command in your system.
Create a js file named with the module name and its corresponding test file.
Write the source code along with the documentaion and test. (documentation is the first block comment written in markdown)
eris test <module-name> to generate the test files(use -k if test should run in a browser), then run mocha test/<module-name> or karma start for testing.
npm run cov for checking the test coverage. (istanbul is required)
Add the module name to test.json so that travis-ci can test it automatically.
Update eris.json and doc.md by running npm run update.