@cparra/apexdocs 2.23.0 → 2.24.0

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 (163) hide show
  1. package/.eslintrc.js +12 -12
  2. package/.github/workflows/close_stale.yml +22 -22
  3. package/.prettierrc.js +7 -7
  4. package/LICENSE +21 -21
  5. package/README.md +718 -718
  6. package/apexdocs.config.ts +13 -13
  7. package/docs/README.md +1 -1
  8. package/docs/restapi.json +589 -589
  9. package/docs/types/Classes/nspc.ChildClass.md +97 -97
  10. package/docs/types/Main/nspc.SampleClass.md +189 -189
  11. package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
  12. package/examples/force-app/main/default/classes/ChildClass.cls +42 -42
  13. package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -5
  14. package/examples/force-app/main/default/classes/GrandparentClass.cls +4 -4
  15. package/examples/force-app/main/default/classes/GroupedClass.cls +8 -8
  16. package/examples/force-app/main/default/classes/MemberGrouping.cls +17 -17
  17. package/examples/force-app/main/default/classes/ParentClass.cls +16 -16
  18. package/examples/force-app/main/default/classes/SampleClass.cls +166 -166
  19. package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml +5 -5
  20. package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
  21. package/examples/force-app/main/default/classes/SampleInterface.cls +16 -16
  22. package/examples/force-app/main/default/restapi/SampleRestResource.cls +195 -195
  23. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  24. package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +24 -24
  25. package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +15 -15
  26. package/examples/force-app/main/default/restapi/references/Reference1.cls +9 -9
  27. package/examples/force-app/main/default/restapi/references/Reference2.cls +9 -9
  28. package/examples/force-app/main/default/restapi/references/Reference3.cls +3 -3
  29. package/examples/force-app/main/default/restapi/references/Reference4.cls +3 -3
  30. package/examples/force-app/main/default/restapi/references/Reference5.cls +3 -3
  31. package/examples/force-app/main/default/restapi/references/Reference6.cls +6 -6
  32. package/examples/force-app/main/default/restapi/references/Reference7.cls +3 -3
  33. package/examples/includes/header.md +3 -3
  34. package/jest.config.js +5 -5
  35. package/lib/application/Apexdocs.d.ts +13 -13
  36. package/lib/application/Apexdocs.js +76 -76
  37. package/lib/cli/generate.d.ts +2 -2
  38. package/lib/cli/generate.js +130 -130
  39. package/lib/index.d.ts +1 -1
  40. package/lib/index.js +17 -17
  41. package/lib/model/apex-bundle.d.ts +6 -6
  42. package/lib/model/apex-bundle.js +10 -10
  43. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -7
  44. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +13 -13
  45. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -7
  46. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +11 -11
  47. package/lib/model/inheritance.d.ts +8 -8
  48. package/lib/model/inheritance.js +2 -2
  49. package/lib/model/manifest-diff.d.ts +27 -27
  50. package/lib/model/manifest-diff.js +68 -68
  51. package/lib/model/manifest.d.ts +22 -22
  52. package/lib/model/manifest.js +46 -46
  53. package/lib/model/markdown-file.d.ts +16 -16
  54. package/lib/model/markdown-file.js +106 -106
  55. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -8
  56. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +43 -43
  57. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
  58. package/lib/model/markdown-generation-util/field-declaration-util.js +54 -54
  59. package/lib/model/markdown-generation-util/index.d.ts +3 -3
  60. package/lib/model/markdown-generation-util/index.js +19 -19
  61. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -4
  62. package/lib/model/markdown-generation-util/method-declaration-util.js +114 -114
  63. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -3
  64. package/lib/model/markdown-generation-util/type-declaration-util.js +81 -81
  65. package/lib/model/markdown-home-file.d.ts +11 -11
  66. package/lib/model/markdown-home-file.js +53 -53
  67. package/lib/model/markdown-type-file.d.ts +26 -26
  68. package/lib/model/markdown-type-file.js +133 -133
  69. package/lib/model/openapi/apex-doc-types.d.ts +19 -19
  70. package/lib/model/openapi/apex-doc-types.js +4 -4
  71. package/lib/model/openapi/open-api-types.d.ts +93 -93
  72. package/lib/model/openapi/open-api-types.js +2 -2
  73. package/lib/model/openapi/open-api.d.ts +16 -16
  74. package/lib/model/openapi/open-api.js +33 -33
  75. package/lib/model/openapi/openapi-type-file.d.ts +7 -7
  76. package/lib/model/openapi/openapi-type-file.js +16 -16
  77. package/lib/model/outputFile.d.ts +10 -10
  78. package/lib/model/outputFile.js +28 -28
  79. package/lib/model/types-repository.d.ts +16 -16
  80. package/lib/model/types-repository.js +53 -53
  81. package/lib/service/apex-file-reader.d.ts +14 -14
  82. package/lib/service/apex-file-reader.js +45 -45
  83. package/lib/service/file-system.d.ts +14 -14
  84. package/lib/service/file-system.js +24 -24
  85. package/lib/service/file-writer.d.ts +6 -6
  86. package/lib/service/file-writer.js +33 -33
  87. package/lib/service/manifest-factory.d.ts +10 -10
  88. package/lib/service/manifest-factory.js +13 -13
  89. package/lib/service/metadata-processor.d.ts +3 -3
  90. package/lib/service/metadata-processor.js +16 -16
  91. package/lib/service/parser.d.ts +21 -21
  92. package/lib/service/parser.js +134 -134
  93. package/lib/service/state.d.ts +9 -9
  94. package/lib/service/state.js +19 -19
  95. package/lib/service/walkers/class-walker.d.ts +4 -4
  96. package/lib/service/walkers/class-walker.js +32 -32
  97. package/lib/service/walkers/enum-walker.d.ts +4 -4
  98. package/lib/service/walkers/enum-walker.js +10 -10
  99. package/lib/service/walkers/interface-walker.d.ts +4 -4
  100. package/lib/service/walkers/interface-walker.js +14 -14
  101. package/lib/service/walkers/walker-factory.d.ts +5 -5
  102. package/lib/service/walkers/walker-factory.js +20 -20
  103. package/lib/service/walkers/walker.d.ts +19 -19
  104. package/lib/service/walkers/walker.js +16 -16
  105. package/lib/settings.d.ts +64 -64
  106. package/lib/settings.js +88 -88
  107. package/lib/test-helpers/AnnotationBuilder.d.ts +12 -12
  108. package/lib/test-helpers/AnnotationBuilder.js +30 -30
  109. package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -18
  110. package/lib/test-helpers/ClassMirrorBuilder.js +53 -53
  111. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -8
  112. package/lib/test-helpers/DocCommentAnnotationBuilder.js +25 -25
  113. package/lib/test-helpers/DocCommentBuilder.d.ts +12 -12
  114. package/lib/test-helpers/DocCommentBuilder.js +37 -37
  115. package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -18
  116. package/lib/test-helpers/FieldMirrorBuilder.js +53 -53
  117. package/lib/test-helpers/MethodMirrorBuilder.d.ts +10 -10
  118. package/lib/test-helpers/MethodMirrorBuilder.js +36 -36
  119. package/lib/test-helpers/SettingsBuilder.d.ts +8 -8
  120. package/lib/test-helpers/SettingsBuilder.js +26 -26
  121. package/lib/transpiler/factory.d.ts +6 -6
  122. package/lib/transpiler/factory.js +31 -31
  123. package/lib/transpiler/file-container.d.ts +6 -6
  124. package/lib/transpiler/file-container.js +15 -15
  125. package/lib/transpiler/generator-choices.d.ts +1 -1
  126. package/lib/transpiler/generator-choices.js +2 -2
  127. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +8 -8
  128. package/lib/transpiler/markdown/class-file-generatorHelper.js +55 -55
  129. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -6
  130. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +12 -12
  131. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -11
  132. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -50
  133. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
  134. package/lib/transpiler/markdown/markdown-transpiler-base.js +23 -23
  135. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +6 -6
  136. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +13 -13
  137. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
  138. package/lib/transpiler/openapi/open-api-docs-processor.js +74 -74
  139. package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
  140. package/lib/transpiler/openapi/parsers/Builder.js +29 -29
  141. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
  142. package/lib/transpiler/openapi/parsers/MethodParser.js +166 -166
  143. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -7
  144. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +10 -10
  145. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -39
  146. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +225 -225
  147. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -10
  148. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +19 -19
  149. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -7
  150. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +21 -21
  151. package/lib/transpiler/processor-type-transpiler.d.ts +10 -10
  152. package/lib/transpiler/processor-type-transpiler.js +8 -8
  153. package/lib/transpiler/transpiler.d.ts +5 -5
  154. package/lib/transpiler/transpiler.js +26 -26
  155. package/lib/util/error-logger.d.ts +8 -8
  156. package/lib/util/error-logger.js +89 -89
  157. package/lib/util/logger.d.ts +21 -21
  158. package/lib/util/logger.js +57 -57
  159. package/lib/util/string-utils.d.ts +2 -2
  160. package/lib/util/string-utils.js +14 -14
  161. package/package.json +78 -78
  162. package/tsconfig.json +20 -20
  163. package/tslint.json +5 -5
