Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karimayachi/html-console-output
Fancy html-based Javascript console output window
https://github.com/karimayachi/html-console-output
javascript javascript-console jsfiddle typescript
Last synced: 8 days ago
JSON representation
Fancy html-based Javascript console output window
- Host: GitHub
- URL: https://github.com/karimayachi/html-console-output
- Owner: karimayachi
- Created: 2019-12-09T12:49:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T13:14:53.000Z (28 days ago)
- Last Synced: 2024-11-06T20:23:41.386Z (10 days ago)
- Topics: javascript, javascript-console, jsfiddle, typescript
- Language: TypeScript
- Size: 704 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# html-console-output
Fancy html-based Javascript console output window
> Important: html-console-output is still in beta. More data-types visualization and prototype tracing will be added. Could also be buggy.
## What is it?
html-console-output appends console output to the HTML of a webpage. It was made with JSFiddle or similar webtools in mind. It's main purpose is to extend the use of these JavaScript playgrounds to allow debugging and demonstrations. But as it's just HTML added to the webpage, it can be styled and used in any project, for instance as an always open debugging-pane.
## Usage
### CDN / JSFiddle
Insert the following tag in your HTML:
```html
```
Specifically for JSFiddle, add `https://unpkg.com/html-console-output` to the resources.
### NPM
Add the module to your project as a dependency
```shell
npm i html-console-output
```
Import the module ES6-style
```typescript
import 'html-console-output';
```
or CommonJS-style
```javascript
require('html-console-output');
```
## Build
Run development server with test-page:
```shell
npm run dev
```
Build for development from source code:
```shell
npm run build
```
Build for production from source code:
```shell
npm run build-prod
```
## Caveats
Most browsers when logging anything other than primitives to the console don't serialize the object to a string, but keep a reference to the original object. When inspecting the object in the console, you'll inspect the state it has at the time of inspecting, not the time of logging. html-console-ouput on the other hand captures the state at logging-time and serializes it to text.
Consider this example:
```javascript
var person = { name: 'John', age: 41};
console.log(person);
person.age += 1; // go shorty, it's your birthday
console.log(person);
```
When inspecting in Firefox it shows the state at the time of inspecting:
When inspecting in html-console-output it shows the state at the time of logging:
Actually I feel the latter is more useful when debugging timings and dynamic user interfaces, but it's something to keep in mind either way.
## License
Copyright 2019, Karim Ayachi
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.