Skip to content
This repository has been archived by the owner on May 4, 2024. It is now read-only.

Bump standardjs #110

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ Usage
=====

```javascript
var TrackerGroup = require("are-we-there-yet").TrackerGroup
const TrackerGroup = require("are-we-there-yet").TrackerGroup

var top = new TrackerGroup("program")
const top = new TrackerGroup("program")

var single = top.newItem("one thing", 100)
const single = top.newItem("one thing", 100)
single.completeWork(20)

console.log(top.completed()) // 0.2

fs.stat("file", function(er, stat) {
if (er) throw er
var stream = top.newStream("file", stat.size)
if (er) throw er
const stream = top.newStream("file", stat.size)
console.log(top.completed()) // now 0.1 as single is 50% of the job and is 20% complete
// and 50% * 20% == 10%
fs.createReadStream("file").pipe(stream).on("data", function (chunk) {
Expand Down Expand Up @@ -79,7 +79,7 @@ or if it didn't have one, the first containing tracker group that had one.
TrackerGroup
============

* var tracker = new TrackerGroup(**name**)
* const tracker = new TrackerGroup(**name**)

* **name** *(optional)* - The name of this tracker group, used in change
notifications if the component updating didn't have a name. Defaults to undefined.
Expand All @@ -101,28 +101,28 @@ completion of this tracker and the second will account for the other 67%.

Returns **otherTracker**.

* var subGroup = tracker.newGroup(**name**, **weight**)
* const subGroup = tracker.newGroup(**name**, **weight**)

The above is exactly equivalent to:

```javascript
var subGroup = tracker.addUnit(new TrackerGroup(name), weight)
const subGroup = tracker.addUnit(new TrackerGroup(name), weight)
```

* var subItem = tracker.newItem(**name**, **todo**, **weight**)

The above is exactly equivalent to:

```javascript
var subItem = tracker.addUnit(new Tracker(name, todo), weight)
const subItem = tracker.addUnit(new Tracker(name, todo), weight)
```

* var subStream = tracker.newStream(**name**, **todo**, **weight**)

The above is exactly equivalent to:

```javascript
var subStream = tracker.addUnit(new TrackerStream(name, todo), weight)
const subStream = tracker.addUnit(new TrackerStream(name, todo), weight)
```

* console.log( tracker.debug() )
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
},
"homepage": "https://github.com/iarna/are-we-there-yet",
"devDependencies": {
"standard": "^11.0.1",
"standard": "^16.0.3",
"tap": "^12.0.1"
},
"dependencies": {
Expand Down
10 changes: 5 additions & 5 deletions test/lib/test-event.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
'use strict'
var util = require('util')
const util = require('util')

module.exports = function (obj, event, next) {
var timeout = setTimeout(gotTimeout, 10)
let timeout = setTimeout(gotTimeout, 10)
obj.once(event, gotResult)

function gotTimeout () {
obj.removeListener(event, gotResult)
next(new Error('Timeout listening for ' + event))
}
var result = []
let result = []
function gotResult () {
result = Array.prototype.slice.call(arguments)
clearTimeout(timeout)
Expand All @@ -18,11 +18,11 @@ module.exports = function (obj, event, next) {
}
function gotNoMoreResults () {
obj.removeListener(event, gotTooManyResults)
var args = [null].concat(result)
const args = [null].concat(result)
next.apply(null, args)
}
function gotTooManyResults () {
var secondResult = Array.prototype.slice.call(arguments)
const secondResult = Array.prototype.slice.call(arguments)
clearTimeout(timeout)
next(new Error('Got too many results, first ' + util.inspect(result) + ' and then ' + util.inspect(secondResult)))
}
Expand Down
16 changes: 8 additions & 8 deletions test/tracker.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
'use strict'
var test = require('tap').test
var Tracker = require('../index.js').Tracker
const test = require('tap').test
const Tracker = require('../index.js').Tracker

var testEvent = require('./lib/test-event.js')
const testEvent = require('./lib/test-event.js')

var name = 'test'
const name = 'test'

test('initialization', function (t) {
var simple = new Tracker(name)
const simple = new Tracker(name)

t.is(simple.completed(), 0, 'Nothing todo is 0 completion')
t.done()
})

var track
var todo = 100
let track
const todo = 100
test('completion', function (t) {
track = new Tracker(name, todo)
t.is(track.completed(), 0, 'Nothing done is 0 completion')
Expand Down Expand Up @@ -49,7 +49,7 @@ test('complete more work', function (t) {
})

test('finish is always 100%', function (t) {
var finishtest = new Tracker(name, todo)
const finishtest = new Tracker(name, todo)
finishtest.completeWork(50)
finishtest.finish()
t.is(finishtest.completed(), 1, 'finish: Explicitly finishing moves to 100%')
Expand Down
21 changes: 10 additions & 11 deletions test/trackergroup.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
'use strict'
var test = require('tap').test
var TrackerGroup = require('../index.js').TrackerGroup
var testEvent = require('./lib/test-event.js')
const test = require('tap').test
const TrackerGroup = require('../index.js').TrackerGroup
const testEvent = require('./lib/test-event.js')

test('TrackerGroup', function (t) {
var name = 'test'
const name = 'test'

var track = new TrackerGroup(name)
let track = new TrackerGroup(name)
t.is(track.completed(), 0, 'Nothing todo is 0 completion')
testEvent(track, 'change', afterFinishEmpty)
track.finish()
var a, b
let a, b
function afterFinishEmpty (er, onChangeName, completion) {
t.is(er, null, 'finishEmpty: on change event fired')
t.is(onChangeName, name, 'finishEmpty: on change emits the correct name')
Expand Down Expand Up @@ -62,7 +62,7 @@ test('TrackerGroup', function (t) {
track = new TrackerGroup(name)
a = track.newGroup('a', 10)
b = track.newGroup('b', 10)
var a1 = a.newItem('a.1', 10)
const a1 = a.newItem('a.1', 10)
a1.completeWork(5)
t.is(track.completed(), 0.25, 'nested: Initially quarter done')
testEvent(track, 'change', afterNestedComplete)
Expand All @@ -78,16 +78,15 @@ test('TrackerGroup', function (t) {
})

test('cycles', function (t) {
var track = new TrackerGroup('top')
const track = new TrackerGroup('top')
testCycle(track, track)
var layer1 = track.newGroup('layer1')
const layer1 = track.newGroup('layer1')
testCycle(layer1, track)
t.end()

function testCycle (addTo, toAdd) {
try {
addTo.addUnit(toAdd)
t.fail(toAdd.name)
} catch (ex) {
console.log(ex)
t.pass(toAdd.name)
Expand All @@ -96,7 +95,7 @@ test('cycles', function (t) {
})

test('should properly handle finish calls when the group contains a stream', function (t) {
var track = new TrackerGroup('test')
const track = new TrackerGroup('test')
track.newStream('test-stream', 100)
try {
track.finish()
Expand Down
18 changes: 9 additions & 9 deletions test/trackerstream.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
'use strict'
var test = require('tap').test
var util = require('util')
var stream = require('readable-stream')
var TrackerStream = require('../index.js').TrackerStream
var testEvent = require('./lib/test-event.js')
const test = require('tap').test
const util = require('util')
const stream = require('readable-stream')
const TrackerStream = require('../index.js').TrackerStream
const testEvent = require('./lib/test-event.js')

var Sink = function () {
const Sink = function () {
stream.Writable.apply(this, arguments)
}
util.inherits(Sink, stream.Writable)
Expand All @@ -16,12 +16,12 @@ Sink.prototype._write = function (data, encoding, cb) {
test('TrackerStream', function (t) {
t.plan(9)

var name = 'test'
var track = new TrackerStream(name)
const name = 'test'
let track = new TrackerStream(name)

t.is(track.completed(), 0, 'Nothing todo is 0 completion')

var todo = 10
const todo = 10
track = new TrackerStream(name, todo)
t.is(track.completed(), 0, 'Nothing done is 0 completion')

Expand Down
8 changes: 4 additions & 4 deletions tracker-base.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
'use strict'
var EventEmitter = require('events').EventEmitter
var util = require('util')
const EventEmitter = require('events').EventEmitter
const util = require('util')

var trackerId = 0
var TrackerBase = module.exports = function (name) {
let trackerId = 0
const TrackerBase = module.exports = function (name) {
EventEmitter.call(this)
this.id = ++trackerId
this.name = name
Expand Down
34 changes: 17 additions & 17 deletions tracker-group.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
'use strict'
var util = require('util')
var TrackerBase = require('./tracker-base.js')
var Tracker = require('./tracker.js')
var TrackerStream = require('./tracker-stream.js')
const util = require('util')
const TrackerBase = require('./tracker-base.js')
const Tracker = require('./tracker.js')
const TrackerStream = require('./tracker-stream.js')

var TrackerGroup = module.exports = function (name) {
const TrackerGroup = module.exports = function (name) {
TrackerBase.call(this, name)
this.parentGroup = null
this.trackers = []
Expand All @@ -25,8 +25,8 @@ function bubbleChange (trackerGroup) {
}

TrackerGroup.prototype.nameInTree = function () {
var names = []
var from = this
const names = []
let from = this
while (from) {
names.unshift(from.name)
from = from.parentGroup
Expand All @@ -36,7 +36,7 @@ TrackerGroup.prototype.nameInTree = function () {

TrackerGroup.prototype.addUnit = function (unit, weight) {
if (unit.addUnit) {
var toTest = this
let toTest = this
while (toTest) {
if (unit === toTest) {
throw new Error(
Expand All @@ -59,10 +59,10 @@ TrackerGroup.prototype.addUnit = function (unit, weight) {

TrackerGroup.prototype.completed = function () {
if (this.trackers.length === 0) return 0
var valPerWeight = 1 / this.totalWeight
var completed = 0
for (var ii = 0; ii < this.trackers.length; ii++) {
var trackerId = this.trackers[ii].id
const valPerWeight = 1 / this.totalWeight
let completed = 0
for (let ii = 0; ii < this.trackers.length; ii++) {
const trackerId = this.trackers[ii].id
completed += valPerWeight * this.weight[trackerId] * this.completion[trackerId]
}
return completed
Expand All @@ -83,19 +83,19 @@ TrackerGroup.prototype.newStream = function (name, todo, weight) {
TrackerGroup.prototype.finish = function () {
this.finished = true
if (!this.trackers.length) this.addUnit(new Tracker(), 1, true)
for (var ii = 0; ii < this.trackers.length; ii++) {
var tracker = this.trackers[ii]
for (let ii = 0; ii < this.trackers.length; ii++) {
const tracker = this.trackers[ii]
tracker.finish()
tracker.removeListener('change', this.bubbleChange)
}
this.emit('change', this.name, 1, this)
}

var buffer = ' '
const buffer = ' '
TrackerGroup.prototype.debug = function (depth) {
depth = depth || 0
var indent = depth ? buffer.substr(0, depth) : ''
var output = indent + (this.name || 'top') + ': ' + this.completed() + '\n'
const indent = depth ? buffer.substr(0, depth) : ''
let output = indent + (this.name || 'top') + ': ' + this.completed() + '\n'
this.trackers.forEach(function (tracker) {
if (tracker instanceof TrackerGroup) {
output += tracker.debug(depth + 1)
Expand Down
10 changes: 5 additions & 5 deletions tracker-stream.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
'use strict'
var util = require('util')
var stream = require('readable-stream')
var delegate = require('delegates')
var Tracker = require('./tracker.js')
const util = require('util')
const stream = require('readable-stream')
const delegate = require('delegates')
const Tracker = require('./tracker.js')

var TrackerStream = module.exports = function (name, size, options) {
const TrackerStream = module.exports = function (name, size, options) {
stream.Transform.call(this, options)
this.tracker = new Tracker(name, size)
this.name = name
Expand Down
6 changes: 3 additions & 3 deletions tracker.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
'use strict'
var util = require('util')
var TrackerBase = require('./tracker-base.js')
const util = require('util')
const TrackerBase = require('./tracker-base.js')

var Tracker = module.exports = function (name, todo) {
const Tracker = module.exports = function (name, todo) {
TrackerBase.call(this, name)
this.workDone = 0
this.workTodo = todo || 0
Expand Down