@@ -1,27 +1,27 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const settings_1 = require("../settings");
4
- const state_1 = require("../service/state");
5
- class Transpiler {
6
- static generate(types, processor) {
7
- var _a, _b;
8
- const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
9
- if (apexTypeA.name < apexTypeB.name)
10
- return -1;
11
- if (apexTypeA.name > apexTypeB.name)
12
- return 1;
13
- return 0;
14
- });
15
- (_a = processor.onBeforeProcess) === null || _a === void 0 ? void 0 : _a.call(processor, sortedTypes);
16
- if (settings_1.Settings.getInstance().indexOnly) {
17
- return;
18
- }
19
- sortedTypes.forEach((currentType) => {
20
- state_1.default.getInstance().setTypeBeingProcessed(currentType);
21
- processor.onProcess(currentType);
22
- });
23
- (_b = processor.onAfterProcess) === null || _b === void 0 ? void 0 : _b.call(processor, sortedTypes);
24
- }
25
- }
26
- exports.default = Transpiler;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const settings_1 = require("../settings");
4
+ const state_1 = require("../service/state");
5
+ class Transpiler {
6
+ static generate(types, processor) {
7
+ var _a, _b;
8
+ const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
9
+ if (apexTypeA.name < apexTypeB.name)
10
+ return -1;
11
+ if (apexTypeA.name > apexTypeB.name)
12
+ return 1;
13
+ return 0;
14
+ });
15
+ (_a = processor.onBeforeProcess) === null || _a === void 0 ? void 0 : _a.call(processor, sortedTypes);
16
+ if (settings_1.Settings.getInstance().indexOnly) {
17
+ return;
18
+ }
19
+ sortedTypes.forEach((currentType) => {
20
+ state_1.default.getInstance().setTypeBeingProcessed(currentType);
21
+ processor.onProcess(currentType);
22
+ });
23
+ (_b = processor.onAfterProcess) === null || _b === void 0 ? void 0 : _b.call(processor, sortedTypes);
24
+ }
25
+ }
26
+ exports.default = Transpiler;
27
27
  //# sourceMappingURL=transpiler.js.map
