JavaScript HTML
Latest commit ba7dc1b Feb 27, 2017 @surunzi surunzi Dev: Tests
Permalink
Failed to load latest commit information.
$ Add: Eslint Feb 1, 2017
a Add: fetch Feb 24, 2017
b Add: base64 Dec 26, 2016
bin Dev: Tween demo Feb 11, 2017
c Dev: Tests Feb 27, 2017
d Fix: Build Jan 31, 2017
e Dev: Tests Feb 27, 2017
f Add: fetch Feb 24, 2017
h Dev: Tests Feb 27, 2017
i Dev: Tests Feb 27, 2017
j Fix: Eslint Feb 20, 2017
k Dev: keys doc Feb 21, 2017
l Dev: Tests Feb 27, 2017
lib Dev: Tests Feb 27, 2017
m Dev: Tests Feb 27, 2017
n Add: nextTick Feb 7, 2017
o Dev: Small changes Dec 15, 2016
p Add: Ajax test Feb 24, 2017
q Fix: query Dec 31, 2016
r Dev: Tests Feb 27, 2017
s Dev: Tests Feb 27, 2017
t Dev: Tests Feb 27, 2017
u Dev: Tests Feb 27, 2017
v Dev: waterfall doc Feb 7, 2017
w Dev: waterfall doc Feb 7, 2017
z Add: property, pluck, zip, unzip Nov 6, 2016
.eslintrc.js Add: Eris command to easy testing Feb 7, 2017
.eustia Add: Eris command to easy testing Feb 7, 2017
.gitignore Add: Tween Feb 7, 2017
.travis.yml Dev: Tests Feb 27, 2017
LICENSE Add: License Jan 8, 2017
README.md Add: Pull request instructions Feb 8, 2017
doc.md Add: fetch Feb 24, 2017
eris.json Add: fetch Feb 24, 2017
package.json Dev: Tests Feb 27, 2017
test.json Dev: Tests Feb 27, 2017

README.md

Eris

NPM version Build status License

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.

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, 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.

Now it's time to submit a pull request:)