example: lint the JS files (#63)

* add standard linter to example project

* lint bin/convert script

* lint more js files, run linter pretest

packages/example/bin/convert.js

@@ -1,42 +1,40 @@
 #!/usr/bin/env node
 
-var fs   = require("fs")
-var path = require("path")
-var glob = require("glob")
+var fs = require('fs')
+var path = require('path')
+var glob = require('glob')
 
-replaceStringsIn = function(file){
-  fs.readFile(file, "utf8", function(err, str){
+function replaceStringsIn (file) {
+  fs.readFile(file, 'utf8', function (err, str) {
     if (err) throw err
 
-    var replace = function(source, dest){
+    var replace = function (source, dest) {
       str = str.split(source).join(dest)
     }
 
-
-    replace("http://localhost:8080",    "https://example.cypress.io")
-    replace("to.eq('localhost:8080')",  "to.eq('example.cypress.io')")
-    replace("to.eq('localhost')",       "to.eq('example.cypress.io')")
-    replace("to.eq('8080')",            "to.eq('')")
-    replace("to.eq('http:')",           "to.eq('https:')")
+    replace('http://localhost:8080', 'https://example.cypress.io')
+    replace("to.eq('localhost:8080')", "to.eq('example.cypress.io')")
+    replace("to.eq('localhost')", "to.eq('example.cypress.io')")
+    replace("to.eq('8080')", "to.eq('')")
+    replace("to.eq('http:')", "to.eq('https:')")
     replace("imgSrcToDataURL('/assets", "imgSrcToDataURL('https://example.cypress.io/assets")
 
-    fs.writeFile(file, str, function(err){
+    fs.writeFile(file, str, function (err) {
       if (err) throw err
 
-      console.log("Converted " + path.relative(process.cwd(), file) + " successfully.")
+      console.log('Converted ' + path.relative(process.cwd(), file) + ' successfully.')
     })
   })
 }
 
-glob("./app/**/*.html", {realpath: true}, function(err, files){
+glob('./app/**/*.html', {realpath: true}, function (err, files) {
   if (err) throw err
 
-  var spec = path.join(process.cwd(), "cypress", "integration", "example_spec.js")
+  var spec = path.join(process.cwd(), 'cypress', 'integration', 'example_spec.js')
 
   files.push(spec)
 
-  files.forEach(function(file){
+  files.forEach(function (file) {
     return replaceStringsIn(file)
   })
-
-})
+})

packages/example/gulpfile.js

@@ -1,10 +1,10 @@
-var gulp        = require('gulp');
-var ghPages     = require('gulp-gh-pages');
-var clean       = require('gulp-clean');
-var RevAll      = require('gulp-rev-all');
+var gulp = require('gulp')
+var ghPages = require('gulp-gh-pages')
+var clean = require('gulp-clean')
+var RevAll = require('gulp-rev-all')
 var runSequence = require('run-sequence')
 
-gulp.task('assets', function(){
+gulp.task('assets', function () {
   var revAll = new RevAll({
     dontGlobal: ['.ico', 'fira.css', 'javascript-logo.png'],
     dontRenameFile: ['.ico', '.html', /fonts/],
@@ -12,35 +12,35 @@ gulp.task('assets', function(){
     debug: false
   })
 
-  return gulp.src("./app/**/*")
+  return gulp.src('./app/**/*')
     .pipe(revAll.revision())
-    .pipe(gulp.dest("build"))
+    .pipe(gulp.dest('build'))
 })
 
-gulp.task('cname', function(){
+gulp.task('cname', function () {
   return gulp.src('CNAME')
-    .pipe(gulp.dest('build'));
-});
+    .pipe(gulp.dest('build'))
+})
 
-gulp.task('gitignore', function(){
+gulp.task('gitignore', function () {
   return gulp.src('.gitignore')
     .pipe(gulp.dest('build'))
 })
 
-gulp.task('clean', function(){
-  return gulp.src("./build")
+gulp.task('clean', function () {
+  return gulp.src('./build')
     .pipe(clean())
 })
 
-gulp.task('push-gh-pages', function(){
+gulp.task('push-gh-pages', function () {
   return gulp.src('build/**/*')
-    .pipe(ghPages());
+    .pipe(ghPages())
 })
 
-gulp.task('build', function(cb){
+gulp.task('build', function (cb) {
   return runSequence('clean', ['assets', 'cname', 'gitignore'], cb)
-});
+})
 
-gulp.task('deploy', function(cb){
+gulp.task('deploy', function (cb) {
   return runSequence('build', 'push-gh-pages', cb)
 })

packages/example/index.js

@@ -1 +1 @@
-module.exports = require("./lib/example")
+module.exports = require('./lib/example')

packages/example/lib/example.js

@@ -1,7 +1,7 @@
-var path = require("path")
+var path = require('path')
 
 module.exports = {
-  getPathToExample: function(){
-    return path.join(__dirname, "..", "cypress", "integration", "example_spec.js")
+  getPathToExample: function () {
+    return path.join(__dirname, '..', 'cypress', 'integration', 'example_spec.js')
   }
-}
+}

packages/example/package.json

@@ -12,7 +12,9 @@
     "predeploy": "npm run build",
     "deploy": "gulp deploy",
     "prerelease": "npm run build",
-    "release": "releaser"
+    "release": "releaser",
+    "lint": "standard --verbose --fix *.js bin/*.js lib/*.js test/*.js",
+    "pretest": "npm run lint"
   },
   "author": "Brian Mann",
   "license": "MIT",
@@ -21,14 +23,15 @@
     "glob": "^7.0.3"
   },
   "devDependencies": {
-    "chai": "^3.5.0",
     "@cypress/releaser": "0.1.12",
+    "chai": "^3.5.0",
     "gulp": "^3.9.1",
     "gulp-clean": "^0.3.1",
     "gulp-gh-pages": "^0.5.4",
     "gulp-rev-all": "^0.8.22",
     "mocha": "^2.4.5",
-    "run-sequence": "^1.1.5"
+    "run-sequence": "^1.1.5",
+    "standard": "^10.0.2"
   },
   "repository": {
     "type": "git",

packages/example/test/example_spec.js

@@ -1,10 +1,11 @@
-var example = require("../index")
-var expect = require("chai").expect
+var example = require('../index')
+var expect = require('chai').expect
 
 var cwd = process.cwd()
 
-describe("Cypress Example", function(){
-  it("returns path to example_spec", function(){
-    expect(example.getPathToExample()).to.eq(cwd + "/cypress/integration/example_spec.js")
+/* global describe, it */
+describe('Cypress Example', function () {
+  it('returns path to example_spec', function () {
+    expect(example.getPathToExample()).to.eq(cwd + '/cypress/integration/example_spec.js')
   })
 })