npm package: @quarkunlimit/mobx-log
Description: [![Npm Version](https://badge.fury.io/js/mobx-log.svg)](https://badge.fury.io/js/mobx-log) [![NPM downloads](http://img.shields.io/npm/dm/mobx-log.svg)](https://www.npmjs.com/package/mobx-log) [![Tests](https://github.com/kubk/mobx-log/actions/workflows/m
Author: Egor Gorbachev
Latest version: 0.0.3

# mobx-log

[![Npm Version](https://badge.fury.io/js/mobx-log.svg)](https://badge.fury.io/js/mobx-log)
[![NPM downloads](http://img.shields.io/npm/dm/mobx-log.svg)](https://www.npmjs.com/package/mobx-log)
[![Tests](https://github.com/kubk/mobx-log/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/kubk/mobx-log/actions/workflows/main.yml)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Logger + Redux devtools for Mobx 6+. Works only in dev mode.
![screenshot](.github/screely.png)

### Installation

```
npm i mobx-log
```

### Usage with Redux Devtools

1. Make sure [Redux Devtools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd?hl=en) are installed
2. Add `makeLoggable` to each store you'd like to debug:

```diff
import { makeLoggable } from 'mobx-log'

class SomeStore {
  ...

  constructor() {
    makeAutoObservable(this)
+   makeLoggable(this)
  }
}
```

### Usage with browser logger

1. Add `makeLoggable` to a store:

```diff
class SomeStore {
  ...

  constructor() {
    makeAutoObservable(this)
+   makeLoggable(this)
  }
}
```

2. In Chrome DevTools, press F1 to load the Settings. Scroll down to the Console section and check "Enable custom formatters":

![alt text](https://www.mattzeunert.com/img/blog/custom-formatters/custom-formatters-setting.png)

You'll only need to do it once.

3. If you have Redux devtools installed then you need to deactivate it. The `mobx-log` package tries to detect automatically what you'd like to use - browser console or Redux devtools. Installed Redux devtools take precedence over browser console.

### Use only browser formatters

`mobx-log` uses custom Chrome formatters, so you won't see awkward `[Proxy, Proxy]` in your console anymore. All your `console.log(store)` calls will be nicely formatted. If it is the only feature you need from this package, you can use just formatters:

```typescript
import { applyFormatters } from 'mobx-log';

applyFormatters();
```

Make sure this function is called at the very top of your code

## Customize

### Access stores as global variables in browser console.

By default, all the stores marked as loggable become accessible as global variables. Example:

```js
class AuthStore {
  constructor() {
    makeLoggable(this);
  }
}
```

Then you can type `store.authStore` in your browser console. Feel free to log store, call actions and computeds in the console. Works only in dev mode.

If you'd like to disable this feature use this:

```js
import { configureLogger } from 'mobx-log';

configureLogger({
  storeConsoleAccess: false,
});
```

Make sure this function is called at the very top of your code

### Log observables / computeds / actions conditionally

An example how to log only `actions` and `computeds`:

```js
import { configureLogger } from 'mobx-log';

configureLogger({
  filters: {
    computeds: true,
    actions: true,
    observables: false,
  },
});
```

### Log observables / computeds / actions of a specific store.

An example how to log only changes in `computeds` of a store `Counter`.

```js
import { makeLoggable } from 'mobx-log';

class Counter {
  value = 0;

  constructor() {
    makeAutoObservable(this);
    makeLoggable(this, {
      filters: {
        events: {
          computeds: true,
          observables: false,
          actions: false,
        },
      },
    });
  }
}
```

### Customize logger output

Example - add time for each log entry:

```typescript
import { configureLogger, DefaultLogger, LogWriter } from 'mobx-log';

export const now = () => {
  const time = new Date();
  const h = time.getHours().toString().padStart(2, '0');
  const m = time.getMinutes().toString().padStart(2, '0');
  const s = time.getSeconds().toString().padStart(2, '0');
  const ms = time.getMilliseconds().toString().padStart(3, '0');

  return `${h}:${m}:${s}.${ms}`;
};

class MyLogWriter implements LogWriter {
  write(...messages: unknown[]) {
    console.log(now(), ...messages);
  }
}

configureLogger({
  logger: new DefaultLogger(new MyLogWriter()),
});
```

### Usage with factory functions

With Mobx 6 you can create stores without classes using makeAutoObservable / makeObservable:

```typescript
export const createDoubler = () => {
  return makeAutoObservable({
    value: 0,
    get double() {
      return this.value * 2;
    },
    increment() {
      this.value++;
    },
  });
};
```

You can also log such stores using `makeLoggable`:

```typescript
export const createDoubler = () => {
  return makeLoggable(
    makeAutoObservable({
      loggableName: 'doubler', // <-- Required
      value: 0,
      get double() {
        return this.value * 2;
      },
      increment() {
        this.value++;
      },
    })
  );
};
```

The store also become available in console if you turn on `storeConsoleAccess` option.

### Usage with `useLocalObservable`

Before:

```typescript
import { useLocalObservable } from 'mobx-react-lite'

...

const App = observer(() => {
  const counterStore = useLocalObservable(() => {
    count: 0,
    increment: () => this.count++,
  })

  return ...
})
```

After:

```typescript
import { useMakeLoggable } from 'mobx-log'

...

const App = observer(() => {
  const counterStore = useLocalObservable(() => {
    count: 0,
    increment: () => this.count++,
  })
  useMakeLoggable(counterStore, 'counter')

  return ...
})
```

The store also become available in console if you turn on `storeConsoleAccess` option.

### How it is different from alternatives?

- [mobx-logger](https://github.com/winterbe/mobx-logger) doesn't show [observables and computeds](https://github.com/winterbe/mobx-logger/issues/34) with Mobx 6 due to changes in Mobx internals.
- [mobx-remotedev](https://github.com/zalmoxisus/mobx-remotedev/issues) is [not maintained](https://github.com/zalmoxisus/mobx-remotedev/issues/55) anymore. It also doesn't show computeds.
- [mobx-devtools](https://github.com/mobxjs/mobx-devtools) does not show changes in computeds
- [mobx-react-devtools](https://github.com/mobxjs/mobx-react-devtools) is deprecated
- [mobx-formatters](https://github.com/motion/mobx-formatters) doesn't support Map & Set. Also it's just a proxy formatter, not a logger

### Example project

This library has example project located in `./example` folder. It is used for development purposes. To run it go to `./example` folder and run `npm run start`.

### Store destructuring

Prior to Mobx 6.3.4 bound actions didn't appear in the log. If you are using store destructuring and want your actions appear in the log please update your Mobx to 6.3.4. See the discussion for details: https://github.com/mobxjs/mobx/discussions/3140