journalism

The Journalism Library

[!WARNING]
Starting with version 1.19.0 (October 2024), the library will no longer be updated on NPM. Instead, it will be available on JSR. This is part of migrating the development of the library to Deno, rather than Node.js. You will still be able to install and use it with Node.js, Bun, and Deno. For more information, check the GitHub repository.

A collection of TypeScript functions for journalistic projects.

The library is available on NPM and JSR.

The documentation can be found on Github and JSR.

To install, run the relevant command in your terminal

# DENO
deno install jsr:@nshiab/journalism

# NODE.JS
npx jsr add journalism

# BUN
npx jsr add journalism

If you wish to contribute, create an issue explaining what you would like to add, create a branch from the issue, make sure to add tests, import your function in index.ts and then create a pull request. To run a specific test, you can use a command like this one npx mocha --require ts-node/register ./test/finance/adjustToInflation.test.ts --timeout 10000 -r dotenv/config. To run all tests, including building the library and generating the docs (in ./test-docs), run npm run all-tests.

You might also find simple-data-analysis and Code Like a Journalist interesting.

This repository is maintained by Nael Shiab, computational journalist and senior data producer for CBC News.