-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
package_json.go
1273 lines (1118 loc) · 40.8 KB
/
package_json.go
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package resolver
import (
"fmt"
"net/url"
"path"
"regexp"
"sort"
"strings"
"github.com/evanw/esbuild/internal/config"
"github.com/evanw/esbuild/internal/helpers"
"github.com/evanw/esbuild/internal/js_ast"
"github.com/evanw/esbuild/internal/js_lexer"
"github.com/evanw/esbuild/internal/js_parser"
"github.com/evanw/esbuild/internal/logger"
)
type packageJSON struct {
mainFields map[string]mainField
moduleTypeData js_ast.ModuleTypeData
// Present if the "browser" field is present. This field is intended to be
// used by bundlers and lets you redirect the paths of certain 3rd-party
// modules that don't work in the browser to other modules that shim that
// functionality. That way you don't have to rewrite the code for those 3rd-
// party modules. For example, you might remap the native "util" node module
// to something like https://www.npmjs.com/package/util so it works in the
// browser.
//
// This field contains the original mapping object in "package.json". Mapping
// to a nil path indicates that the module is disabled. As far as I can
// tell, the official spec is an abandoned GitHub repo hosted by a user account:
// https://github.com/defunctzombie/package-browser-field-spec. The npm docs
// say almost nothing: https://docs.npmjs.com/files/package.json.
//
// Note that the non-package "browser" map has to be checked twice to match
// Webpack's behavior: once before resolution and once after resolution. It
// leads to some unintuitive failure cases that we must emulate around missing
// file extensions:
//
// * Given the mapping "./no-ext": "./no-ext-browser.js" the query "./no-ext"
// should match but the query "./no-ext.js" should NOT match.
//
// * Given the mapping "./ext.js": "./ext-browser.js" the query "./ext.js"
// should match and the query "./ext" should ALSO match.
//
browserMap map[string]*string
// If this is non-nil, each entry in this map is the absolute path of a file
// with side effects. Any entry not in this map should be considered to have
// no side effects, which means import statements for these files can be
// removed if none of the imports are used. This is a convention from Webpack:
// https://webpack.js.org/guides/tree-shaking/.
//
// Note that if a file is included, all statements that can't be proven to be
// free of side effects must be included. This convention does not say
// anything about whether any statements within the file have side effects or
// not.
sideEffectsMap map[string]bool
sideEffectsRegexps []*regexp.Regexp
sideEffectsData *SideEffectsData
// This represents the "imports" field in this package.json file.
importsMap *pjMap
// This represents the "exports" field in this package.json file.
exportsMap *pjMap
source logger.Source
}
type mainField struct {
relPath string
keyLoc logger.Loc
}
type browserPathKind uint8
const (
absolutePathKind browserPathKind = iota
packagePathKind
)
func (r resolverQuery) checkBrowserMap(resolveDirInfo *dirInfo, inputPath string, kind browserPathKind) (remapped *string, ok bool) {
// This only applies if the current platform is "browser"
if r.options.Platform != config.PlatformBrowser {
return nil, false
}
// There must be an enclosing directory with a "package.json" file with a "browser" map
if resolveDirInfo.enclosingBrowserScope == nil {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("No \"browser\" map found in directory %q", resolveDirInfo.absPath))
}
return nil, false
}
packageJSON := resolveDirInfo.enclosingBrowserScope.packageJSON
browserMap := packageJSON.browserMap
type implicitExtensions uint8
const (
includeImplicitExtensions implicitExtensions = iota
skipImplicitExtensions
)
checkPath := func(pathToCheck string, implicitExtensions implicitExtensions) bool {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Checking for %q in the \"browser\" map in %q",
pathToCheck, packageJSON.source.KeyPath.Text))
}
// Check for equality
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf(" Checking for %q", pathToCheck))
}
remapped, ok = browserMap[pathToCheck]
if ok {
inputPath = pathToCheck
return true
}
// If that failed, try adding implicit extensions
if implicitExtensions == includeImplicitExtensions {
for _, ext := range r.options.ExtensionOrder {
extPath := pathToCheck + ext
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf(" Checking for %q", extPath))
}
remapped, ok = browserMap[extPath]
if ok {
inputPath = extPath
return true
}
}
}
// If that failed, try assuming this is a directory and looking for an "index" file
indexPath := path.Join(pathToCheck, "index")
if IsPackagePath(indexPath) && !IsPackagePath(pathToCheck) {
indexPath = "./" + indexPath
}
// Check for equality
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf(" Checking for %q", indexPath))
}
remapped, ok = browserMap[indexPath]
if ok {
inputPath = indexPath
return true
}
// If that failed, try adding implicit extensions
if implicitExtensions == includeImplicitExtensions {
for _, ext := range r.options.ExtensionOrder {
extPath := indexPath + ext
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf(" Checking for %q", extPath))
}
remapped, ok = browserMap[extPath]
if ok {
inputPath = extPath
return true
}
}
}
return false
}
// Turn absolute paths into paths relative to the "browser" map location
if kind == absolutePathKind {
relPath, ok := r.fs.Rel(resolveDirInfo.enclosingBrowserScope.absPath, inputPath)
if !ok {
return nil, false
}
inputPath = strings.ReplaceAll(relPath, "\\", "/")
}
if inputPath == "." {
// No bundler supports remapping ".", so we don't either
return nil, false
}
// First try the import path as a package path
if !checkPath(inputPath, includeImplicitExtensions) && IsPackagePath(inputPath) {
// If a package path didn't work, try the import path as a relative path
switch kind {
case absolutePathKind:
checkPath("./"+inputPath, includeImplicitExtensions)
case packagePathKind:
// Browserify allows a browser map entry of "./pkg" to override a package
// path of "require('pkg')". This is weird, and arguably a bug. But we
// replicate this bug for compatibility. However, Browserify only allows
// this within the same package. It does not allow such an entry in a
// parent package to override this in a child package. So this behavior
// is disallowed if there is a "node_modules" folder in between the child
// package and the parent package.
isInSamePackage := true
for info := resolveDirInfo; info != nil && info != resolveDirInfo.enclosingBrowserScope; info = info.parent {
if info.isNodeModules {
isInSamePackage = false
break
}
}
if isInSamePackage {
relativePathPrefix := "./"
// Use the relative path from the file containing the import path to the
// enclosing package.json file. This includes any subdirectories within the
// package if there are any.
if relPath, ok := r.fs.Rel(resolveDirInfo.enclosingBrowserScope.absPath, resolveDirInfo.absPath); ok && relPath != "." {
relativePathPrefix += strings.ReplaceAll(relPath, "\\", "/") + "/"
}
// Browserify lets "require('pkg')" match "./pkg" but not "./pkg.js".
// So don't add implicit extensions specifically in this place so we
// match Browserify's behavior.
checkPath(relativePathPrefix+inputPath, skipImplicitExtensions)
}
}
}
if r.debugLogs != nil {
if ok {
if remapped == nil {
r.debugLogs.addNote(fmt.Sprintf("Found %q marked as disabled", inputPath))
} else {
r.debugLogs.addNote(fmt.Sprintf("Found %q mapping to %q", inputPath, *remapped))
}
} else {
r.debugLogs.addNote(fmt.Sprintf("Failed to find %q", inputPath))
}
}
return
}
func (r resolverQuery) parsePackageJSON(inputPath string) *packageJSON {
packageJSONPath := r.fs.Join(inputPath, "package.json")
contents, err, originalError := r.caches.FSCache.ReadFile(r.fs, packageJSONPath)
if r.debugLogs != nil && originalError != nil {
r.debugLogs.addNote(fmt.Sprintf("Failed to read file %q: %s", packageJSONPath, originalError.Error()))
}
if err != nil {
r.log.AddError(nil, logger.Range{},
fmt.Sprintf("Cannot read file %q: %s",
r.PrettyPath(logger.Path{Text: packageJSONPath, Namespace: "file"}), err.Error()))
return nil
}
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The file %q exists", packageJSONPath))
}
keyPath := logger.Path{Text: packageJSONPath, Namespace: "file"}
jsonSource := logger.Source{
KeyPath: keyPath,
PrettyPath: r.PrettyPath(keyPath),
Contents: contents,
}
tracker := logger.MakeLineColumnTracker(&jsonSource)
json, ok := r.caches.JSONCache.Parse(r.log, jsonSource, js_parser.JSONOptions{})
if !ok {
return nil
}
packageJSON := &packageJSON{
source: jsonSource,
mainFields: make(map[string]mainField),
}
// Read the "type" field
if typeJSON, typeKeyLoc, ok := getProperty(json, "type"); ok {
if typeValue, ok := getString(typeJSON); ok {
switch typeValue {
case "commonjs":
packageJSON.moduleTypeData = js_ast.ModuleTypeData{
Type: js_ast.ModuleCommonJS_PackageJSON,
Source: &packageJSON.source,
Range: jsonSource.RangeOfString(typeJSON.Loc),
}
case "module":
packageJSON.moduleTypeData = js_ast.ModuleTypeData{
Type: js_ast.ModuleESM_PackageJSON,
Source: &packageJSON.source,
Range: jsonSource.RangeOfString(typeJSON.Loc),
}
default:
notes := []logger.MsgData{{Text: "The \"type\" field must be set to either \"commonjs\" or \"module\"."}}
kind := logger.Warning
// If someone does something like "type": "./index.d.ts" then they
// likely meant "types" instead of "type". Customize the message
// for this and hide it if it's inside a published npm package.
if strings.HasSuffix(typeValue, ".d.ts") {
notes[0] = tracker.MsgData(jsonSource.RangeOfString(typeKeyLoc),
"TypeScript type declarations use the \"types\" field, not the \"type\" field:")
notes[0].Location.Suggestion = "\"types\""
if helpers.IsInsideNodeModules(jsonSource.KeyPath.Text) {
kind = logger.Debug
}
}
r.log.AddIDWithNotes(logger.MsgID_PackageJSON_InvalidType, kind, &tracker, jsonSource.RangeOfString(typeJSON.Loc),
fmt.Sprintf("%q is not a valid value for the \"type\" field", typeValue),
notes)
}
} else {
r.log.AddID(logger.MsgID_PackageJSON_InvalidType, logger.Warning, &tracker, logger.Range{Loc: typeJSON.Loc},
"The value for \"type\" must be a string")
}
}
// Read the "main" fields
mainFields := r.options.MainFields
if mainFields == nil {
mainFields = defaultMainFields[r.options.Platform]
}
for _, field := range mainFields {
if mainJSON, mainLoc, ok := getProperty(json, field); ok {
if main, ok := getString(mainJSON); ok && main != "" {
packageJSON.mainFields[field] = mainField{keyLoc: mainLoc, relPath: main}
}
}
}
for _, field := range mainFieldsForFailure {
if _, ok := packageJSON.mainFields[field]; !ok {
if mainJSON, mainLoc, ok := getProperty(json, field); ok {
if main, ok := getString(mainJSON); ok && main != "" {
packageJSON.mainFields[field] = mainField{keyLoc: mainLoc, relPath: main}
}
}
}
}
// Read the "browser" property, but only when targeting the browser
if browserJSON, _, ok := getProperty(json, "browser"); ok && r.options.Platform == config.PlatformBrowser {
// We both want the ability to have the option of CJS vs. ESM and the
// option of having node vs. browser. The way to do this is to use the
// object literal form of the "browser" field like this:
//
// "main": "dist/index.node.cjs.js",
// "module": "dist/index.node.esm.js",
// "browser": {
// "./dist/index.node.cjs.js": "./dist/index.browser.cjs.js",
// "./dist/index.node.esm.js": "./dist/index.browser.esm.js"
// },
//
if browser, ok := browserJSON.Data.(*js_ast.EObject); ok {
// The value is an object
browserMap := make(map[string]*string)
// Remap all files in the browser field
for _, prop := range browser.Properties {
if key, ok := getString(prop.Key); ok && prop.ValueOrNil.Data != nil {
if value, ok := getString(prop.ValueOrNil); ok {
// If this is a string, it's a replacement package
browserMap[key] = &value
} else if value, ok := getBool(prop.ValueOrNil); ok {
// If this is false, it means the package is disabled
if !value {
browserMap[key] = nil
}
} else {
r.log.AddID(logger.MsgID_PackageJSON_InvalidBrowser, logger.Warning, &tracker, logger.Range{Loc: prop.ValueOrNil.Loc},
"Each \"browser\" mapping must be a string or a boolean")
}
}
}
packageJSON.browserMap = browserMap
}
}
// Read the "sideEffects" property
if sideEffectsJSON, sideEffectsLoc, ok := getProperty(json, "sideEffects"); ok {
switch data := sideEffectsJSON.Data.(type) {
case *js_ast.EBoolean:
if !data.Value {
// Make an empty map for "sideEffects: false", which indicates all
// files in this module can be considered to not have side effects.
packageJSON.sideEffectsMap = make(map[string]bool)
packageJSON.sideEffectsData = &SideEffectsData{
IsSideEffectsArrayInJSON: false,
Source: &jsonSource,
Range: jsonSource.RangeOfString(sideEffectsLoc),
}
}
case *js_ast.EArray:
// The "sideEffects: []" format means all files in this module but not in
// the array can be considered to not have side effects.
packageJSON.sideEffectsMap = make(map[string]bool)
packageJSON.sideEffectsData = &SideEffectsData{
IsSideEffectsArrayInJSON: true,
Source: &jsonSource,
Range: jsonSource.RangeOfString(sideEffectsLoc),
}
for _, itemJSON := range data.Items {
item, ok := itemJSON.Data.(*js_ast.EString)
if !ok || item.Value == nil {
r.log.AddID(logger.MsgID_PackageJSON_InvalidSideEffects, logger.Warning, &tracker, logger.Range{Loc: itemJSON.Loc},
"Expected string in array for \"sideEffects\"")
continue
}
// Reference: https://github.com/webpack/webpack/blob/ed175cd22f89eb9fecd0a70572a3fd0be028e77c/lib/optimize/SideEffectsFlagPlugin.js
pattern := helpers.UTF16ToString(item.Value)
if !strings.ContainsRune(pattern, '/') {
pattern = "**/" + pattern
}
absPattern := r.fs.Join(inputPath, pattern)
re, hadWildcard := globstarToEscapedRegexp(absPattern)
// Wildcard patterns require more expensive matching
if hadWildcard {
packageJSON.sideEffectsRegexps = append(packageJSON.sideEffectsRegexps, regexp.MustCompile(re))
continue
}
// Normal strings can be matched with a map lookup
packageJSON.sideEffectsMap[absPattern] = true
}
default:
r.log.AddID(logger.MsgID_PackageJSON_InvalidSideEffects, logger.Warning, &tracker, logger.Range{Loc: sideEffectsJSON.Loc},
"The value for \"sideEffects\" must be a boolean or an array")
}
}
// Read the "imports" map
if importsJSON, _, ok := getProperty(json, "imports"); ok {
if importsMap := parseImportsExportsMap(jsonSource, r.log, importsJSON); importsMap != nil {
if importsMap.root.kind != pjObject {
r.log.AddID(logger.MsgID_PackageJSON_InvalidImportsOrExports, logger.Warning, &tracker, importsMap.root.firstToken,
"The value for \"imports\" must be an object")
}
packageJSON.importsMap = importsMap
}
}
// Read the "exports" map
if exportsJSON, _, ok := getProperty(json, "exports"); ok {
if exportsMap := parseImportsExportsMap(jsonSource, r.log, exportsJSON); exportsMap != nil {
packageJSON.exportsMap = exportsMap
}
}
return packageJSON
}
// Reference: https://github.com/fitzgen/glob-to-regexp/blob/2abf65a834259c6504ed3b80e85f893f8cd99127/index.js
func globstarToEscapedRegexp(glob string) (string, bool) {
sb := strings.Builder{}
sb.WriteByte('^')
hadWildcard := false
n := len(glob)
for i := 0; i < n; i++ {
c := glob[i]
switch c {
case '\\', '^', '$', '.', '+', '|', '(', ')', '[', ']', '{', '}':
sb.WriteByte('\\')
sb.WriteByte(c)
case '?':
sb.WriteByte('.')
hadWildcard = true
case '*':
// Move over all consecutive "*"'s.
// Also store the previous and next characters
prevChar := -1
if i > 0 {
prevChar = int(glob[i-1])
}
starCount := 1
for i+1 < n && glob[i+1] == '*' {
starCount++
i++
}
nextChar := -1
if i+1 < n {
nextChar = int(glob[i+1])
}
// Determine if this is a globstar segment
isGlobstar := starCount > 1 && // multiple "*"'s
(prevChar == '/' || prevChar == -1) && // from the start of the segment
(nextChar == '/' || nextChar == -1) // to the end of the segment
if isGlobstar {
// It's a globstar, so match zero or more path segments
sb.WriteString("(?:[^/]*(?:/|$))*")
i++ // Move over the "/"
} else {
// It's not a globstar, so only match one path segment
sb.WriteString("[^/]*")
}
hadWildcard = true
default:
sb.WriteByte(c)
}
}
sb.WriteByte('$')
return sb.String(), hadWildcard
}
// Reference: https://nodejs.org/api/esm.html#esm_resolver_algorithm_specification
type pjMap struct {
root pjEntry
}
type pjKind uint8
const (
pjNull pjKind = iota
pjString
pjArray
pjObject
pjInvalid
)
type pjEntry struct {
strData string
arrData []pjEntry
mapData []pjMapEntry // Can't be a "map" because order matters
expansionKeys expansionKeysArray
firstToken logger.Range
kind pjKind
}
type pjMapEntry struct {
key string
value pjEntry
keyRange logger.Range
}
// This type is just so we can use Go's native sort function
type expansionKeysArray []pjMapEntry
func (a expansionKeysArray) Len() int { return len(a) }
func (a expansionKeysArray) Swap(i int, j int) { a[i], a[j] = a[j], a[i] }
func (a expansionKeysArray) Less(i int, j int) bool {
return len(a[i].key) > len(a[j].key)
}
func (entry pjEntry) valueForKey(key string) (pjEntry, bool) {
for _, item := range entry.mapData {
if item.key == key {
return item.value, true
}
}
return pjEntry{}, false
}
func parseImportsExportsMap(source logger.Source, log logger.Log, json js_ast.Expr) *pjMap {
var visit func(expr js_ast.Expr) pjEntry
tracker := logger.MakeLineColumnTracker(&source)
visit = func(expr js_ast.Expr) pjEntry {
var firstToken logger.Range
switch e := expr.Data.(type) {
case *js_ast.ENull:
return pjEntry{
kind: pjNull,
firstToken: js_lexer.RangeOfIdentifier(source, expr.Loc),
}
case *js_ast.EString:
return pjEntry{
kind: pjString,
firstToken: source.RangeOfString(expr.Loc),
strData: helpers.UTF16ToString(e.Value),
}
case *js_ast.EArray:
arrData := make([]pjEntry, len(e.Items))
for i, item := range e.Items {
arrData[i] = visit(item)
}
return pjEntry{
kind: pjArray,
firstToken: logger.Range{Loc: expr.Loc, Len: 1},
arrData: arrData,
}
case *js_ast.EObject:
mapData := make([]pjMapEntry, len(e.Properties))
expansionKeys := make(expansionKeysArray, 0, len(e.Properties))
firstToken := logger.Range{Loc: expr.Loc, Len: 1}
isConditionalSugar := false
for i, property := range e.Properties {
keyStr, _ := property.Key.Data.(*js_ast.EString)
key := helpers.UTF16ToString(keyStr.Value)
keyRange := source.RangeOfString(property.Key.Loc)
// If exports is an Object with both a key starting with "." and a key
// not starting with ".", throw an Invalid Package Configuration error.
curIsConditionalSugar := !strings.HasPrefix(key, ".")
if i == 0 {
isConditionalSugar = curIsConditionalSugar
} else if isConditionalSugar != curIsConditionalSugar {
prevEntry := mapData[i-1]
log.AddIDWithNotes(logger.MsgID_PackageJSON_InvalidImportsOrExports, logger.Warning, &tracker, keyRange,
"This object cannot contain keys that both start with \".\" and don't start with \".\"",
[]logger.MsgData{tracker.MsgData(prevEntry.keyRange,
fmt.Sprintf("The key %q is incompatible with the previous key %q:", key, prevEntry.key))})
return pjEntry{
kind: pjInvalid,
firstToken: firstToken,
}
}
entry := pjMapEntry{
key: key,
keyRange: keyRange,
value: visit(property.ValueOrNil),
}
if strings.HasSuffix(key, "/") || strings.HasSuffix(key, "*") {
expansionKeys = append(expansionKeys, entry)
}
mapData[i] = entry
}
// Let expansionKeys be the list of keys of matchObj ending in "/" or "*",
// sorted by length descending.
sort.Stable(expansionKeys)
return pjEntry{
kind: pjObject,
firstToken: firstToken,
mapData: mapData,
expansionKeys: expansionKeys,
}
case *js_ast.EBoolean:
firstToken = js_lexer.RangeOfIdentifier(source, expr.Loc)
case *js_ast.ENumber:
firstToken = source.RangeOfNumber(expr.Loc)
default:
firstToken.Loc = expr.Loc
}
log.AddID(logger.MsgID_PackageJSON_InvalidImportsOrExports, logger.Warning, &tracker, firstToken,
"This value must be a string, an object, an array, or null")
return pjEntry{
kind: pjInvalid,
firstToken: firstToken,
}
}
root := visit(json)
if root.kind == pjNull {
return nil
}
return &pjMap{root: root}
}
func (entry pjEntry) keysStartWithDot() bool {
return len(entry.mapData) > 0 && strings.HasPrefix(entry.mapData[0].key, ".")
}
type pjStatus uint8
const (
pjStatusUndefined pjStatus = iota
pjStatusUndefinedNoConditionsMatch // A more friendly error message for when no conditions are matched
pjStatusNull
pjStatusExact
pjStatusInexact // This means we may need to try CommonJS-style extension suffixes
pjStatusPackageResolve // Need to re-run package resolution on the result
// Module specifier is an invalid URL, package name or package subpath specifier.
pjStatusInvalidModuleSpecifier
// package.json configuration is invalid or contains an invalid configuration.
pjStatusInvalidPackageConfiguration
// Package exports or imports define a target module for the package that is an invalid type or string target.
pjStatusInvalidPackageTarget
// Package exports do not define or permit a target subpath in the package for the given module.
pjStatusPackagePathNotExported
// Package imports do not define the specifiespecifier
pjStatusPackageImportNotDefined
// The package or module requested does not exist.
pjStatusModuleNotFound
// The resolved path corresponds to a directory, which is not a supported target for module imports.
pjStatusUnsupportedDirectoryImport
)
func (status pjStatus) isUndefined() bool {
return status == pjStatusUndefined || status == pjStatusUndefinedNoConditionsMatch
}
type pjDebug struct {
// If the status is "pjStatusUndefinedNoConditionsMatch", this is the set of
// conditions that didn't match, in the order that they were found in the file.
// This information is used for error messages.
unmatchedConditions []logger.Span
// This is the range of the token to use for error messages
token logger.Range
}
func (r resolverQuery) esmHandlePostConditions(
resolved string,
status pjStatus,
debug pjDebug,
) (string, pjStatus, pjDebug) {
if status != pjStatusExact && status != pjStatusInexact {
return resolved, status, debug
}
// If resolved contains any percent encodings of "/" or "\" ("%2f" and "%5C"
// respectively), then throw an Invalid Module Specifier error.
resolvedPath, err := url.PathUnescape(resolved)
if err != nil {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The path %q contains invalid URL escapes: %s", resolved, err.Error()))
}
return resolved, pjStatusInvalidModuleSpecifier, debug
}
var found string
if strings.Contains(resolved, "%2f") {
found = "%2f"
} else if strings.Contains(resolved, "%2F") {
found = "%2F"
} else if strings.Contains(resolved, "%5c") {
found = "%5c"
} else if strings.Contains(resolved, "%5C") {
found = "%5C"
}
if found != "" {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The path %q is not allowed to contain %q", resolved, found))
}
return resolved, pjStatusInvalidModuleSpecifier, debug
}
// If the file at resolved is a directory, then throw an Unsupported Directory
// Import error.
if strings.HasSuffix(resolvedPath, "/") || strings.HasSuffix(resolvedPath, "\\") {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The path %q is not allowed to end with a slash", resolved))
}
return resolved, pjStatusUnsupportedDirectoryImport, debug
}
// Set resolved to the real path of resolved.
return resolvedPath, status, debug
}
func (r resolverQuery) esmPackageImportsResolve(
specifier string,
imports pjEntry,
conditions map[string]bool,
) (string, pjStatus, pjDebug) {
// ALGORITHM DEVIATION: Provide a friendly error message if "imports" is not an object
if imports.kind != pjObject {
return "", pjStatusInvalidPackageConfiguration, pjDebug{token: imports.firstToken}
}
resolved, status, debug := r.esmPackageImportsExportsResolve(specifier, imports, "/", true, conditions)
if status != pjStatusNull && status != pjStatusUndefined {
return resolved, status, debug
}
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The package import %q is not defined", specifier))
}
return specifier, pjStatusPackageImportNotDefined, pjDebug{token: imports.firstToken}
}
func (r resolverQuery) esmPackageExportsResolve(
packageURL string,
subpath string,
exports pjEntry,
conditions map[string]bool,
) (string, pjStatus, pjDebug) {
if exports.kind == pjInvalid {
if r.debugLogs != nil {
r.debugLogs.addNote("Invalid package configuration")
}
return "", pjStatusInvalidPackageConfiguration, pjDebug{token: exports.firstToken}
}
if subpath == "." {
mainExport := pjEntry{kind: pjNull}
if exports.kind == pjString || exports.kind == pjArray || (exports.kind == pjObject && !exports.keysStartWithDot()) {
mainExport = exports
} else if exports.kind == pjObject {
if dot, ok := exports.valueForKey("."); ok {
if r.debugLogs != nil {
r.debugLogs.addNote("Using the entry for \".\"")
}
mainExport = dot
}
}
if mainExport.kind != pjNull {
resolved, status, debug := r.esmPackageTargetResolve(packageURL, mainExport, "", false, false, conditions)
if status != pjStatusNull && status != pjStatusUndefined {
return resolved, status, debug
}
}
} else if exports.kind == pjObject && exports.keysStartWithDot() {
resolved, status, debug := r.esmPackageImportsExportsResolve(subpath, exports, packageURL, false, conditions)
if status != pjStatusNull && status != pjStatusUndefined {
return resolved, status, debug
}
}
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The path %q is not exported", subpath))
}
return "", pjStatusPackagePathNotExported, pjDebug{token: exports.firstToken}
}
func (r resolverQuery) esmPackageImportsExportsResolve(
matchKey string,
matchObj pjEntry,
packageURL string,
isImports bool,
conditions map[string]bool,
) (string, pjStatus, pjDebug) {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Checking object path map for %q", matchKey))
}
if !strings.HasSuffix(matchKey, "*") {
if target, ok := matchObj.valueForKey(matchKey); ok {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Found exact match for %q", matchKey))
}
return r.esmPackageTargetResolve(packageURL, target, "", false, isImports, conditions)
}
}
for _, expansion := range matchObj.expansionKeys {
// If expansionKey ends in "*" and matchKey starts with but is not equal to
// the substring of expansionKey excluding the last "*" character
if strings.HasSuffix(expansion.key, "*") {
if substr := expansion.key[:len(expansion.key)-1]; strings.HasPrefix(matchKey, substr) && matchKey != substr {
target := expansion.value
subpath := matchKey[len(expansion.key)-1:]
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The key %q matched with %q left over", expansion.key, subpath))
}
return r.esmPackageTargetResolve(packageURL, target, subpath, true, isImports, conditions)
}
}
if strings.HasPrefix(matchKey, expansion.key) {
target := expansion.value
subpath := matchKey[len(expansion.key):]
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The key %q matched with %q left over", expansion.key, subpath))
}
result, status, debug := r.esmPackageTargetResolve(packageURL, target, subpath, false, isImports, conditions)
if status == pjStatusExact {
// Return the object { resolved, exact: false }.
status = pjStatusInexact
}
return result, status, debug
}
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The key %q did not match", expansion.key))
}
}
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("No keys matched %q", matchKey))
}
return "", pjStatusNull, pjDebug{token: matchObj.firstToken}
}
// If path split on "/" or "\" contains any ".", ".." or "node_modules"
// segments after the first segment, throw an Invalid Package Target error.
func findInvalidSegment(path string) string {
slash := strings.IndexAny(path, "/\\")
if slash == -1 {
return ""
}
path = path[slash+1:]
for path != "" {
slash := strings.IndexAny(path, "/\\")
segment := path
if slash != -1 {
segment = path[:slash]
path = path[slash+1:]
} else {
path = ""
}
if segment == "." || segment == ".." || segment == "node_modules" {
return segment
}
}
return ""
}
func (r resolverQuery) esmPackageTargetResolve(
packageURL string,
target pjEntry,
subpath string,
pattern bool,
internal bool,
conditions map[string]bool,
) (string, pjStatus, pjDebug) {
switch target.kind {
case pjString:
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Checking path %q against target %q", subpath, target.strData))
r.debugLogs.increaseIndent()
defer r.debugLogs.decreaseIndent()
}
// If pattern is false, subpath has non-zero length and target
// does not end with "/", throw an Invalid Module Specifier error.
if !pattern && subpath != "" && !strings.HasSuffix(target.strData, "/") {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The target %q is invalid because it doesn't end \"/\"", target.strData))
}
return target.strData, pjStatusInvalidModuleSpecifier, pjDebug{token: target.firstToken}
}
// If target does not start with "./", then...
if !strings.HasPrefix(target.strData, "./") {
if internal && !strings.HasPrefix(target.strData, "../") && !strings.HasPrefix(target.strData, "/") {
if pattern {
result := strings.ReplaceAll(target.strData, "*", subpath)
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Substituted %q for \"*\" in %q to get %q", subpath, target.strData, result))
}
return result, pjStatusPackageResolve, pjDebug{token: target.firstToken}
}
result := target.strData + subpath
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Joined %q to %q to get %q", target.strData, subpath, result))
}
return result, pjStatusPackageResolve, pjDebug{token: target.firstToken}
}
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The target %q is invalid because it doesn't start with \"./\"", target.strData))
}
return target.strData, pjStatusInvalidPackageTarget, pjDebug{token: target.firstToken}
}
// If target split on "/" or "\" contains any ".", ".." or "node_modules"
// segments after the first segment, throw an Invalid Package Target error.
if invalidSegment := findInvalidSegment(target.strData); invalidSegment != "" {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The target %q is invalid because it contains invalid segment %q", target.strData, invalidSegment))
}
return target.strData, pjStatusInvalidPackageTarget, pjDebug{token: target.firstToken}
}
// Let resolvedTarget be the URL resolution of the concatenation of packageURL and target.
resolvedTarget := path.Join(packageURL, target.strData)
// If subpath split on "/" or "\" contains any ".", ".." or "node_modules"
// segments, throw an Invalid Module Specifier error.
if invalidSegment := findInvalidSegment(subpath); invalidSegment != "" {
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("The path %q is invalid because it contains invalid segment %q", subpath, invalidSegment))
}
return subpath, pjStatusInvalidModuleSpecifier, pjDebug{token: target.firstToken}
}
if pattern {
// Return the URL resolution of resolvedTarget with every instance of "*" replaced with subpath.
result := strings.ReplaceAll(resolvedTarget, "*", subpath)
if r.debugLogs != nil {
r.debugLogs.addNote(fmt.Sprintf("Substituted %q for \"*\" in %q to get %q", subpath, "."+resolvedTarget, "."+result))
}
return result, pjStatusExact, pjDebug{token: target.firstToken}
} else {
// Return the URL resolution of the concatenation of subpath and resolvedTarget.
result := path.Join(resolvedTarget, subpath)
if r.debugLogs != nil {