https://github.com/unlyed/utils-simple-logger
https://github.com/unlyed/utils-simple-logger
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/unlyed/utils-simple-logger
- Owner: UnlyEd
- License: mit
- Created: 2019-01-08T15:19:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-08T21:18:09.000Z (about 5 years ago)
- Last Synced: 2024-10-10T22:39:00.593Z (over 1 year ago)
- Language: JavaScript
- Size: 199 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/UnlyEd/utils-simple-logger)
[](https://codeclimate.com/github/UnlyEd/utils-simple-logger/maintainability)
[](https://codeclimate.com/github/UnlyEd/utils-simple-logger/test_coverage)
[](https://snyk.io/test/github/UnlyEd/utils-simple-logger?targetFile=package.json)
# Utils Simple Logger
> # Deprecation notice:
> ## This project has been deprecated in favor of [`@unly/simple-logger`](https://github.com/UnlyEd/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](https://github.com/UnlyEd/next-right-now/pull/314).
---
Logger based on [Winston](https://github.com/winstonjs/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](#getting-started)
- [API](#api)
- [Contributing](#contributing)
* [Getting started](#getting-started-1)
* [Test](#test)
* [Releasing and publishing](#releasing-and-publishing)
- [License](#license)
- [Vulnerability disclosure](#vulnerability-disclosure)
- [Contributors and maintainers](#contributors-and-maintainers)
- [**[ABOUT UNLY]**](#about-unly-)
## Getting started
npm or yarn
```
npm install @unly/utils-simple-logger
```
Use:
```
const logger = require('@unly/utils-simple-logger');
```
## API
[API](./API.md)
---
## 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](https://github.com/UnlyEd/Unly).
---
# Contributors and maintainers
This project is being maintained by:
- [Unly] Ambroise Dhenain ([Vadorequest](https://github.com/vadorequest)) **(active)**
Thanks to our contributors:
- Anthony Troupenat ([Fukoyamashisu](https://github.com/Fukoyamashisu))
---
# **[ABOUT UNLY]**
> [Unly](https://unly.org) 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 :
- https://twitter.com/UnlyEd
- https://www.facebook.com/UnlyEd/
- https://www.linkedin.com/company/unly
- [Interested to work with us?](https://jobs.zenploy.io/unly/about)
Tech tips and tricks from our CTO on our [Medium page](https://medium.com/unly-org/tech/home)!
#TECHFORGOOD #EDUCATIONFORALL