Utils Simple Logger

May 8, 2021 ยท View on GitHub

Unly logo Build Status Maintainability Test Coverage Known Vulnerabilities

Utils Simple Logger

Deprecation notice:

This project has been deprecated in favor of @unly/simple-logger which is 1kB (instead of 40kB+) and doesn't rely on winston.

Overall, the new implementation is much better and uses TypeScript, and is compatible with the native console API. See migration example.

Logger based on Winston with sane default so that it only logs error in production and filter other logs, while keeping them all in non-production environments.

Basically avoids to increase cost by logging too much stuff in production.

Getting started

npm or yarn

npm install @unly/utils-simple-logger

Use:

const logger = require('@unly/utils-simple-logger');

API

API

Contributing

We gladly accept PRs, but please open an issue first so we can discuss it beforehand.

Getting started

yarn start # Shortcut - Runs linter + build + tests in concurrent mode (watch mode)

OR run each process separately for finer control

yarn lint
yarn build
yarn test

Test

yarn test # Run all tests, interactive and watch mode
yarn test:once
yarn test:coverage

Releasing and publishing

yarn releaseAndPublish # Shortcut - Will prompt for bump version, commit, create git tag, push commit/tag and publish to NPM

yarn release # Will prompt for bump version, commit, create git tag, push commit/tag
npm publish # Will publish to NPM

License

MIT

Vulnerability disclosure

See our policy.

Contributors and maintainers

This project is being maintained by:

Thanks to our contributors:

[ABOUT UNLY] Unly logo

Unly is a socially responsible company, fighting inequality and facilitating access to higher education. Unly is committed to making education more inclusive, through responsible funding for students. We provide technological solutions to help students find the necessary funding for their studies. We proudly participate in many TechForGood initiatives. To support and learn more about our actions to make education accessible, visit :

Tech tips and tricks from our CTO on our Medium page!

#TECHFORGOOD #EDUCATIONFORALL