/
index.test.js
397 lines (360 loc) · 11.6 KB
/
index.test.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/* eslint-env jest */
import execa from 'execa'
import fs from 'fs-extra'
import os from 'os'
import path from 'path'
const cli = require.resolve('create-next-app/dist/index.js')
const exampleRepo = 'https://github.com/vercel/next.js/tree/canary'
const examplePath = 'examples/basic-css'
const run = (args, options) => execa('node', [cli].concat(args), options)
async function usingTempDir(fn, options) {
const folder = path.join(os.tmpdir(), Math.random().toString(36).substring(2))
await fs.mkdirp(folder, options)
try {
await fn(folder)
} finally {
await fs.remove(folder)
}
}
describe('create next app', () => {
it('non-empty directory', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'non-empty-directory'
await fs.mkdirp(path.join(cwd, projectName))
const pkg = path.join(cwd, projectName, 'package.json')
fs.writeFileSync(pkg, '{ "foo": "bar" }')
const res = await run([projectName], { cwd, reject: false })
expect(res.exitCode).toBe(1)
expect(res.stdout).toMatch(/contains files that could conflict/)
})
})
// TODO: investigate why this test stalls on yarn install when
// stdin is piped instead of inherited on windows
if (process.platform !== 'win32') {
it('empty directory', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'empty-directory'
const res = await run([projectName], { cwd })
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.js'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, '.eslintrc.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
})
})
}
it('invalid example name', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'invalid-example-name'
const res = await run([projectName, '--example', 'not a real example'], {
cwd,
reject: false,
})
expect(res.exitCode).toBe(1)
expect(res.stderr).toMatch(/Could not locate an example named/i)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeFalsy()
})
})
it('valid example', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'valid-example'
const res = await run([projectName, '--example', 'basic-css'], { cwd })
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.js'))
).toBeTruthy()
// check we copied default `.gitignore`
expect(
fs.existsSync(path.join(cwd, projectName, '.gitignore'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
})
})
it('should support typescript flag', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'typescript'
const res = await run([projectName, '--typescript'], { cwd })
expect(res.exitCode).toBe(0)
const pkgJSONPath = path.join(cwd, projectName, 'package.json')
expect(fs.existsSync(pkgJSONPath)).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.tsx'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/_app.tsx'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/api/hello.ts'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'tsconfig.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'next-env.d.ts'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, '.eslintrc.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
// check we copied default `.gitignore`
expect(
fs.existsSync(path.join(cwd, projectName, '.gitignore'))
).toBeTruthy()
// Assert for dependencies specific to the typescript template
const pkgJSON = require(pkgJSONPath)
expect(Object.keys(pkgJSON.dependencies)).toEqual([
'next',
'react',
'react-dom',
])
expect(Object.keys(pkgJSON.devDependencies)).toEqual([
'@types/node',
'@types/react',
'eslint',
'eslint-config-next',
'typescript',
])
})
})
it('should allow example with GitHub URL', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'github-app'
const res = await run(
[projectName, '--example', `${exampleRepo}/${examplePath}`],
{
cwd,
}
)
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.js'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, '.gitignore'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
})
})
it('should allow example with GitHub URL and example-path', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'github-example-path'
const res = await run(
[projectName, '--example', exampleRepo, '--example-path', examplePath],
{
cwd,
}
)
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.js'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, '.gitignore'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
})
})
it('should use --example-path over the file path in the GitHub URL', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'github-example-path-2'
const res = await run(
[
projectName,
'--example',
`${exampleRepo}/${examplePath}`,
'--example-path',
examplePath,
],
{
cwd,
}
)
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.js'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, '.gitignore'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
})
})
// TODO: investigate why this test stalls on yarn install when
// stdin is piped instead of inherited on windows
if (process.platform !== 'win32') {
it('should fall back to default template', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'fail-example'
const res = await run(
[projectName, '--example', '__internal-testing-retry'],
{
cwd,
input: '\n',
}
)
expect(res.exitCode).toBe(0)
const files = [
'package.json',
'pages/index.js',
'.gitignore',
'.eslintrc.json',
]
files.forEach((file) =>
expect(fs.existsSync(path.join(cwd, projectName, file))).toBeTruthy()
)
})
})
}
it('should allow an example named default', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'default-example'
const res = await run([projectName, '--example', 'default'], { cwd })
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'pages/index.js'))
).toBeTruthy()
// check we copied default `.gitignore`
expect(
fs.existsSync(path.join(cwd, projectName, '.gitignore'))
).toBeTruthy()
expect(
fs.existsSync(path.join(cwd, projectName, 'node_modules/next'))
).toBe(true)
})
})
it('should exit if example flag is empty', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'no-example-provided'
const res = await run([projectName, '--example'], { cwd, reject: false })
expect(res.exitCode).toBe(1)
})
})
it('should exit if the folder is not writable', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'not-writable'
const res = await run([projectName], { cwd, reject: false })
if (process.platform === 'win32') {
expect(res.exitCode).toBe(0)
expect(
fs.existsSync(path.join(cwd, projectName, 'package.json'))
).toBeTruthy()
return
}
expect(res.exitCode).toBe(1)
expect(res.stderr).toMatch(
/you do not have write permissions for this folder/
)
}, 0o500)
})
it('should create a project in the current directory', async () => {
await usingTempDir(async (cwd) => {
const res = await run(['.'], { cwd })
expect(res.exitCode).toBe(0)
const files = [
'package.json',
'pages/index.js',
'.gitignore',
'node_modules/next',
'.eslintrc.json',
]
files.forEach((file) =>
expect(fs.existsSync(path.join(cwd, file))).toBeTruthy()
)
})
})
it('should ask the user for a name for the project if none supplied', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'test-project'
const res = await run([], { cwd, input: `${projectName}\n` })
expect(res.exitCode).toBe(0)
const files = [
'package.json',
'pages/index.js',
'.gitignore',
'node_modules/next',
'.eslintrc.json',
]
files.forEach((file) =>
expect(fs.existsSync(path.join(cwd, projectName, file))).toBeTruthy()
)
})
})
it('should use npm as the package manager on supplying --use-npm', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'use-npm'
const res = await run([projectName, '--use-npm'], { cwd })
expect(res.exitCode).toBe(0)
const files = [
'package.json',
'pages/index.js',
'.gitignore',
'.eslintrc.json',
'package-lock.json',
'node_modules/next',
]
files.forEach((file) =>
expect(fs.existsSync(path.join(cwd, projectName, file))).toBeTruthy()
)
})
})
it('should use npm as the package manager on supplying --use-npm with example', async () => {
await usingTempDir(async (cwd) => {
const projectName = 'use-npm'
const res = await run(
[
projectName,
'--use-npm',
'--example',
`${exampleRepo}/${examplePath}`,
],
{ cwd }
)
expect(res.exitCode).toBe(0)
const files = [
'package.json',
'pages/index.js',
'.gitignore',
'package-lock.json',
'node_modules/next',
]
files.forEach((file) =>
expect(fs.existsSync(path.join(cwd, projectName, file))).toBeTruthy()
)
})
})
})