@teambit/readme 0.0.249 → 0.0.250

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/artifacts/env-template/public/{679.9b8b0be987fdbbd3de71.js → 679.5a8fcc5aa9164df607e1.js} +0 -0
  2. package/artifacts/env-template/public/{419.9e2c64360aa460b8a327.js → 884.f1506b7b1ccf813dbde7.js} +2 -2
  3. package/artifacts/env-template/public/assets-manifest.json +12 -12
  4. package/artifacts/env-template/public/{compositions.6349973520b18f616d89.js → compositions.7558befd4b80c3a8216e.js} +1 -1
  5. package/artifacts/env-template/public/compositions.html +1 -1
  6. package/artifacts/env-template/public/overview.7d3c7c4dd2ec27147360.js +5 -0
  7. package/artifacts/env-template/public/overview.html +1 -1
  8. package/artifacts/env-template/public/{peers.33e92e193842c9721b79.js → peers.20d9efa00126dc5d87db.js} +1 -1
  9. package/artifacts/env-template/public/{preview-root.d4cdc0db0c8b0f93ac7e.js → preview-root.0178bd8c2761429de605.js} +1 -1
  10. package/artifacts/preview/teambit_mdx_readme-preview.js +1 -1
  11. package/artifacts/schema.json +592 -21
  12. package/{compositions-1674271762484.js → compositions-1674531051110.js} +0 -0
  13. package/dist/{preview-1674271762484.js → preview-1674531051110.js} +0 -0
  14. package/{overview-1674271762484.js → overview-1674531051110.js} +0 -0
  15. package/package-tar/teambit-readme-0.0.250.tgz +0 -0
  16. package/package.json +8 -8
  17. package/artifacts/env-template/public/overview.1b9f6950ece716ce561a.js +0 -5
  18. package/package-tar/teambit-readme-0.0.249.tgz +0 -0
package/artifacts/schema.json CHANGED
@@ -13,6 +13,16 @@
13
13
  "character": 1
14
14
  },
15
15
  "exports": [
16
+ {
17
+ "__schema": "UnImplementedSchema",
18
+ "location": {
19
+ "filePath": "index.ts",
20
+ "line": 3,
21
+ "character": 16
22
+ },
23
+ "name": "ReadmeAspect",
24
+ "type": "Identifier"
25
+ },
16
26
  {
17
27
  "__schema": "ClassSchema",
18
28
  "name": "ReadmeMain",
@@ -72,7 +82,9 @@
72
82
  "line": 12,
73
83
  "character": 3
74
84
  },
85
+ "name": "constructor",
75
86
  "signature": "constructor ReadmeMain(env: ReadmeEnv & MdxEnv, docs: DocsMain): ReadmeMain",
87
+ "modifiers": [],
76
88
  "params": [
77
89
  {
78
90
  "__schema": "ParameterSchema",
@@ -110,8 +122,7 @@
110
122
  "name": "MdxEnv",
111
123
  "componentId": {
112
124
  "scope": "teambit.mdx",
113
- "name": "mdx",
114
- "version": "0.0.945"
125
+ "name": "mdx"
115
126
  }
116
127
  }
117
128
  ]
@@ -136,12 +147,19 @@
136
147
  "name": "DocsMain",
137
148
  "componentId": {
138
149
  "scope": "teambit.docs",
139
- "name": "docs",
140
- "version": "0.0.965"
150
+ "name": "docs"
141
151
  }
142
152
  }
143
153
  }
144
- ]
154
+ ],
155
+ "returnType": {
156
+ "__schema": "ThisTypeSchema",
157
+ "location": {
158
+ "filePath": "readme.main.runtime.ts",
159
+ "line": 9,
160
+ "character": 1
161
+ }
162
+ }
145
163
  },
146
164
  {
147
165
  "__schema": "FunctionLikeSchema",
@@ -205,8 +223,7 @@
205
223
  "name": "EnvsMain",
206
224
  "componentId": {
207
225
  "scope": "teambit.envs",
208
- "name": "envs",
209
- "version": "0.0.965"
226
+ "name": "envs"
210
227
  }
211
228
  },