@@ -1,8 +1,8 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- export default class ErrorLogger {
3
- static logErrors(types: Type[]): void;
4
- private static logErrorsForSingleType;
5
- private static logTypeErrors;
6
- private static logErrorsForClass;
7
- private static logErrorsForInterface;
8
- }
1
+ import { Type } from '@cparra/apex-reflection';
2
+ export default class ErrorLogger {
3
+ static logErrors(types: Type[]): void;
4
+ private static logErrorsForSingleType;
5
+ private static logTypeErrors;
6
+ private static logErrorsForClass;
7
+ private static logErrorsForInterface;
8
+ }
@@ -1,90 +1,90 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const logger_1 = require("./logger");
4
- class ErrorLogger {
5
- static logErrors(types) {
6
- types.forEach((currentType) => {
7
- this.logErrorsForSingleType(currentType);
8
- });
9
- }
10
- static logErrorsForSingleType(currentType, parentType) {
11
- this.logTypeErrors(currentType);
12
- if (currentType.type_name === 'class') {
13
- this.logErrorsForClass(currentType);
14
- }
15
- else if (currentType.type_name === 'interface') {
16
- this.logErrorsForInterface(currentType);
17
- }
18
- }
19
- static logTypeErrors(currentType, parentType) {
20
- var _a;
21
- if ((_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.error) {
22
- const typeName = parentType ? `${parentType.name}.${currentType.name}` : currentType.name;
23
- logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
24
- logger_1.Logger.error(`Comment:\n ${currentType.docComment.rawDeclaration}`);
25
- logger_1.Logger.error(currentType.docComment.error);
26
- logger_1.Logger.error('=================================');
27
- }
28
- }
29
- static logErrorsForClass(classMirror, parentType) {
30
- const typeName = parentType ? `${parentType.name}.${classMirror.name}` : classMirror.name;
31
- classMirror.constructors.forEach((currentConstructor) => {
32
- var _a;
33
- if ((_a = currentConstructor.docComment) === null || _a === void 0 ? void 0 : _a.error) {
34
- logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Constructor`);
35
- logger_1.Logger.error(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
36
- logger_1.Logger.error(currentConstructor.docComment.error);
37
- logger_1.Logger.error('=================================');
38
- }
39
- });
40
- classMirror.fields.forEach((currentField) => {
41
- var _a;
42
- if ((_a = currentField.docComment) === null || _a === void 0 ? void 0 : _a.error) {
43
- logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Field`);
44
- logger_1.Logger.error(`Comment:\n ${currentField.docComment.rawDeclaration}`);
45
- logger_1.Logger.error(currentField.docComment.error);
46
- logger_1.Logger.error('=================================');
47
- }
48
- });
49
- classMirror.properties.forEach((currentProperty) => {
50
- var _a;
51
- if ((_a = currentProperty.docComment) === null || _a === void 0 ? void 0 : _a.error) {
52
- logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Property`);
53
- logger_1.Logger.error(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
54
- logger_1.Logger.error(currentProperty.docComment.error);
55
- logger_1.Logger.error('=================================');
56
- }
57
- });
58
- classMirror.methods.forEach((currentMethod) => {
59
- var _a;
60
- if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.error) {
61
- logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
62
- logger_1.Logger.error(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
63
- logger_1.Logger.error(currentMethod.docComment.error);
64
- logger_1.Logger.error('=================================');
65
- }
66
- });
67
- classMirror.enums.forEach((currentEnum) => {
68
- this.logErrorsForSingleType(currentEnum, classMirror);
69
- });
70
- classMirror.interfaces.forEach((currentInterface) => {
71
- this.logErrorsForSingleType(currentInterface, classMirror);
72
- });
73
- classMirror.classes.forEach((currentClass) => {
74
- this.logErrorsForSingleType(currentClass, classMirror);
75
- });
76
- }
77
- static logErrorsForInterface(interfaceMirror) {
78
- interfaceMirror.methods.forEach((currentMethod) => {
79
- var _a;
80
- if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.error) {
81
- logger_1.Logger.error(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
82
- logger_1.Logger.error(`Comment: ${currentMethod.docComment.rawDeclaration}`);
83
- logger_1.Logger.error(currentMethod.docComment.error);
84
- logger_1.Logger.error('=================================');
85
- }
86
- });
87
- }
88
- }
89
- exports.default = ErrorLogger;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const logger_1 = require("./logger");
4
+ class ErrorLogger {
5
+ static logErrors(types) {
6
+ types.forEach((currentType) => {
7
+ this.logErrorsForSingleType(currentType);
8
+ });
9
+ }
10
+ static logErrorsForSingleType(currentType, parentType) {
11
+ this.logTypeErrors(currentType);
12
+ if (currentType.type_name === 'class') {
13
+ this.logErrorsForClass(currentType);
14
+ }
15
+ else if (currentType.type_name === 'interface') {
16
+ this.logErrorsForInterface(currentType);
17
+ }
18
+ }
19
+ static logTypeErrors(currentType, parentType) {
20
+ var _a;
21
+ if ((_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.error) {
22
+ const typeName = parentType ? `${parentType.name}.${currentType.name}` : currentType.name;
23
+ logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
24
+ logger_1.Logger.error(`Comment:\n ${currentType.docComment.rawDeclaration}`);
25
+ logger_1.Logger.error(currentType.docComment.error);
26
+ logger_1.Logger.error('=================================');
27
+ }
28
+ }
29
+ static logErrorsForClass(classMirror, parentType) {
30
+ const typeName = parentType ? `${parentType.name}.${classMirror.name}` : classMirror.name;
31
+ classMirror.constructors.forEach((currentConstructor) => {
32
+ var _a;
33
+ if ((_a = currentConstructor.docComment) === null || _a === void 0 ? void 0 : _a.error) {
34
+ logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Constructor`);
35
+ logger_1.Logger.error(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
36
+ logger_1.Logger.error(currentConstructor.docComment.error);
37
+ logger_1.Logger.error('=================================');
38
+ }
39
+ });
40
+ classMirror.fields.forEach((currentField) => {
41
+ var _a;
42
+ if ((_a = currentField.docComment) === null || _a === void 0 ? void 0 : _a.error) {
43
+ logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Field`);
44
+ logger_1.Logger.error(`Comment:\n ${currentField.docComment.rawDeclaration}`);
45
+ logger_1.Logger.error(currentField.docComment.error);
46
+ logger_1.Logger.error('=================================');
47
+ }
48
+ });
49
+ classMirror.properties.forEach((currentProperty) => {
50
+ var _a;
51
+ if ((_a = currentProperty.docComment) === null || _a === void 0 ? void 0 : _a.error) {
52
+ logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Property`);
53
+ logger_1.Logger.error(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
54
+ logger_1.Logger.error(currentProperty.docComment.error);
55
+ logger_1.Logger.error('=================================');
56
+ }
57
+ });
58
+ classMirror.methods.forEach((currentMethod) => {
59
+ var _a;
60
+ if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.error) {
61
+ logger_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
62
+ logger_1.Logger.error(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
63
+ logger_1.Logger.error(currentMethod.docComment.error);
64
+ logger_1.Logger.error('=================================');
65
+ }
66
+ });
67
+ classMirror.enums.forEach((currentEnum) => {
68
+ this.logErrorsForSingleType(currentEnum, classMirror);
69
+ });
70
+ classMirror.interfaces.forEach((currentInterface) => {
71
+ this.logErrorsForSingleType(currentInterface, classMirror);
72
+ });
73
+ classMirror.classes.forEach((currentClass) => {
74
+ this.logErrorsForSingleType(currentClass, classMirror);
75
+ });
76
+ }
77
+ static logErrorsForInterface(interfaceMirror) {
78
+ interfaceMirror.methods.forEach((currentMethod) => {
79
+ var _a;
80
+ if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.error) {
81
+ logger_1.Logger.error(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
82
+ logger_1.Logger.error(`Comment: ${currentMethod.docComment.rawDeclaration}`);
83
+ logger_1.Logger.error(currentMethod.docComment.error);
84
+ logger_1.Logger.error('=================================');
85
+ }
86
+ });
87
+ }
88
+ }
89
+ exports.default = ErrorLogger;
90
90
  //# sourceMappingURL=error-logger.js.map
