Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
schickling committed Jul 5, 2014
1 parent e15c42a commit 725d9b6
Show file tree
Hide file tree
Showing 6 changed files with 101 additions and 3 deletions.
10 changes: 10 additions & 0 deletions .editorconfig
@@ -0,0 +1,10 @@
root = true

[*]
indent_style = space
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true

[*.js]
indent_size = 2
3 changes: 3 additions & 0 deletions .gitignore
@@ -0,0 +1,3 @@
.DS_Store
node_modules/

51 changes: 51 additions & 0 deletions .jshintrc
@@ -0,0 +1,51 @@
{
/*
* ENVIRONMENTS
* =================
*/

// Define globals exposed by Node.js.
"node": true,

/*
* ENFORCING OPTIONS
* =================
*/

// Force all variable names to use either camelCase style or UPPER_CASE
// with underscores.
"camelcase": true,

// Prohibit use of == and != in favor of === and !==.
"eqeqeq": true,

// Suppress warnings about == null comparisons.
"eqnull": true,

// Enforce tab width of 2 spaces.
"indent": 2,

// Prohibit use of a variable before it is defined.
"latedef": true,

// Require capitalized names for constructor functions.
"newcap": true,

// Enforce use of single quotation marks for strings.
"quotmark": "single",

// Prohibit trailing whitespace.
"trailing": true,

// Prohibit use of explicitly undeclared variables.
"undef": true,

// Warn when variables are defined but never used.
"unused": true,

// Enforce line length to 80 characters
"maxlen": 80,

// Enforce placing 'use strict' at the top function scope
"strict": true
}
23 changes: 22 additions & 1 deletion README.md
@@ -1,4 +1,25 @@
gulp-webserver
==============

Gulp plugin to run a local webserver with livereload
Streaming gulp plugin to run a local webserver with LiveReload

## Install

```sh
$ npm install --save-dev gulp-webserver
```

## Usage

```js
var gulp = require('gulp');
var webserver = require('gulp-webserver');

gulp.task('webserver', function() {
gulp.src('app')
.pipe(webserver({
port: 8000,
livereload: true
}));
});
```
8 changes: 6 additions & 2 deletions package.json
Expand Up @@ -2,7 +2,7 @@
"name": "gulp-webserver",
"version": "0.0.0",
"description": "Gulp plugin to run a local webserver with LiveReload",
"main": "index.js",
"main": "src/index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
Expand All @@ -21,5 +21,9 @@
"bugs": {
"url": "https://github.com/schickling/gulp-webserver/issues"
},
"homepage": "https://github.com/schickling/gulp-webserver"
"homepage": "https://github.com/schickling/gulp-webserver",
"devDependencies": {
"gulp-util": "^2.2.19",
"through2": "^0.5.1"
}
}
9 changes: 9 additions & 0 deletions src/index.js
@@ -0,0 +1,9 @@
var through = require('through2');
var gutil = require('gulp-util');
var PluginError = gutil.PluginError;

var PLUGIN_NAME = 'gulp-webserver';

function gulpWebserver(options) {}

module.exports = gulpWebserver;

0 comments on commit 725d9b6

Please sign in to comment.