forked from npmx-dev/npmx.dev
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpackage-analysis.spec.ts
More file actions
455 lines (392 loc) · 12.4 KB
/
package-analysis.spec.ts
File metadata and controls
455 lines (392 loc) · 12.4 KB
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
import { describe, expect, it } from 'vitest'
import {
analyzePackage,
detectModuleFormat,
detectTypesStatus,
getCreatePackageName,
getCreateShortName,
getTypesPackageName,
hasBuiltInTypes,
} from '#shared/utils/package-analysis'
describe('detectModuleFormat', () => {
it('detects ESM from type: module', () => {
expect(detectModuleFormat({ type: 'module', main: 'index.js' })).toBe('esm')
})
it('detects CJS from type: commonjs', () => {
expect(detectModuleFormat({ type: 'commonjs', main: 'index.js' })).toBe('cjs')
})
it('detects CJS when no type field (default)', () => {
expect(detectModuleFormat({ main: 'index.js' })).toBe('cjs')
})
it('detects dual from module + main fields', () => {
expect(detectModuleFormat({ module: 'index.mjs', main: 'index.js' })).toBe('dual')
})
it('detects dual from type + module + main fields', () => {
expect(detectModuleFormat({ type: 'module', module: 'index.js', main: 'index.cjs' })).toBe(
'dual',
)
})
it('detects esm from type + module + main fields', () => {
expect(detectModuleFormat({ type: 'module', module: 'index.js', main: 'index.js' })).toBe('esm')
})
it('detects ESM from module field without main', () => {
expect(detectModuleFormat({ module: 'index.mjs' })).toBe('esm')
})
it('detects dual from exports with import + require conditions', () => {
expect(
detectModuleFormat({
exports: {
'.': {
import: './index.mjs',
require: './index.cjs',
},
},
}),
).toBe('dual')
})
it('detects ESM from exports with only import condition', () => {
expect(
detectModuleFormat({
type: 'module',
exports: {
'.': {
import: './index.js',
},
},
}),
).toBe('esm')
})
it('detects CJS from exports with only require condition', () => {
expect(
detectModuleFormat({
exports: {
'.': {
require: './index.cjs',
},
},
}),
).toBe('cjs')
})
it('detects dual from nested exports with both conditions', () => {
expect(
detectModuleFormat({
exports: {
'.': {
import: {
types: './dist/index.d.mts',
default: './dist/index.mjs',
},
require: {
types: './dist/index.d.ts',
default: './dist/index.cjs',
},
},
},
}),
).toBe('dual')
})
it('returns cjs for empty package (npm default)', () => {
// npm treats packages without type field as CommonJS
expect(detectModuleFormat({})).toBe('cjs')
})
it('detect dual from JSON exports', () => {
expect(
detectModuleFormat({
main: 'test.json',
exports: {
'.': './test.json',
},
}),
).toBe('dual')
})
it('detect esm from JSON exports', () => {
expect(
detectModuleFormat({
exports: {
'.': './test.json',
},
}),
).toBe('esm')
})
it('detects WASM from main field', () => {
expect(detectModuleFormat({ main: 'main.wasm' })).toBe('wasm')
})
})
describe('detectTypesStatus', () => {
it('detects included types from types field', () => {
expect(detectTypesStatus({ types: './index.d.ts' })).toEqual({ kind: 'included' })
})
it('detects included types from typings field', () => {
expect(detectTypesStatus({ typings: './index.d.ts' })).toEqual({ kind: 'included' })
})
it('detects included types from exports with types condition', () => {
expect(
detectTypesStatus({
exports: {
'.': {
types: './index.d.ts',
default: './index.js',
},
},
}),
).toEqual({ kind: 'included' })
})
it('detects @types package when provided', () => {
expect(detectTypesStatus({}, { packageName: '@types/lodash' })).toEqual({
kind: '@types',
packageName: '@types/lodash',
})
})
it('includes deprecation info in @types detection', () => {
expect(
detectTypesStatus({}, { packageName: '@types/lodash', deprecated: 'Now included in lodash' }),
).toEqual({
kind: '@types',
packageName: '@types/lodash',
deprecated: 'Now included in lodash',
})
})
it('returns none when no types detected', () => {
expect(detectTypesStatus({})).toEqual({ kind: 'none' })
})
it('detects included types when matching declaration file exists for entry point', () => {
expect(
detectTypesStatus(
{ type: 'module', exports: { '.': './dist/index.mjs' } },
undefined,
new Set(['dist/index.mjs', 'dist/index.d.mts']),
),
).toEqual({ kind: 'included' })
})
it('does not detect types from unrelated .d.ts files in the package', () => {
expect(
detectTypesStatus(
{ type: 'module', exports: { '.': './dist/index.mjs' } },
undefined,
new Set(['dist/index.mjs', 'env.d.ts', 'shims-vue.d.ts']),
),
).toEqual({ kind: 'none' })
})
})
describe('detectTypesStatus implicit types from entry points', () => {
it('finds .d.mts matching .mjs export entry point', () => {
expect(
detectTypesStatus(
{ type: 'module', exports: { '.': './dist/index.mjs' } },
undefined,
new Set(['dist/index.d.mts']),
),
).toEqual({ kind: 'included' })
})
it('finds .d.cts matching .cjs export entry point', () => {
expect(
detectTypesStatus(
{ exports: { '.': { require: './dist/index.cjs' } } },
undefined,
new Set(['dist/index.d.cts']),
),
).toEqual({ kind: 'included' })
})
it('finds .d.ts matching .js export entry point', () => {
expect(
detectTypesStatus(
{ exports: { '.': './dist/index.js' } },
undefined,
new Set(['dist/index.d.ts']),
),
).toEqual({ kind: 'included' })
})
it('finds .d.mts matching .mjs main entry point', () => {
expect(
detectTypesStatus(
{ type: 'module', main: 'dist/index.mjs' },
undefined,
new Set(['dist/index.d.mts']),
),
).toEqual({ kind: 'included' })
})
it('finds .d.ts matching .js module entry point', () => {
expect(
detectTypesStatus({ module: './dist/index.js' }, undefined, new Set(['dist/index.d.ts'])),
).toEqual({ kind: 'included' })
})
it('returns none when no declaration file matches any entry point', () => {
expect(
detectTypesStatus(
{ type: 'module', exports: { '.': './dist/index.mjs' } },
undefined,
new Set(['dist/other.d.mts', 'types/env.d.ts']),
),
).toEqual({ kind: 'none' })
})
})
describe('analyzePackage with files (implicit types)', () => {
it('detects included types when matching declaration file exists for entry point', () => {
const pkg = { type: 'module' as const, exports: { '.': './dist/index.mjs' } }
const files = new Set(['dist/index.mjs', 'dist/index.d.mts'])
const result = analyzePackage(pkg, { files })
expect(result.types).toEqual({ kind: 'included' })
})
it('returns none when no declaration file matches entry point', () => {
const pkg = { type: 'module' as const, exports: { '.': './dist/index.mjs' } }
const files = new Set(['dist/index.mjs'])
const result = analyzePackage(pkg, { files })
expect(result.types).toEqual({ kind: 'none' })
})
it('returns none when only unrelated .d.ts files exist', () => {
const pkg = { type: 'module' as const, exports: { '.': './dist/index.mjs' } }
const files = new Set(['dist/index.mjs', 'env.d.ts'])
const result = analyzePackage(pkg, { files })
expect(result.types).toEqual({ kind: 'none' })
})
})
describe('getTypesPackageName', () => {
it('handles unscoped package', () => {
expect(getTypesPackageName('lodash')).toBe('@types/lodash')
})
it('handles scoped package', () => {
expect(getTypesPackageName('@nuxt/kit')).toBe('@types/nuxt__kit')
})
})
describe('hasBuiltInTypes', () => {
it('returns true when types field is present', () => {
expect(hasBuiltInTypes({ types: './index.d.ts' })).toBe(true)
})
it('returns true when typings field is present', () => {
expect(hasBuiltInTypes({ typings: './index.d.ts' })).toBe(true)
})
it('returns true when exports has types condition', () => {
expect(
hasBuiltInTypes({
exports: {
'.': {
types: './index.d.ts',
default: './index.js',
},
},
}),
).toBe(true)
})
it('returns false when no types are present', () => {
expect(hasBuiltInTypes({ main: 'index.js' })).toBe(false)
})
it('returns false for empty package', () => {
expect(hasBuiltInTypes({})).toBe(false)
})
})
describe('analyzePackage', () => {
it('analyzes Vue package correctly', () => {
const result = analyzePackage({
name: 'vue',
type: undefined,
main: 'index.js',
module: 'dist/vue.runtime.esm-bundler.js',
types: 'dist/vue.d.ts',
exports: {
'.': {
import: './dist/vue.runtime.esm-bundler.js',
require: './index.js',
},
},
})
expect(result.moduleFormat).toBe('dual')
expect(result.types).toEqual({ kind: 'included' })
})
it('analyzes ESM-only package correctly', () => {
const result = analyzePackage({
name: 'execa',
type: 'module',
exports: {
types: './index.d.ts',
default: './index.js',
},
})
expect(result.moduleFormat).toBe('esm')
expect(result.types).toEqual({ kind: 'included' })
})
it('includes engines when present', () => {
const result = analyzePackage({
name: 'test',
main: 'index.js',
engines: {
bun: '>=1.0.0',
node: '>=18',
npm: '>=9',
},
})
expect(result.engines).toEqual({
bun: '>=1.0.0',
node: '>=18',
npm: '>=9',
})
})
it('detects @types package when typesPackage info is provided', () => {
const result = analyzePackage(
{ name: 'express', main: 'index.js' },
{ typesPackage: { packageName: '@types/express' } },
)
expect(result.types).toEqual({ kind: '@types', packageName: '@types/express' })
})
it('includes deprecation info for @types package', () => {
const result = analyzePackage(
{ name: 'express', main: 'index.js' },
{ typesPackage: { packageName: '@types/express', deprecated: 'Use included types instead' } },
)
expect(result.types).toEqual({
kind: '@types',
packageName: '@types/express',
deprecated: 'Use included types instead',
})
})
it('includes createPackage when provided', () => {
const result = analyzePackage(
{ name: 'vite', main: 'index.js' },
{ createPackage: { packageName: 'create-vite' } },
)
expect(result.createPackage).toEqual({ packageName: 'create-vite' })
})
it('includes deprecation info for createPackage', () => {
const result = analyzePackage(
{ name: 'foo', main: 'index.js' },
{ createPackage: { packageName: 'create-foo', deprecated: 'Use different tool' } },
)
expect(result.createPackage).toEqual({
packageName: 'create-foo',
deprecated: 'Use different tool',
})
})
})
describe('getCreatePackageName', () => {
it('handles unscoped package', () => {
expect(getCreatePackageName('vite')).toBe('create-vite')
})
it('handles scoped package', () => {
expect(getCreatePackageName('@nuxt/app')).toBe('@nuxt/create-app')
})
it('handles single-word package', () => {
expect(getCreatePackageName('next')).toBe('create-next')
})
it('handles hyphenated package', () => {
expect(getCreatePackageName('solid-js')).toBe('create-solid-js')
})
})
describe('getCreateShortName', () => {
it('extracts name from unscoped create-* package', () => {
expect(getCreateShortName('create-vite')).toBe('vite')
})
it('extracts name from scoped create-* package preserving scope', () => {
expect(getCreateShortName('@vue/create-app')).toBe('@vue/app')
})
it('returns full name if not a create-* package', () => {
expect(getCreateShortName('vite')).toBe('vite')
})
it('returns full name for scoped package without create- prefix', () => {
expect(getCreateShortName('@scope/foo')).toBe('@scope/foo')
})
it('extracts name from create-next-app style packages', () => {
expect(getCreateShortName('create-next-app')).toBe('next-app')
})
it('returns scope only for @scope/create packages', () => {
expect(getCreateShortName('@angular/create')).toBe('@angular')
})
})