212
229
  {
@@ -219,8 +236,7 @@
219
236
  "name": "MDXMain",
220
237
  "componentId": {
221
238
  "scope": "teambit.mdx",
222
- "name": "mdx",
223
- "version": "0.0.945"
239
+ "name": "mdx"
224
240
  }
225
241
  },
226
242
  {
@@ -233,8 +249,7 @@
233
249
  "name": "DocsMain",
234
250
  "componentId": {
235
251
  "scope": "teambit.docs",
236
- "name": "docs",
237
- "version": "0.0.965"
252
+ "name": "docs"
238
253
  }
239
254
  }
240
255
  ]
@@ -284,7 +299,7 @@
284
299
  "componentId": {
285
300
  "scope": "teambit.mdx",
286
301
  "name": "readme",
287
- "version": "0.0.249"
302
+ "version": "0.0.250"
288
303
  }
289
304
  }
290
305
  }
@@ -297,7 +312,9 @@
297
312
  "line": 8,
298
313
  "character": 3
299
314
  },
315
+ "name": "constructor",
300
316
  "signature": "constructor ReadmeEnv(docs: DocsMain): ReadmeEnv",
317
+ "modifiers": [],
301
318
  "params": [
302
319
  {
303
320
  "__schema": "ParameterSchema",
@@ -318,12 +335,19 @@
318
335
  "name": "DocsMain",
319
336
  "componentId": {
320
337
  "scope": "teambit.docs",
321
- "name": "docs",
322
- "version": "0.0.965"
338
+ "name": "docs"
323
339
  }
324
340
  }
325
341
  }
326
- ]
342
+ ],
343
+ "returnType": {
344
+ "__schema": "ThisTypeSchema",
345
+ "location": {
346
+ "filePath": "readme.env.ts",
347
+ "line": 7,
348
+ "character": 1
349
+ }
350
+ }
327
351
  },
328
352
  {
329
353
  "__schema": "FunctionLikeSchema",
@@ -355,8 +379,7 @@
355
379
  "name": "Component",
356
380
  "componentId": {
357
381
  "scope": "teambit.component",
358
- "name": "component",
359
- "version": "0.0.965"
382
+ "name": "component"
360
383
  }
361
384
  }
362
385
  }
@@ -409,8 +432,7 @@
409
432
  "name": "Component",
410
433
  "componentId": {
411
434
  "scope": "teambit.component",
412
- "name": "component",
413
- "version": "0.0.965"
435
+ "name": "component"
414
436
  }
415
437
  }
416
438
  }
@@ -483,11 +505,560 @@
483
505
  }
484
506
  }
485
507
  }
486
- ]
508
+ ],
509
+ "internals": []
487
510
  },
