/
watcher.js
194 lines (175 loc) · 5.89 KB
/
watcher.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/* eslint-env node, mocha */
const { writeFile, rename } = require('fs/promises')
const assert = require('assert')
const path = require('path')
const { rm } = require('../lib/helpers')
const Metalsmith = require('..')
const fixture = path.resolve.bind(path, __dirname, 'fixtures')
const { platform } = require('os')
const initialFiles = ['change', 'dir/file', 'remove'].map(path.normalize)
const defaultWatchOpts = {
alwaysStat: false,
awaitWriteFinish: false,
cwd: fixture('watch'),
ignoreInitial: true,
ignored: [],
paths: fixture('watch/src')
}
describe('watcher', function () {
let initialBuild = true
this.timeout(5000)
this.beforeEach(() => {
initialBuild = true
})
this.afterEach(async () => {
return Metalsmith(fixture('watch')).source('contents').destination('src').clean(true).build()
})
it('should set proper default options according to metalsmith config', function () {
const ms = Metalsmith(fixture('watch'))
ms.watch(true)
assert.deepStrictEqual(ms.watch(), defaultWatchOpts)
})
it("should take into account metalsmith.ignore'd paths", function () {
const ms = Metalsmith(fixture('watch'))
ms.ignore('ignored')
ms.watch(true)
assert.deepStrictEqual(ms.watch(), { ...defaultWatchOpts, ignored: ['ignored'] })
})
it('should detect added files', async function () {
const addFile = async () => await writeFile(path.join(fixture('watch/src'), 'added'), '')
const ms = Metalsmith(fixture('watch'))
return new Promise((resolve, reject) => {
ms.watch(true).build((err, files) => {
if (err) reject(err)
else {
if (initialBuild) {
initialBuild = false
addFile()
// this will only trigger if the if clause succeeds in triggering the chokidar watcher
} else {
ms.watch(false)
try {
assert.deepStrictEqual(Object.keys(files), [...initialFiles, 'added'])
resolve()
} catch (err) {
reject(err)
}
}
}
})
})
})
it('should detect removed files', async function () {
const remove = async () => await rm(path.join(fixture('watch/src'), 'remove'))
const ms = Metalsmith(fixture('watch'))
return new Promise((resolve, reject) => {
ms.watch(true).build((err, files) => {
if (err) reject(err)
else {
if (initialBuild) {
initialBuild = false
remove()
// this will only trigger if the if clause succeeds in triggering the chokidar watcher
} else {
ms.watch(false)
try {
assert.deepStrictEqual(Object.keys(files), initialFiles.slice(0, 2))
resolve()
} catch (err) {
reject(err)
}
}
}
})
})
})
it('should detect changed files', async function () {
const change = async () => await writeFile(path.join(fixture('watch/src'), 'change'), 'body')
const ms = Metalsmith(fixture('watch'))
return new Promise((resolve, reject) => {
ms.watch(true).build((err, files) => {
if (err) reject(err)
else {
if (initialBuild) {
initialBuild = false
change()
// this will only trigger if the if clause succeeds in triggering the chokidar watcher
} else {
ms.watch(false)
try {
assert.strictEqual(files['change'].contents.toString(), 'body')
resolve()
} catch (err) {
reject(err)
}
}
}
})
})
})
it('should detect moved files', async function () {
const change = async () =>
await rename(path.join(fixture('watch/src'), 'change'), path.join(fixture('watch/src'), 'renamed'))
const ms = Metalsmith(fixture('watch'))
initialBuild = 0
return new Promise((resolve, reject) => {
ms.watch(true).build((err, files) => {
if (err) reject(err)
else {
initialBuild += 1
if (initialBuild === 1) {
change()
// this will only trigger if the if clause succeeds in triggering the chokidar watcher
} else {
if (initialBuild === 3) {
ms.watch(false)
try {
assert.deepStrictEqual(Object.keys(files), initialFiles.slice(1).concat(['renamed']))
resolve()
} catch (err) {
reject(err)
}
}
}
}
})
})
})
it('should graciously batch file ops', async function () {
const batch = async () => {
rename(path.join(fixture('watch/src'), 'change'), path.join(fixture('watch/src'), 'renamed'))
writeFile(path.join(fixture('watch/src'), 'added'), 'body')
rm(path.join(fixture('watch/src'), 'remove'))
}
const ms = Metalsmith(fixture('watch'))
// windows file watchers are apparently slower, triggering an extra run
const lastBuild = platform() === 'win32' ? 4 : 3
initialBuild = 0
return new Promise((resolve, reject) => {
ms.watch(true).build(async (err, files) => {
if (err) reject(err)
else {
initialBuild += 1
if (initialBuild === 1) {
await batch()
// this will only trigger if the if clause succeeds in triggering the chokidar watcher
} else {
if (initialBuild === lastBuild) {
ms.watch(false)
try {
// doing the sort here because the order of execution of the batch is not guaranteed
assert.deepStrictEqual(
Object.keys(files).sort(),
initialFiles.slice(1, 2).concat(['added', 'renamed']).sort()
)
resolve()
} catch (err) {
reject(err)
}
}
}
}
})
})
})
})