Skip to content

Create new rule for no aliasing imports and clean out repo for use for future rules #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 14, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 1 addition & 105 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1 @@
# js-logger

This library provides a JavaScript/TypeScript logger inspired by Python's logger.

* Simple logging with default handlers supporting `console.log`, `console.error`, and `process.stderr`.
* Fast, logging level checks or log filters are applied **before** log records are created
* Complex log records properties ssupport lazy evaluation, so they evaluated only when they need to be rendered
* Flexible composition of loggers, handlers and formatters
* Custom formatting using template literals
* Supports structured logging through a JSON formatter
* Supports hierarchical logging through parent-child logger graph
* CI/CD tests on Linux, MacOS and Windows
* Zero runtime dependencies!
* Comprehensive continuous benchmarks in CI/CD

## Installation

```sh
npm install --save @matrixai/logger
```

## Usage

```ts
import Logger, { LogLevel, StreamHandler, formatting } from '@matrixai/logger';

const logger = new Logger('root', LogLevel.INFO, [
new StreamHandler(
formatting.format`${formatting.date}:${formatting.level}:${formatting.key}:${formatting.msg}:${formatting.data}`,
),
]);

logger.debug('Hello world', { a: { b: [123, 456] } });
logger.info('Hello world', { 123: { b: [123, 456] } });
logger.warn('Hello world', { lazy: () => 'string' });
logger.error('Hello world', formatting.format`my custom format`);

const loggerChild = logger.getChild('child');

loggerChild.info(
'Hello world',
{ 123: { b: [123, 456] } },
formatting.format`${formatting.keys}:${formatting.msg}:${formatting.data}`,
);
```

There's lots more options available in the source code. See the docs and see the source code for more details.

## Development

Run `nix develop`, and once you're inside, you can use:

```sh
# install (or reinstall packages from package.json)
npm install
# build the dist
npm run build
# run the repl (this allows you to import from ./src)
npm run tsx
# run the tests
npm run test
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
```

### Docs Generation

```sh
npm run docs
```

See the docs at: https://matrixai.github.io/js-logger/

### Publishing

Publishing is handled automatically by the staging pipeline.

Prerelease:

```sh
# npm login
npm version prepatch --preid alpha # premajor/preminor/prepatch
git push --follow-tags
```

Release:

```sh
# npm login
npm version patch # major/minor/patch
git push --follow-tags
```

Manually:

```sh
# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags
```
# js-eslint
62 changes: 0 additions & 62 deletions benches/index.ts

This file was deleted.

43 changes: 0 additions & 43 deletions benches/logger_filtered.ts

This file was deleted.

56 changes: 0 additions & 56 deletions benches/logger_handlers.ts

This file was deleted.

64 changes: 0 additions & 64 deletions benches/logger_hierarchy.ts

This file was deleted.

Loading