pretty-html-log

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #golang #machine-learning #rust #linux #macos #awesome #kubernetes #openai #open-source

pretty-html-log

(★ 38)

A module that allows you to pretty print the inner HTML of ComponentFixtures, DebugElements, NativeElements or even plain HTML strings to the console. This is very useful for debugging Angular component tests in Jest

pretty-html-log 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# @angular-extensions/pretty-html-log

**Improved debugging of Angular component tests with Jest!**

> The @angular-extension/pretty-html-log is a module that makes debugging component tests with Jest a breeze.
> It adds a `phl` method which pretty prints the _innerHTML_ of a `ComponentFixture`, a `DebugElement`, a `NativeElement` or an HTML string.

![logNgHTML](https://raw.githubusercontent.com/angular-extensions/pretty-html-log/master/images/logo.png)

- [Why you should use this module](#why-you-should-use-this-module)
- [Features](#features)
- [Getting started](#getting-started)
  - [Installation](#installation)
  - [Usage](#usage)
    - [Usage via import](#usage-via-import)
    - [Usage via globals](#usage-via-globals)
- [API](#api)
- [Examples](#examples)
  - [Pass in specific DebugElement](#pass-in-specific-debugelement)
  - [Examples](#examples-1)
  - [Print Angular comments](#print-angular-comments)
  - [Change the theme](#change-the-theme)
- [Further resources](#further-resources)
  - [Blog post](#blog-post)
  - [Video tutorial](#video-tutorial)

## Why you should use this module

When debugging component tests, it’s often necessary to inspect the DOM. The most common approach to do so is by using the good old `console.log` which has some downsides.

First of all, it’s annoying to always type

```typescript
fixture.debugElement.nativeElement.innerHTML;
```

Moreover, the `console.log` statement doesn’t print the HTML in a very readable way. Therefore we still need to copy the string in a new HTML file and format it to be able to inspect it. Not with **@angular-extensions/pretty-html-log**!

![logNgHTML](https://raw.githubusercontent.com/angular-extensions/pretty-html-log/master/images/before-after.png)

## Features

- Provides a `phl` method that highlights and pretty prints a `fixture`, `debugElement`, `nativeElement` or even a plain HTML string - you don't have to worry how to get to the HTML, just pass the thing you want to print to the `phl` method.
- in case you are using prettier (which you should ;)), pretty-html-log will pick
  up your prettier config and pretty print the HTML string based on your prettier configuration. 🤩

## Getting started

### Installation

This module will only be used during development and can therefore be installed as a dev dependency.

```
npm i -D @angular-extensions/pretty-html-log
```

### Usage

pretty-html-log can be used in two different ways. The first and most
simple way is to simply import the `phl` function into your test.

#### Usage via import

The `@angular-extensions/pretty-html-log` package provides a `phl` method that you can use to pretty print a `fixture`, `debugElement`, `nativeElement` or even a plain HTML string. Simply import it while debugging and pretty print that HTML.

```typescript
import { phl } from '@angular-extensions/pretty-html-log';

describe('my test suite', () => {
  it('should be green', () => {
    phl(fixture); // This will pretty print the fixture
    expect(myTable.getRows()).toBe(5);
  });
});
```

Importing the phl function is straightforward. However, since phl is often used as a temporary tool, it can be bothersome to add an import at the top of the file. This is easy to forget and requires manual cleanup afterward.

Wouldn't it be cool if we can simply use the `phl` function without the need of an import. Let's check out how to setup the `phl` function globally.

> To make sure unused import statement get cleaned up we should configure our eslint to clean up unused imports. More: https://www.npmjs.com/package/eslint-plugin-unused-imports.

#### Usage via globals

To make `phl` globally available, import and run the following method within a `jest.setup.ts` file.

```typescript
import { setupPhl } from '@angular-extensions/pretty-html-log';

setupPhl();
```

## API

The `phl` method has the following signature:

```typescript
<T>(
  ngHTMLElement: NgHTMLElement<T>,
  enableComments = false,
  theme = THEMES.DRACULA
)
```

| Property                        | Description                                                                                                        |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| ngHTMLElement<T>                | Value to extract the html from and pretty print it to the console: ComponentFixture                                | DebugElement | DebugElement[] | HTMLElement | HTMLElement[] | string; |
| enableComments (default: false) | When set to true we print the generated comments by Angular. For example: <!--bindings={"ng-reflect-ng-for-of":... |
| theme: (default: DRACULA)       | pretty-html-log themes (DRACULA, VSCODE and MATERIAL)                                                              |

## Examples

### Pass in specific DebugElement

In your test you can simply write the following line.

```typescript
phl(fixture.debugElement.query(By.css('mat-tab-body')));
```

Which will print the following string to your console. Depending on your test configuration you
might run into an issue with the patch of the console. In such cases its best to report an [issue](https://github.com/angular-extensions/pretty-html-log/issues) and use the `logNgHTML` function directly.

```typescript
phl(fixture.debugElement.query(By.css('mat-tab-body')));
```

![logNgHTML](https://raw.githubusercontent.com/angular-extensions/pretty-html-log/master/images/output.png)

### Examples

Log the content innerHTML of a fixture

```typescript
phl(fixture);
```

of a debugElement (or multiple debugElements)

```typescript
phl(fixture.debugElement);
```

of a nativeElement (or multiple nativeElements)

```typescript
phl(fixture.debugElement.nativeElement);
```

or even a simple HTML string

```typescript
phl('<h1>Foo</h1>');
```

### Print Angular comments

Angular adds some comments to our HTML file. Usually, when debugging our tests, we don't need them. Therefore they
are not printed by default. However, there are cases where you want to print those comments. To do so, you
can pass `true` as an additional flag tot he `logNgHTML` method.

```typescript
phl(fixture, true);
```

### Change the theme

`@angular-extensions/pretty-html-log` allows you to print the html logs in different themes.
Currently, we support (DRACULA, VSCODE and MATERIAL). The themes can be importet from `pretty-html-log`, the base library `@angular-extensions/pretty-html-log` depends on.

```typescript
import { THEMES } from 'pretty-html-log';

console.logNgHTML(fixture, false, THEMES.VSCODE);
```

## Further resources

### Blog post

[Improved debugging of Angular component tests in Jest](https://medium.com/angular-in-depth/improved-debugging-of-angular-component-tests-in-jest-ac035e521763) is a write up on AngularInDepth that shows how `@angular-extensions/pretty-html-log` is used and set up in a project.

### Video tutorial

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/jW_B91PKzMY/0.jpg)](https://www.youtube.com/watch?v=jW_B91PKzMY)

pretty-html-log

pretty-html-log 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

pretty-html-log

pretty-html-log 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README