Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/B1naryStudio/js-mobile-console
Console for debugging web apps right on mobile device
https://github.com/B1naryStudio/js-mobile-console
Last synced: 3 months ago
JSON representation
Console for debugging web apps right on mobile device
- Host: GitHub
- URL: https://github.com/B1naryStudio/js-mobile-console
- Owner: B1naryStudio
- Created: 2014-10-29T14:42:18.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-10-24T11:59:43.000Z (about 6 years ago)
- Last Synced: 2024-07-28T18:08:18.471Z (4 months ago)
- Language: JavaScript
- Homepage: http://b1narystudio.github.io/js-mobile-console/
- Size: 69.3 KB
- Stars: 367
- Watchers: 14
- Forks: 40
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
js-mobile-console
=====
## Install
**Zip archive**:
[Download](https://github.com/msemenistyi/js-mobile-console/archive/master.zip)
**Browserify**:
> npm install js-mobile-console
[](https://nodei.co/npm/js-mobile-console/)
**Bower**:
> bower install js-mobile-console
## Overview
[Live demo](http://b1narystudio.github.io/js-mobile-console/).
It is extremely nice, that we are on the road of specifying and unifying remote
debugging protocol and we can already remotely debug web applications on desktop
Chrome, but what if we want to get it working also on Android browser or
Safari for iOs?
MobileConsole can be embedded within any page for debugging, it will catch errors
and behave exactly as native js console in browser. It also outputs all the logs
you've written via an API of window.console.
### How is it different from all the existing instruments?
There are already plenty of ways for testing mobile applications. The most
advanced is at the moment Chrome remote debugging. Still it is available only
Chrome to Chrome.
Another way is to use [weinre](http://people.apache.org/~pmuellr/weinre-docs/latest/) -
tool for remote debugging. It is quite nice and suggests rich functionality. Still
it seems quite heavy for me. You should setup a dedicated server for it.
js-mobile-console is in contrast lightweight and requires almost no configuration,
you can just include it into your page and debug it when an error appears.
*stevemao* also stated that it may come handy for debugging
[web views](https://github.com/B1naryStudio/js-mobile-console/issues/1).
### Loading
Css file should be included within html:
```html
```
Console may be used without any modular system:
```html
```
With help of browserify:
```js
var mobileConsole = require('js-mobile-console');
```
Or AMD style (RequireJS):
```js
define(['js-mobile-console'], function(mobileConsole))
```
### Usage
Simple usage:
```js
mobileConsole.show();
```
Advanced usage:
```js
mobileConsole.options({
showOnError: true,
proxyConsole: false,
isCollapsed: true,
catchErrors: true
});
```
Conditional toggling:
```js
if (condition) {
mobileConsole.show();
} else {
mobileConsole.hide();
}
```
Commands specifying:
```js
mobileConsole.commands({
'check': 'var a = 10; a;',
'run': '10/5'
});
```
### API
- **show** - show console with default options.
- **hide** - hide console.
- **options** - method to initialize console, by default will show console,
accepts hash of options.
- **commands** - method to specify a hash of commands, which later can be
executed within console.
### Options
- **showOnError** - *Default* false. Console will be hidden if no show method
was called, but it will appear if any error occurs.
- **proxyConsole** - *Default* true. Determines if window.console methods are
proxied to mobile console.
- **isCollapsed** - *Default* false. Determines if Console is collpased on startup.
- **catchErrors** - *Default* false. Determines if Console is registring
window.onerror method in order to catch errors.
## Created by [msemenistyi](https://github.com/msemenistyi)
## Changelog
### 0.4.0 (2018-10-24)
- fix handling of undefined
- added ability to style output with %c
### 0.3.3 (2018-10-24)
- add possibility to add line breaks in console.log strings with \n
### 0.3.0 (2014-11-11)
- add possibility to specify commands;
- add JSON.stringifying for logging;
- set z-index to console
- fix startup error on logValue
## Contributing
Feel free to open issues and send PRs.
## License
The MIT License (MIT)
[](http://binary-studio.com)
Copyright (c) 2014-2018 Semenistyi Mykyta [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.