@microsoft/api-extractor 7.38.1 → 7.38.3

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 (58) hide show
  1. package/LICENSE +23 -23
  2. package/README.md +51 -51
  3. package/bin/api-extractor +2 -2
  4. package/extends/tsdoc-base.json +72 -72
  5. package/lib/aedoc/PackageDocComment.js.map +1 -1
  6. package/lib/analyzer/AstDeclaration.js.map +1 -1
  7. package/lib/analyzer/AstEntity.js.map +1 -1
  8. package/lib/analyzer/AstImport.js.map +1 -1
  9. package/lib/analyzer/AstModule.js.map +1 -1
  10. package/lib/analyzer/AstNamespaceImport.js.map +1 -1
  11. package/lib/analyzer/AstReferenceResolver.js.map +1 -1
  12. package/lib/analyzer/AstSymbol.js.map +1 -1
  13. package/lib/analyzer/AstSymbolTable.js.map +1 -1
  14. package/lib/analyzer/ExportAnalyzer.js.map +1 -1
  15. package/lib/analyzer/PackageMetadataManager.js.map +1 -1
  16. package/lib/analyzer/SourceFileLocationFormatter.js.map +1 -1
  17. package/lib/analyzer/Span.js.map +1 -1
  18. package/lib/analyzer/SyntaxHelpers.js.map +1 -1
  19. package/lib/analyzer/TypeScriptHelpers.js.map +1 -1
  20. package/lib/analyzer/TypeScriptInternals.js.map +1 -1
  21. package/lib/api/CompilerState.js.map +1 -1
  22. package/lib/api/ConsoleMessageId.js.map +1 -1
  23. package/lib/api/Extractor.js.map +1 -1
  24. package/lib/api/ExtractorConfig.js.map +1 -1
  25. package/lib/api/ExtractorLogLevel.js.map +1 -1
  26. package/lib/api/ExtractorMessage.js.map +1 -1
  27. package/lib/api/ExtractorMessageId.js.map +1 -1
  28. package/lib/api/IConfigFile.js.map +1 -1
  29. package/lib/cli/ApiExtractorCommandLine.js.map +1 -1
  30. package/lib/cli/InitAction.js.map +1 -1
  31. package/lib/cli/RunAction.js.map +1 -1
  32. package/lib/collector/ApiItemMetadata.js.map +1 -1
  33. package/lib/collector/Collector.js.map +1 -1
  34. package/lib/collector/CollectorEntity.js.map +1 -1
  35. package/lib/collector/DeclarationMetadata.js.map +1 -1
  36. package/lib/collector/MessageRouter.js.map +1 -1
  37. package/lib/collector/SourceMapper.js.map +1 -1
  38. package/lib/collector/SymbolMetadata.js.map +1 -1
  39. package/lib/collector/VisitorState.js.map +1 -1
  40. package/lib/collector/WorkingPackage.js.map +1 -1
  41. package/lib/enhancers/DocCommentEnhancer.js.map +1 -1
  42. package/lib/enhancers/ValidationEnhancer.js.map +1 -1
  43. package/lib/generators/ApiModelGenerator.js.map +1 -1
  44. package/lib/generators/ApiReportGenerator.d.ts +1 -0
  45. package/lib/generators/ApiReportGenerator.d.ts.map +1 -1
  46. package/lib/generators/ApiReportGenerator.js +17 -9
  47. package/lib/generators/ApiReportGenerator.js.map +1 -1
  48. package/lib/generators/DeclarationReferenceGenerator.js.map +1 -1
  49. package/lib/generators/DtsEmitHelpers.js.map +1 -1
  50. package/lib/generators/DtsRollupGenerator.js.map +1 -1
  51. package/lib/generators/ExcerptBuilder.js.map +1 -1
  52. package/lib/generators/IndentedWriter.js.map +1 -1
  53. package/lib/index.js.map +1 -1
  54. package/lib/schemas/api-extractor-defaults.json +95 -95
  55. package/lib/schemas/api-extractor-template.json +427 -427
  56. package/lib/schemas/api-extractor.schema.json +229 -229
  57. package/lib/start.js.map +1 -1
  58. package/package.json +3 -3