511
+ "internals": [
512
+ {
513
+ "__schema": "ModuleSchema",
514
+ "location": {
515
+ "filePath": "readme.main.runtime.ts",
516
+ "line": 1,
517
+ "character": 1
518
+ },
519
+ "exports": [
520
+ {
521
+ "__schema": "ClassSchema",
522
+ "name": "ReadmeMain",
523
+ "location": {
524
+ "filePath": "readme.main.runtime.ts",
525
+ "line": 9,
526
+ "character": 1
527
+ },
528
+ "signature": "class ReadmeMain",
529
+ "extendsNodes": [],
530
+ "implementNodes": [],
531
+ "members": [
532
+ {
533
+ "__schema": "VariableLikeSchema",
534
+ "location": {
535
+ "filePath": "readme.main.runtime.ts",
536
+ "line": 10,
537
+ "character": 3
538
+ },
539
+ "name": "runtime",
540
+ "signature": "(property) ReadmeMain.runtime: RuntimeDefinition",
541
+ "isOptional": false,
542
+ "type": {
543
+ "__schema": "InferenceTypeSchema",
544
+ "location": {
545
+ "filePath": "readme.main.runtime.ts",
546
+ "line": 10,
547
+ "character": 3
548
+ },
549
+ "type": "RuntimeDefinition"
550
+ }
551
+ },
552
+ {
553
+ "__schema": "VariableLikeSchema",
554
+ "location": {
555
+ "filePath": "readme.main.runtime.ts",
556
+ "line": 11,
557
+ "character": 3
558
+ },
559
+ "name": "dependencies",
560
+ "signature": "(property) ReadmeMain.dependencies: Aspect[]",
561
+ "isOptional": false,
562
+ "type": {
563
+ "__schema": "InferenceTypeSchema",
564
+ "location": {
565
+ "filePath": "readme.main.runtime.ts",
566
+ "line": 11,
567
+ "character": 3
568
+ },
569
+ "type": "Aspect[]"
570
+ }
571
+ },
572
+ {
573
+ "__schema": "ConstructorSchema",
574
+ "location": {
575
+ "filePath": "readme.main.runtime.ts",
576
+ "line": 12,
577
+ "character": 3
578
+ },
579
+ "name": "constructor",
580
+ "signature": "constructor ReadmeMain(env: ReadmeEnv & MdxEnv, docs: DocsMain): ReadmeMain",
581
+ "modifiers": [],
582
+ "params": [
583
+ {
584
+ "__schema": "ParameterSchema",
585
+ "location": {
586
+ "filePath": "readme.main.runtime.ts",
587
+ "line": 12,
588
+ "character": 15
589
+ },
590
+ "name": "env",
591
+ "isOptional": false,
592
+ "type": {
593
+ "__schema": "TypeIntersectionSchema",
594
+ "location": {
595
+ "filePath": "readme.main.runtime.ts",
596
+ "line": 12,
597
+ "character": 30
598
+ },
599
+ "types": [
600
+ {
601
+ "__schema": "TypeRefSchema",
602
+ "location": {
603
+ "filePath": "readme.main.runtime.ts",
604
+ "line": 12,
605
+ "character": 30
606
+ },
607
+ "name": "ReadmeEnv"
608
+ },
609
+ {
610
+ "__schema": "TypeRefSchema",
611
+ "location": {
612
+ "filePath": "readme.main.runtime.ts",
613
+ "line": 12,
614
+ "character": 42
615
+ },
616
+ "name": "MdxEnv",
617
+ "componentId": {
618
+ "scope": "teambit.mdx",
619
+ "name": "mdx"
620
+ }
621
+ }
622
+ ]
623
+ }
624
+ },
625
+ {
626
+ "__schema": "ParameterSchema",
627
+ "location": {
628
+ "filePath": "readme.main.runtime.ts",
629
+ "line": 12,
630
+ "character": 50
631
+ },
632
+ "name": "docs",
633
+ "isOptional": false,
634
+ "type": {
635
+ "__schema": "TypeRefSchema",
636
+ "location": {
637
+ "filePath": "readme.main.runtime.ts",
638
+ "line": 12,
639
+ "character": 64
640
+ },
641
+ "name": "DocsMain",
642
+ "componentId": {
643
+ "scope": "teambit.docs",
644
+ "name": "docs"
645
+ }
646
+ }
647
+ }
648
+ ],
649
+ "returnType": {
650
+ "__schema": "ThisTypeSchema",
651
+ "location": {
652
+ "filePath": "readme.main.runtime.ts",
653
+ "line": 9,
654
+ "character": 1
655
+ }
656
+ }
657
+ },
658
+ {
659
+ "__schema": "FunctionLikeSchema",
660
+ "location": {
661
+ "filePath": "readme.main.runtime.ts",
662
+ "line": 13,
663
+ "character": 3
664
+ },
665
+ "name": "icon",
666
+ "signature": "(method) ReadmeMain.icon(): string",
667
+ "modifiers": [],
668
+ "params": [],
669
+ "returnType": {
670
+ "__schema": "InferenceTypeSchema",
671
+ "location": {
672
+ "filePath": "readme.main.runtime.ts",
673
+ "line": 13,
674
+ "character": 3
675
+ },
676
+ "type": "string"
677
+ }
678
+ },
679
+ {
680
+ "__schema": "FunctionLikeSchema",
681
+ "location": {
682
+ "filePath": "readme.main.runtime.ts",
683
+ "line": 16,
684
+ "character": 3
685
+ },
686
+ "name": "provider",
687
+ "signature": "(method) ReadmeMain.provider([envs, mdx, docs]: [EnvsMain, MDXMain, DocsMain]): Promise<ReadmeMain>",
688
+ "modifiers": [
689
+ "static",
690
+ "async"
691
+ ],
692
+ "params": [
693
+ {
694
+ "__schema": "ParameterSchema",
695
+ "location": {
696
+ "filePath": "readme.main.runtime.ts",
697
+ "line": 16,
698
+ "character": 25
699
+ },
700
+ "name": "[ envs, mdx, docs ]",
701
+ "isOptional": false,
702
+ "type": {
703
+ "__schema": "TupleTypeSchema",
704
+ "location": {
705
+ "filePath": "readme.main.runtime.ts",
706
+ "line": 16,
707
+ "character": 44
708
+ },
709
+ "elements": [
710
+ {
711
+ "__schema": "TypeRefSchema",
712
+ "location": {
713
+ "filePath": "readme.main.runtime.ts",
714
+ "line": 16,
715
+ "character": 45
716
+ },
717
+ "name": "EnvsMain",
718
+ "componentId": {
719
+ "scope": "teambit.envs",
720
+ "name": "envs"
721
+ }
722
+ },
723
+ {
724
+ "__schema": "TypeRefSchema",
725
+ "location": {
726
+ "filePath": "readme.main.runtime.ts",
727
+ "line": 16,
728
+ "character": 55
729
+ },
730
+ "name": "MDXMain",
731
+ "componentId": {
732
+ "scope": "teambit.mdx",
733
+ "name": "mdx"
734
+ }
735
+ },
736
+ {
737
+ "__schema": "TypeRefSchema",
738
+ "location": {
739
+ "filePath": "readme.main.runtime.ts",
740
+ "line": 16,
741
+ "character": 64
742
+ },
743
+ "name": "DocsMain",
744
+ "componentId": {
745
+ "scope": "teambit.docs",
746
+ "name": "docs"
747
+ }
748
+ }
749
+ ]
750
+ }
751
+ }
752
+ ],
753
+ "returnType": {
754
+ "__schema": "InferenceTypeSchema",
755
+ "location": {
756
+ "filePath": "readme.main.runtime.ts",
757
+ "line": 16,
758
+ "character": 3
759
+ },
760
+ "type": "Promise<ReadmeMain>"
761
+ }
762
+ }
763
+ ]
764
+ }
765
+ ],
766
+ "internals": [
767
+ {
768
+ "__schema": "UnImplementedSchema",
769
+ "location": {
770
+ "filePath": "readme.main.runtime.ts",
771
+ "line": 24,
772
+ "character": 1
773
+ },
774
+ "name": "ReadmeAspect.addRuntime(ReadmeMain);",
775
+ "type": "ExpressionStatement"
776
+ }
777
+ ]
778
+ },
779
+ {
780
+ "__schema": "ModuleSchema",
781
+ "location": {
782
+ "filePath": "readme.env.ts",
783
+ "line": 1,
784
+ "character": 1
785
+ },
786
+ "exports": [
787
+ {
788
+ "__schema": "VariableLikeSchema",
789
+ "location": {
790
+ "filePath": "readme.env.ts",
791
+ "line": 5,
792
+ "character": 14
793
+ },
794
+ "name": "ReadmeEnvType",
795
+ "signature": "const ReadmeEnvType: \"readme\"",
796
+ "isOptional": false,
797
+ "type": {
798
+ "__schema": "InferenceTypeSchema",
799
+ "location": {
800
+ "filePath": "readme.env.ts",
801
+ "line": 5,
802
+ "character": 14
803
+ },
804
+ "type": "\"readme\""
805
+ }
806
+ },
807
+ {
808
+ "__schema": "ClassSchema",
809
+ "name": "ReadmeEnv",
810
+ "location": {
811
+ "filePath": "readme.env.ts",
812
+ "line": 7,
813
+ "character": 1
814
+ },
815
+ "signature": "class ReadmeEnv",
816
+ "extendsNodes": [],
817
+ "implementNodes": [
818
+ {
819
+ "__schema": "ExpressionWithTypeArgumentsSchema",
820
+ "name": "implements Environment",
821
+ "location": {
822
+ "filePath": "readme.env.ts",
823
+ "line": 7,
824
+ "character": 35
825
+ },
826
+ "typeArgs": [],
827
+ "expression": {
828
+ "__schema": "TypeRefSchema",
829
+ "location": {
830
+ "filePath": "readme.env.ts",
831
+ "line": 7,
832
+ "character": 35
833
+ },
834
+ "name": "Environment",
835
+ "componentId": {
836
+ "scope": "teambit.mdx",
837
+ "name": "readme",
838
+ "version": "0.0.250"
839
+ }
840
+ }
841
+ }
842
+ ],
843
+ "members": [
844
+ {
845
+ "__schema": "ConstructorSchema",
846
+ "location": {
847
+ "filePath": "readme.env.ts",
848
+ "line": 8,
849
+ "character": 3
850
+ },
851
+ "name": "constructor",
852
+ "signature": "constructor ReadmeEnv(docs: DocsMain): ReadmeEnv",
853
+ "modifiers": [],
854
+ "params": [
855
+ {
856
+ "__schema": "ParameterSchema",
857
+ "location": {
858
+ "filePath": "readme.env.ts",
859
+ "line": 8,
860
+ "character": 15
861
+ },
862
+ "name": "docs",
863
+ "isOptional": false,
864
+ "type": {
865
+ "__schema": "TypeRefSchema",
866
+ "location": {
867
+ "filePath": "readme.env.ts",
868
+ "line": 8,
869
+ "character": 29
870
+ },
871
+ "name": "DocsMain",
872
+ "componentId": {
873
+ "scope": "teambit.docs",
874
+ "name": "docs"
875
+ }
876
+ }
877
+ }
878
+ ],
879
+ "returnType": {
880
+ "__schema": "ThisTypeSchema",
881
+ "location": {
882
+ "filePath": "readme.env.ts",
883
+ "line": 7,
884
+ "character": 1
885
+ }
886
+ }
887
+ },
888
+ {
889
+ "__schema": "FunctionLikeSchema",
890
+ "location": {
891
+ "filePath": "readme.env.ts",
892
+ "line": 12,
893
+ "character": 3
894
+ },
895
+ "name": "getDocsDevPatterns",
896
+ "signature": "(method) ReadmeEnv.getDocsDevPatterns(component: Component): string[]",
897
+ "modifiers": [],
898
+ "params": [
899
+ {
900
+ "__schema": "ParameterSchema",
901
+ "location": {
902
+ "filePath": "readme.env.ts",
903
+ "line": 12,
904
+ "character": 22
905
+ },
906
+ "name": "component",
907
+ "isOptional": false,
908
+ "type": {
909
+ "__schema": "TypeRefSchema",
910
+ "location": {
911
+ "filePath": "readme.env.ts",
912
+ "line": 12,
913
+ "character": 33
914
+ },
915
+ "name": "Component",
916
+ "componentId": {
917
+ "scope": "teambit.component",
918
+ "name": "component"
919
+ }
920
+ }
921
+ }
922
+ ],
923
+ "returnType": {
924
+ "__schema": "TypeArraySchema",
925
+ "location": {
926
+ "filePath": "readme.env.ts",
927
+ "line": 12,
928
+ "character": 45
929
+ },
930
+ "type": {
931
+ "__schema": "KeywordTypeSchema",
932
+ "location": {
933
+ "filePath": "readme.env.ts",
934
+ "line": 12,
935
+ "character": 45
936
+ },
937
+ "name": "string"
938
+ }
939
+ }
940
+ },
941
+ {
942
+ "__schema": "FunctionLikeSchema",
943
+ "location": {
944
+ "filePath": "readme.env.ts",
945
+ "line": 15,
946
+ "character": 3
947
+ },
948
+ "name": "getDevPatterns",
949
+ "signature": "(method) ReadmeEnv.getDevPatterns(component?: Component): string[]",
950
+ "modifiers": [],
951
+ "params": [
952
+ {
953
+ "__schema": "ParameterSchema",
954
+ "location": {
955
+ "filePath": "readme.env.ts",
956
+ "line": 15,
957
+ "character": 18
958
+ },
959
+ "name": "component",
960
+ "isOptional": true,
961
+ "type": {
962
+ "__schema": "TypeRefSchema",
963
+ "location": {
964
+ "filePath": "readme.env.ts",
965
+ "line": 15,
966
+ "character": 30
967
+ },
968
+ "name": "Component",
969
+ "componentId": {
970
+ "scope": "teambit.component",
971
+ "name": "component"
972
+ }
973
+ }
974
+ }
975
+ ],
976
+ "returnType": {
977
+ "__schema": "TypeArraySchema",
978
+ "location": {
979
+ "filePath": "readme.env.ts",
980
+ "line": 15,
981
+ "character": 42
982
+ },
983
+ "type": {
984
+ "__schema": "KeywordTypeSchema",
985
+ "location": {
986
+ "filePath": "readme.env.ts",
987
+ "line": 15,
988
+ "character": 42
989
+ },
990
+ "name": "string"
991
+ }
992
+ }
993
+ },
994
+ {
995
+ "__schema": "FunctionLikeSchema",
996
+ "location": {
997
+ "filePath": "readme.env.ts",
998
+ "line": 18,
999
+ "character": 3
1000
+ },
1001
+ "name": "__getDescriptor",
1002
+ "signature": "(method) ReadmeEnv.__getDescriptor(): Promise<{\n type: string;\n}>",
1003
+ "modifiers": [
1004
+ "async"
1005
+ ],
1006
+ "params": [],
1007
+ "returnType": {
1008
+ "__schema": "InferenceTypeSchema",
1009
+ "location": {
1010
+ "filePath": "readme.env.ts",
1011
+ "line": 18,
1012
+ "character": 3
1013
+ },
1014
+ "type": "Promise<{\n type: string;\n}>"
1015
+ }
1016
+ }
1017
+ ]
1018
+ }
1019
+ ],
1020
+ "internals": []
1021
+ },
1022
+ {
1023
+ "__schema": "ModuleSchema",
1024
+ "location": {
1025
+ "filePath": "readme.aspect.ts",
1026
+ "line": 1,
1027
+ "character": 1
1028
+ },
1029
+ "exports": [
1030
+ {
1031
+ "__schema": "VariableLikeSchema",
1032
+ "location": {
1033
+ "filePath": "readme.aspect.ts",
1034
+ "line": 3,
1035
+ "character": 14
1036
+ },
1037
+ "name": "ReadmeAspect",
1038
+ "signature": "const ReadmeAspect: Aspect",
1039
+ "isOptional": false,
1040
+ "type": {
1041
+ "__schema": "TypeRefSchema",
1042
+ "location": {
1043
+ "filePath": "readme.aspect.ts",
1044
+ "line": 3,
1045
+ "character": 14
1046
+ },
1047
+ "name": "Aspect",
1048
+ "componentId": {
1049
+ "scope": "teambit.harmony",
1050
+ "name": "harmony",
1051
+ "version": "0.4.6"
1052
+ }
1053
+ }
1054
+ }
1055
+ ],
1056
+ "internals": []
1057
+ }
1058
+ ],
488
1059
  "componentId": {
489
1060
  "scope": "teambit.mdx",
490
1061
  "name": "readme",
491
- "version": "0.0.249"
1062
+ "version": "0.0.250"
492
1063
  }
493
1064
  }