Diesal

Diesal is a library of ES2015 modules implementing common data structures and algorithms. The goal is to wind up with clean, easy to understand, well-tested, well-documented code, that (with the right tools) can be minimally included into other projects.

Clean & Easy to Understand

No tricks, no hacks. Nothing that belongs in code golf. Sensible variable names. You should be minifying your code; there's no need to deal with that directly. Code should be self-explanatory, and where it might have to get a bit confusing, there are ample comments explaining, in detail, what is going on. There is also linting validation as part of the CI.

Well-Tested

Master branch with all tests passing and 100% branch coverage, always.

Well-Documented

Full API documentation generated regularly as part of the release process.

Minimally Included

No packaging into a huge library. Classes are individually importable. npm install the package, then import the modules you want.

For the web, bower install. This will actually install the source as-is -- no transpilation. If you are using tools that allow this (e.g. webpack), you should be able to import only the pieces of Diesal that your app needs, and then minify without all the extra cruft.

Running Tests/Coverage

npm test

npm run coverage

or

npm run coverage-html

for an HTML report (in coverage/index.html).

Contributing

Contributions welcome, submit a PR.

License

ISC