package/lib/schemas/api-extractor-defaults.json CHANGED
@@ -1,95 +1,95 @@
1
- {
2
- "projectFolder": "<lookup>",
3
-
4
- // ("mainEntryPointFilePath" is required)
5
-
6
- "bundledPackages": [],
7
-
8
- "newlineKind": "crlf",
9
-
10
- "enumMemberOrder": "by-name",
11
-
12
- "compiler": {
13
- "tsconfigFilePath": "<projectFolder>/tsconfig.json",
14
- "skipLibCheck": false
15
- },
16
-
17
- "apiReport": {
18
- // ("enabled" is required)
19
- "reportFileName": "<unscopedPackageName>.api.md",
20
- "reportFolder": "<projectFolder>/etc/",
21
- "reportTempFolder": "<projectFolder>/temp/",
22
- "includeForgottenExports": false
23
- },
24
-
25
- "docModel": {
26
- // ("enabled" is required)
27
- "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json",
28
- "includeForgottenExports": false
29
- },
30
-
31
- "dtsRollup": {
32
- // ("enabled" is required)
33
-
34
- "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
35
- "alphaTrimmedFilePath": "",
36
- "betaTrimmedFilePath": "",
37
- "publicTrimmedFilePath": "",
38
- "omitTrimmingComments": false
39
- },
40
-
41
- "tsdocMetadata": {
42
- "enabled": true,
43
- "tsdocMetadataFilePath": "<lookup>"
44
- },
45
-
46
- "messages": {
47
- "compilerMessageReporting": {
48
- "default": {
49
- "logLevel": "warning"
50
- }
51
- },
52
- "extractorMessageReporting": {
53
- "default": {
54
- "logLevel": "warning"
55
- },
56
- "ae-forgotten-export": {
57
- "logLevel": "warning",
58
- "addToApiReportFile": true
59
- },
60
- "ae-incompatible-release-tags": {
61
- "logLevel": "warning",
62
- "addToApiReportFile": true
63
- },
64
- "ae-internal-missing-underscore": {
65
- "logLevel": "warning",
66
- "addToApiReportFile": true
67
- },
68
- "ae-internal-mixed-release-tag": {
69
- "logLevel": "warning",
70
- "addToApiReportFile": true
71
- },
72
- "ae-undocumented": {
73
- "logLevel": "none"
74
- },
75
- "ae-unresolved-inheritdoc-reference": {
76
- "logLevel": "warning",
77
- "addToApiReportFile": true
78
- },
79
- "ae-unresolved-inheritdoc-base": {
80
- "logLevel": "warning",
81
- "addToApiReportFile": true
82
- },
83
- "ae-wrong-input-file-type": {
84
- "logLevel": "error"
85
- }
86
- },
87
- "tsdocMessageReporting": {
88
- "default": {
89
- "logLevel": "warning"
90
- }
91
- }
92
- },
93
-
94
- "testMode": false
95
- }
1
+ {
2
+ "projectFolder": "<lookup>",
3
+
4
+ // ("mainEntryPointFilePath" is required)
5
+
6
+ "bundledPackages": [],
7
+
8
+ "newlineKind": "crlf",
9
+
10
+ "enumMemberOrder": "by-name",
11
+
12
+ "compiler": {
13
+ "tsconfigFilePath": "<projectFolder>/tsconfig.json",
14
+ "skipLibCheck": false
15
+ },
16
+
17
+ "apiReport": {
18
+ // ("enabled" is required)
19
+ "reportFileName": "<unscopedPackageName>.api.md",
20
+ "reportFolder": "<projectFolder>/etc/",
21
+ "reportTempFolder": "<projectFolder>/temp/",
22
+ "includeForgottenExports": false
23
+ },
24
+
25
+ "docModel": {
26
+ // ("enabled" is required)
27
+ "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json",
28
+ "includeForgottenExports": false
29
+ },
30
+
31
+ "dtsRollup": {
32
+ // ("enabled" is required)
33
+
34
+ "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
35
+ "alphaTrimmedFilePath": "",
36
+ "betaTrimmedFilePath": "",
37
+ "publicTrimmedFilePath": "",
38
+ "omitTrimmingComments": false
39
+ },
40
+
41
+ "tsdocMetadata": {
42
+ "enabled": true,
43
+ "tsdocMetadataFilePath": "<lookup>"
44
+ },
45
+
46
+ "messages": {
47
+ "compilerMessageReporting": {
48
+ "default": {
49
+ "logLevel": "warning"
50
+ }
51
+ },
52
+ "extractorMessageReporting": {
53
+ "default": {
54
+ "logLevel": "warning"
55
+ },
56
+ "ae-forgotten-export": {
57
+ "logLevel": "warning",
58
+ "addToApiReportFile": true
59
+ },
60
+ "ae-incompatible-release-tags": {
61
+ "logLevel": "warning",
62
+ "addToApiReportFile": true
63
+ },
64
+ "ae-internal-missing-underscore": {
65
+ "logLevel": "warning",
66
+ "addToApiReportFile": true
67
+ },
68
+ "ae-internal-mixed-release-tag": {
69
+ "logLevel": "warning",
70
+ "addToApiReportFile": true
71
+ },
72
+ "ae-undocumented": {
73
+ "logLevel": "none"
74
+ },
75
+ "ae-unresolved-inheritdoc-reference": {
76
+ "logLevel": "warning",
77
+ "addToApiReportFile": true
78
+ },
79
+ "ae-unresolved-inheritdoc-base": {
80
+ "logLevel": "warning",
81
+ "addToApiReportFile": true
82
+ },
83
+ "ae-wrong-input-file-type": {
84
+ "logLevel": "error"
85
+ }
86
+ },
87
+ "tsdocMessageReporting": {
88
+ "default": {
89
+ "logLevel": "warning"
90
+ }
91
+ }
92
+ },
93
+
94
+ "testMode": false
95
+ }