Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fullstack-build/tslog
📝 tslog - Universal Logger for TypeScript and JavaScript
https://github.com/fullstack-build/tslog
error-handling exceptions json json-api logger logging logging-library pretty-print stack stacktrace typescript-library
Last synced: 3 months ago
JSON representation
📝 tslog - Universal Logger for TypeScript and JavaScript
- Host: GitHub
- URL: https://github.com/fullstack-build/tslog
- Owner: fullstack-build
- License: mit
- Created: 2020-04-23T09:08:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T19:26:48.000Z (11 months ago)
- Last Synced: 2024-05-01T09:47:17.949Z (9 months ago)
- Topics: error-handling, exceptions, json, json-api, logger, logging, logging-library, pretty-print, stack, stacktrace, typescript-library
- Language: TypeScript
- Homepage: https://tslog.js.org
- Size: 6.35 MB
- Stars: 1,259
- Watchers: 8
- Forks: 60
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome - fullstack-build/tslog - 📝 tslog - Universal Logger for TypeScript and JavaScript (TypeScript)
README
# 📝 tslog: Beautiful logging experience for TypeScript and JavaScript
[](https://www.typescriptlang.org)
[](https://www.npmjs.com/package/tslog)
[](https://codecov.io/github/fullstack-build/tslog?branch=master)
[](https://github.com/prettier/prettier)
[](https://github.com/sponsors/fullstack-build)
[](https://github.com/fullstack-build/tslog)
> Powerful, fast and expressive logging for TypeScript and JavaScript
## Highlights
⚡ **Fast and powerful**
🪶 **Lightweight and flexible**
🏗 **Universal: Works in Browsers and Node.js**
👮️ **Fully typed with TypeScript support (native source maps)**
🗃 **_Pretty_ or `JSON` output**
📝 **Customizable log level**
⭕️ **Supports _circular_ structures**
🦸 **Custom pluggable loggers**
💅 **Object and error interpolation**
🤓 **Stack trace and pretty errors**
👨👧👦 **Sub-logger with inheritance**
🙊 **Mask/hide secrets and keys**
📦 **CJS & ESM with tree shaking support**
✍️ **Well documented and tested**
## Example
```typescript
import { Logger, ILogObj } from "tslog";
const log: Logger = new Logger();
log.silly("I am a silly log.");
```
## [Become a Sponsor](https://github.com/sponsors/fullstack-build)
Donations help me allocate more time for my open source work.
[](https://github.com/sponsors/fullstack-build)
## Install
```bash
npm install tslog
```
In order to run a native ES module in Node.js, you have to do two things:
1) Set `"type": "module"` in `package.json`.
2) For now, start with `--experimental-specifier-resolution=node`
Example `package.json`
```json5
{
"name": "NAME",
"version": "1.0.0",
"main": "index.js",
// here:
"type": "module",
"scripts": {
"build": "tsc -p .",
// and here:
"start": "node --enable-source-maps --experimental-specifier-resolution=node index.js"
},
"dependencies": {
"tslog": "^4"
},
"devDependencies": {
"typescript": "^4"
},
"engines": {
"node": ">=16"
}
}
```
With this `package.json` you can simply build and run it:
```bash
npm run build
npm start
```
**Otherwise:**
ESM: Node.js with JavaScript:
```bash
node --enable-source-maps --experimental-specifier-resolution=node
```
CJS: Node.js with JavaScript:
```bash
node --enable-source-maps
```
ESM: Node.js with TypeScript and `ts-node`:
```bash
node --enable-source-maps --experimental-specifier-resolution=node --no-warnings --loader ts-node/esm
```
CJS: Node.js with TypeScript and `ts-node`:
```bash
node --enable-source-maps --no-warnings --loader ts-node/cjs
```
Browser:
```html
tslog example
Example
const logger = new tslog.Logger();
logger.silly("I am a silly log.");
```
**Enable TypeScript source map support:**
This feature enables `tslog` to reference a correct line number in your TypeScript source code.
```json5
// tsconfig.json
{
// ...
compilerOptions: {
// ...
"inlineSourceMap": true, //