push.rocks/smartdebug
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated Readme and Test

Browse Source
This commit is contained in:
Philipp Kunz 2015-11-17 02:29:18 +01:00
parent 1a9bd0fc15
commit 7e588db44a
3 changed files with 20 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,39 +1,18 @@
# gulp-bootstrap
# smartdebug
works with gulp, but does nothing. Use it to bootstrap your own gulp plugin with TypeScript, Travis and npm.
### Buildstatus/Dependencies
[![Build Status](https://travis-ci.org/pushrocks/gulp-bootstrap.svg?branch=master)](https://travis-ci.org/pushrocks/gulp-bootstrap)
[![devDependency Status](https://david-dm.org/pushrocks/gulp-bootstrap/dev-status.svg)](https://david-dm.org/pushrocks/gulp-bootstrap#info=devDependencies)
[![Build Status](https://travis-ci.org/pushrocks/smartdebug.svg?branch=master)](https://travis-ci.org/pushrocks/smartdebug)
[![devDependency Status](https://david-dm.org/pushrocks/smartdebug/dev-status.svg)](https://david-dm.org/pushrocks/smartdebug#info=devDependencies)
### Usage
This npm package comes with everything you need to start your own gulp plugin.
This plugin is thought for easy debug logging.
Features:
```javascript
var smartDebug = require("smartdebug");
* TypeScript: Code your plugin in TypeScript
* Use gulp to compile TypeScript without the global gulp CLI Tool.
* Use travis to deploy to npm
* Have a master branch for the latest dev version
* Have a release branch for the latest npm version
This package **doesn't require global gulp** (just local -> simply do npm install`) to compile TypeScript.
* to compile TypeScript do `npm test` (You should chain your own tests to this command later on)
* to setup release do `npm run setup`
* to release a patch do `npm run release`
We recommend using travis for npm releasing and test integration.
#### The structure
```
gulp-bootstrap/
|
|- ts/
| |- compile/
| | |- compile.js **** contains gulp task`
| |- index.ts **** Your main TypeScript file.
|
|- index.js **** the compiled module
smartDebug.log("This message is not shown");
smartDebug.activate(true);
smartDebug.log("This debug message is shown");
```

7
test.js
View File

@ -1,4 +1,7 @@
/// <reference path="typings/tsd.d.ts" />
var smartDebug = require("./index.js");
smartDebug.log("test");
var bl = require("beautylog")("os");
smartDebug.log("This message is not shown");
smartDebug.activate(true);
smartDebug.log("test2");
smartDebug.log("This debug message is shown");
bl.success("Test successfull");

8
ts/test.ts
View File

@ -1,5 +1,9 @@
/// <reference path="typings/tsd.d.ts" />
var smartDebug = require("./index.js");
var bl = require("beautylog")("os");
smartDebug.log("test");
smartDebug.log("This message is not shown");
smartDebug.activate(true);
smartDebug.log("test2");
smartDebug.log("This debug message is shown");
bl.success("Test successfull");