Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salsify/ember-debug-logger
An Ember addon for attaching debug logging to container-managed objects
https://github.com/salsify/ember-debug-logger
npm
Last synced: about 1 month ago
JSON representation
An Ember addon for attaching debug logging to container-managed objects
- Host: GitHub
- URL: https://github.com/salsify/ember-debug-logger
- Owner: salsify
- License: mit
- Created: 2015-06-19T19:51:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T15:09:33.000Z (11 months ago)
- Last Synced: 2024-07-19T02:31:46.369Z (5 months ago)
- Topics: npm
- Language: JavaScript
- Homepage:
- Size: 604 KB
- Stars: 36
- Watchers: 53
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-debug-logger - Exposes the visionmedia/debug library for use in your Ember.js application. (Packages / Debugging / Profiling)
README
# ember-debug-logger [](https://travis-ci.org/salsify/ember-debug-logger)
`ember-debug-logger` exposes the [visionmedia/debug](https://github.com/visionmedia/debug) library for use in your Ember.js application.
Installation
------------------------------------------------------------------------------
`ember install ember-debug-logger`
## Usage
The [debug library](https://github.com/visionmedia/debug) is available for standard use by import:
```js
import debug from 'debug';
const log = debug('demo-namespace');
log('Hello, world');
```
### Enabling Namespaces During Debugging
During development, you can enable logging for particular namespaces calling `debug.enable` in the developer console. Your preferences will be persisted in local storage, but they're only checked when a logger is instantiated, so in most cases you'll need to refresh the page to see them take effect.
Enabled namespaces follow simple globbing rules, so to enable logging for everything, you could use:
```js
debug.enable('*');
```
To enable only logging coming from the application route:
```js
debug.enable('route:application');
```
You can mix and match as well. To enable logging for all routes and the `foo-bar` service, for instance:
```js
debug.enable('route:*, service:foo-bar');
```
You can turn off all logging with `disable`:
```
debug.disable();
```
Namespaces will automatically be differentiated by color, and the time between messages will be logged.
### Automatic Namespacing
This addon exports a `debugLogger` function you can attach to a class definition. The resulting method will automatically use its instance's container key as the namespace.
```js
// app/routes/index.js
import Route from '@ember/route';
import debugLogger from 'ember-debug-logger';
export default Route.extend({
debug: debugLogger();
activate() {
this.debug('Hello from the application index.');
}
});
```