@@ -1,21 +1,21 @@
1
- /**
2
- * Logs messages to the console.
3
- */
4
- export declare class Logger {
5
- static currentFrame: number;
6
- static frames: string[];
7
- /**
8
- * Logs a message with optional arguments.
9
- * @param message The message to log.
10
- * @param args Optional arguments.
11
- */
12
- static log(message: string, ...args: string[]): void;
13
- /**
14
- * Logs an error message with optional arguments.
15
- * @param message The error message to log.
16
- * @param args Optional arguments.
17
- */
18
- static error(message: string, ...args: string[]): void;
19
- static logSingle(text: string, showSpinner?: boolean, color?: 'green' | 'red', overrideConsole?: boolean): void;
20
- static clear(): void;
21
- }
1
+ /**
2
+ * Logs messages to the console.
3
+ */
4
+ export declare class Logger {
5
+ static currentFrame: number;
6
+ static frames: string[];
7
+ /**
8
+ * Logs a message with optional arguments.
9
+ * @param message The message to log.
10
+ * @param args Optional arguments.
11
+ */
12
+ static log(message: string, ...args: string[]): void;
13
+ /**
14
+ * Logs an error message with optional arguments.
15
+ * @param message The error message to log.
16
+ * @param args Optional arguments.
17
+ */
18
+ static error(message: string, ...args: string[]): void;
19
+ static logSingle(text: string, showSpinner?: boolean, color?: 'green' | 'red', overrideConsole?: boolean): void;
20
+ static clear(): void;
21
+ }
@@ -1,58 +1,58 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Logger = void 0;
4
- const chalk = require("chalk");
5
- const logUpdate = require("log-update");
6
- /**
7
- * Logs messages to the console.
8
- */
9
- class Logger {
10
- /**
11
- * Logs a message with optional arguments.
12
- * @param message The message to log.
13
- * @param args Optional arguments.
14
- */
15
- static log(message, ...args) {
16
- this.logSingle(message);
17
- args.forEach((arg) => {
18
- this.logSingle(arg);
19
- });
20
- }
21
- /**
22
- * Logs an error message with optional arguments.
23
- * @param message The error message to log.
24
- * @param args Optional arguments.
25
- */
26
- static error(message, ...args) {
27
- this.logSingle(message, false, 'red', false);
28
- args.forEach((arg) => {
29
- this.logSingle(message, false, 'red', false);
30
- });
31
- }
32
- static logSingle(text, showSpinner = true, color = 'green', overrideConsole = true) {
33
- if (this.currentFrame > 9) {
34
- this.currentFrame = 0;
35
- }
36
- const spinner = showSpinner ? `${this.frames[this.currentFrame++]}` : '';
37
- let logMessage;
38
- if (color === 'green') {
39
- logMessage = `${chalk.green(new Date().toLocaleString() + ': ')}${text}\n`;
40
- }
41
- else {
42
- logMessage = `${chalk.red(new Date().toLocaleString() + ': ')}${text}\n`;
43
- }
44
- if (overrideConsole) {
45
- logUpdate(`${spinner} ${logMessage}`);
46
- }
47
- else {
48
- process.stdout.write(`${spinner} ${logMessage}`);
49
- }
50
- }
51
- static clear() {
52
- logUpdate.clear();
53
- }
54
- }
55
- exports.Logger = Logger;
56
- Logger.currentFrame = -1;
57
- Logger.frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Logger = void 0;
4
+ const chalk = require("chalk");
5
+ const logUpdate = require("log-update");
6
+ /**
7
+ * Logs messages to the console.
8
+ */
9
+ class Logger {
10
+ /**
11
+ * Logs a message with optional arguments.
12
+ * @param message The message to log.
13
+ * @param args Optional arguments.
14
+ */
15
+ static log(message, ...args) {
16
+ this.logSingle(message);
17
+ args.forEach((arg) => {
18
+ this.logSingle(arg);
19
+ });
20
+ }
21
+ /**
22
+ * Logs an error message with optional arguments.
23
+ * @param message The error message to log.
24
+ * @param args Optional arguments.
25
+ */
26
+ static error(message, ...args) {
27
+ this.logSingle(message, false, 'red', false);
28
+ args.forEach((arg) => {
29
+ this.logSingle(message, false, 'red', false);
30
+ });
31
+ }
32
+ static logSingle(text, showSpinner = true, color = 'green', overrideConsole = true) {
33
+ if (this.currentFrame > 9) {
34
+ this.currentFrame = 0;
35
+ }
36
+ const spinner = showSpinner ? `${this.frames[this.currentFrame++]}` : '';
37
+ let logMessage;
38
+ if (color === 'green') {
39
+ logMessage = `${chalk.green(new Date().toLocaleString() + ': ')}${text}\n`;
40
+ }
41
+ else {
42
+ logMessage = `${chalk.red(new Date().toLocaleString() + ': ')}${text}\n`;
43
+ }
44
+ if (overrideConsole) {
45
+ logUpdate(`${spinner} ${logMessage}`);
46
+ }
47
+ else {
48
+ process.stdout.write(`${spinner} ${logMessage}`);
49
+ }
50
+ }
51
+ static clear() {
52
+ logUpdate.clear();
53
+ }
54
+ }
55
+ exports.Logger = Logger;
56
+ Logger.currentFrame = -1;
57
+ Logger.frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
58
58
  //# sourceMappingURL=logger.js.map
