Contributing

Development

Readable is built using Deno and TypeScript.

A dev script (source in ./dev-tool.ts) should be used instead of deno ... commands.

./dev readable --help

To install globally:

./dev readable install
readable --help

To omit the leading ./ on most platforms, you can create a temporary alias using alias dev=./dev

Tests

Tests should be written in a {module}.test.ts file alongside the relevant {module}.ts.

To run tests:

./dev test

Dependencies

In general, dependencies should be exported as a module in ./deps. If the dependency is a third-party Remark plugin, export it in ./plugins/thirdparty instead.

See existing files for examples.