@@ -1,2 +1,2 @@
1
- export declare function truncate(str: string, n: number): string;
2
- export declare const camel2title: (camelCase: string) => string;
1
+ export declare function truncate(str: string, n: number): string;
2
+ export declare const camel2title: (camelCase: string) => string;
@@ -1,15 +1,15 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.camel2title = exports.truncate = void 0;
4
- function truncate(str, n) {
5
- return str.length > n ? str.substr(0, n - 1) + '&hellip;' : str;
6
- }
7
- exports.truncate = truncate;
8
- const camel2title = (camelCase) => camelCase
9
- .replace(/\//g, ' ')
10
- .replace(/([A-Z])/g, (match) => ` ${match}`)
11
- .replace(/\b\w/g, (match) => match.toUpperCase())
12
- .replace(/^./, (match) => match.toUpperCase())
13
- .trim();
14
- exports.camel2title = camel2title;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.camel2title = exports.truncate = void 0;
4
+ function truncate(str, n) {
5
+ return str.length > n ? str.substr(0, n - 1) + '&hellip;' : str;
6
+ }
7
+ exports.truncate = truncate;
8
+ const camel2title = (camelCase) => camelCase
9
+ .replace(/\//g, ' ')
10
+ .replace(/([A-Z])/g, (match) => ` ${match}`)
11
+ .replace(/\b\w/g, (match) => match.toUpperCase())
12
+ .replace(/^./, (match) => match.toUpperCase())
13
+ .trim();
14
+ exports.camel2title = camel2title;
15
15
  //# sourceMappingURL=string-utils.js.map
package/package.json CHANGED
@@ -1,78 +1,78 @@
1
- {
2
- "name": "@cparra/apexdocs",
3
- "version": "2.23.0",
4
- "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
- "keywords": [
6
- "apex",
7
- "salesforce",
8
- "documentation",
9
- "cli",
10
- "apex-docs",
11
- "docs"
12
- ],
13
- "main": "lib/index.js",
14
- "bin": {
15
- "apexdocs-generate": "lib/cli/generate.js"
16
- },
17
- "types": "lib/index.d.ts",
18
- "scripts": {
19
- "test": "jest --coverage",
20
- "build": "rimraf ./lib && npm run lint && tsc --declaration",
21
- "lint": "eslint './src/**/*.{js,ts}' --quiet --fix",
22
- "prepare": "npm run build",
23
- "version": "npm run format && git add -A src",
24
- "postversion": "git push && git push --tags",
25
- "docs:init": "docsify init docs",
26
- "docs:serve": "docsify serve docs",
27
- "execute:example": "rimraf ./docs/types && node lib/cli/generate.js -s examples/force-app -t docs/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
28
- "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
29
- "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
30
- },
31
- "author": "Cesar Parra",
32
- "license": "MIT",
33
- "repository": {
34
- "type": "git",
35
- "url": "https://github.com/cesarParra/apexdocs"
36
- },
37
- "devDependencies": {
38
- "@types/html-entities": "^1.3.4",
39
- "@types/jest": "^27.4.1",
40
- "@types/js-yaml": "^4.0.5",
41
- "@types/node": "^13.7.4",
42
- "@types/shelljs": "^0.8.6",
43
- "@types/yargs": "^15.0.3",
44
- "@typescript-eslint/eslint-plugin": "^5.41.0",
45
- "@typescript-eslint/parser": "^5.41.0",
46
- "docsify": "^4.13.0",
47
- "eslint": "^8.0.1",
48
- "eslint-config-prettier": "^8.3.0",
49
- "eslint-plugin-prettier": "^4.0.0",
50
- "husky": "^8.0.3",
51
- "jest": "^27.5.1",
52
- "lint-staged": "^13.2.1",
53
- "prettier": "^2.4.1",
54
- "rimraf": "^3.0.2",
55
- "ts-jest": "^27.1.3",
56
- "typescript": "^4.8.4"
57
- },
58
- "husky": {
59
- "hooks": {
60
- "pre-commit": "lint-staged"
61
- }
62
- },
63
- "lint-staged": {
64
- "*.{js,ts,tsx}": [
65
- "eslint --fix"
66
- ]
67
- },
68
- "dependencies": {
69
- "@cparra/apex-reflection": "2.7.0",
70
- "chalk": "^4.1.2",
71
- "cosmiconfig": "^9.0.0",
72
- "fast-xml-parser": "^4.0.1",
73
- "js-yaml": "^4.1.0",
74
- "log-update": "4.0.0",
75
- "xss": "^1.0.11",
76
- "yargs": "^16.0.3"
77
- }
78
- }
1
+ {
2
+ "name": "@cparra/apexdocs",
3
+ "version": "2.24.0",
4
+ "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
+ "keywords": [
6
+ "apex",
7
+ "salesforce",
8
+ "documentation",
9
+ "cli",
10
+ "apex-docs",
11
+ "docs"
12
+ ],
13
+ "main": "lib/index.js",
14
+ "bin": {
15
+ "apexdocs-generate": "lib/cli/generate.js"
16
+ },
17
+ "types": "lib/index.d.ts",
18
+ "scripts": {
19
+ "test": "jest --coverage",
20
+ "build": "rimraf ./lib && npm run lint && tsc --declaration",
21
+ "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
22
+ "prepare": "npm run build",
23
+ "version": "npm run format && git add -A src",
24
+ "postversion": "git push && git push --tags",
25
+ "docs:init": "docsify init docs",
26
+ "docs:serve": "docsify serve docs",
27
+ "execute:example": "rimraf ./docs/types && node lib/cli/generate.js -s examples/force-app -t docs/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
28
+ "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
29
+ "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
30
+ },
31
+ "author": "Cesar Parra",
32
+ "license": "MIT",
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/cesarParra/apexdocs"
36
+ },
37
+ "devDependencies": {
38
+ "@types/html-entities": "^1.3.4",
39
+ "@types/jest": "^27.4.1",
40
+ "@types/js-yaml": "^4.0.5",
41
+ "@types/node": "^13.7.4",
42
+ "@types/shelljs": "^0.8.6",
43
+ "@types/yargs": "^15.0.3",
44
+ "@typescript-eslint/eslint-plugin": "^5.41.0",
45
+ "@typescript-eslint/parser": "^5.41.0",
46
+ "docsify": "^4.13.0",
47
+ "eslint": "^8.0.1",
48
+ "eslint-config-prettier": "^8.3.0",
49
+ "eslint-plugin-prettier": "^4.0.0",
50
+ "husky": "^8.0.3",
51
+ "jest": "^27.5.1",
52
+ "lint-staged": "^13.2.1",
53
+ "prettier": "^2.4.1",
54
+ "rimraf": "^3.0.2",
55
+ "ts-jest": "^27.1.3",
56
+ "typescript": "^4.8.4"
57
+ },
58
+ "husky": {
59
+ "hooks": {
60
+ "pre-commit": "lint-staged"
61
+ }
62
+ },
63
+ "lint-staged": {
64
+ "*.{js,ts,tsx}": [
65
+ "eslint --fix"
66
+ ]
67
+ },
68
+ "dependencies": {
69
+ "@cparra/apex-reflection": "2.8.0",
70
+ "chalk": "^4.1.2",
71
+ "cosmiconfig": "^9.0.0",
72
+ "fast-xml-parser": "^4.0.1",
73
+ "js-yaml": "^4.1.0",
74
+ "log-update": "4.0.0",
75
+ "xss": "^1.0.11",
76
+ "yargs": "^16.0.3"
77
+ }
78
+ }
package/tsconfig.json CHANGED
@@ -1,20 +1,20 @@
1
- {
2
- "compilerOptions": {
3
- "target": "es6",
4
- "module": "commonjs",
5
- "declaration": true,
6
- "outDir": "./lib",
7
- "strict": true,
8
- "sourceMap": true,
9
- "lib": [
10
- "ES2021"
11
- ]
12
- },
13
- "include": [
14
- "src"
15
- ],
16
- "exclude": [
17
- "node_modules",
18
- "**/__tests__/*"
19
- ]
20
- }
1
+ {
2
+ "compilerOptions": {
3
+ "target": "es6",
4
+ "module": "commonjs",
5
+ "declaration": true,
6
+ "outDir": "./lib",
7
+ "strict": true,
8
+ "sourceMap": true,
9
+ "lib": [
10
+ "ES2021"
11
+ ]
12
+ },
13
+ "include": [
14
+ "src"
15
+ ],
16
+ "exclude": [
17
+ "node_modules",
18
+ "**/__tests__/*"
19
+ ]
20
+ }