@cparra/apexdocs 1.13.7 → 1.13.8

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 (146) hide show
  1. package/docs/single-file/Sample-Classes/SampleClass.md +115 -0
  2. package/lib/AsJsDocsProcessor.d.ts +1 -1
  3. package/lib/ClassFileGeneratorHelper.d.ts +1 -1
  4. package/lib/ClassFileGeneratorHelper.test.js +1 -1
  5. package/lib/{command → Command}/Generate.d.ts +1 -1
  6. package/lib/{command → Command}/Generate.js +1 -1
  7. package/lib/{command → Command}/__test__/Generte.test.d.ts +0 -0
  8. package/lib/{command → Command}/__test__/Generte.test.js +2 -2
  9. package/lib/DocsProcessor.d.ts +1 -1
  10. package/lib/FileManager.d.ts +1 -1
  11. package/lib/MarkdownDocsProcessor.d.ts +1 -1
  12. package/lib/MarkdownHelper.d.ts +1 -1
  13. package/lib/{parser → Parser}/ClassParser.d.ts +1 -1
  14. package/lib/{parser → Parser}/ClassParser.js +1 -1
  15. package/lib/{parser → Parser}/EnumParser.d.ts +1 -1
  16. package/lib/{parser → Parser}/EnumParser.js +1 -1
  17. package/lib/{parser → Parser}/FileParser.d.ts +1 -1
  18. package/lib/{parser → Parser}/FileParser.js +0 -0
  19. package/lib/{parser → Parser}/MethodParser.d.ts +1 -1
  20. package/lib/{parser → Parser}/MethodParser.js +1 -1
  21. package/lib/{parser → Parser}/PropertyParser.d.ts +1 -1
  22. package/lib/{parser → Parser}/PropertyParser.js +1 -1
  23. package/lib/{parser → Parser}/__test__/ClassParser.test.d.ts +0 -0
  24. package/lib/{parser → Parser}/__test__/ClassParser.test.js +0 -0
  25. package/lib/{parser → Parser}/__test__/FileParser.test.d.ts +0 -0
  26. package/lib/{parser → Parser}/__test__/FileParser.test.js +0 -0
  27. package/lib/{parser → Parser}/__test__/MethodParser.test.d.ts +0 -0
  28. package/lib/{parser → Parser}/__test__/MethodParser.test.js +0 -0
  29. package/lib/{parser → Parser}/__test__/PropertyParser.test.d.ts +0 -0
  30. package/lib/{parser → Parser}/__test__/PropertyParser.test.js +0 -0
  31. package/lib/{parser → Parser}/__test__/testFileContents.d.ts +0 -0
  32. package/lib/{parser → Parser}/__test__/testFileContents.js +0 -0
  33. package/lib/application/Apexdocs.d.ts +11 -0
  34. package/lib/application/Apexdocs.js +41 -0
  35. package/lib/application/Apexdocs.js.map +1 -0
  36. package/lib/cli/generate.js +1 -1
  37. package/lib/cli/generate.js.map +1 -0
  38. package/lib/index.d.ts +1 -1
  39. package/lib/index.js +1 -1
  40. package/lib/index.js.map +1 -0
  41. package/lib/model/file.d.ts +10 -0
  42. package/lib/model/file.js +23 -0
  43. package/lib/model/file.js.map +1 -0
  44. package/lib/model/manifest-diff.d.ts +5 -0
  45. package/lib/model/manifest-diff.js +10 -0
  46. package/lib/model/manifest-diff.js.map +1 -0
  47. package/lib/model/manifest.d.ts +22 -0
  48. package/lib/model/manifest.js +42 -0
  49. package/lib/model/manifest.js.map +1 -0
  50. package/lib/model/markdown-file.d.ts +10 -0
  51. package/lib/model/markdown-file.js +52 -0
  52. package/lib/model/markdown-file.js.map +1 -0
  53. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -0
  54. package/lib/model/markdown-generation-util/field-declaration-util.js +33 -0
  55. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -0
  56. package/lib/model/markdown-generation-util/index.d.ts +3 -0
  57. package/lib/model/markdown-generation-util/index.js +9 -0
  58. package/lib/model/markdown-generation-util/index.js.map +1 -0
  59. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +3 -0
  60. package/lib/model/markdown-generation-util/method-declaration-util.js +97 -0
  61. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -0
  62. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -0
  63. package/lib/model/markdown-generation-util/type-declaration-util.js +25 -0
  64. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -0
  65. package/lib/model/markdown-home-file.d.ts +11 -0
  66. package/lib/model/markdown-home-file.js +50 -0
  67. package/lib/model/markdown-home-file.js.map +1 -0
  68. package/lib/model/markdown-type-file.d.ts +17 -0
  69. package/lib/model/markdown-type-file.js +62 -0
  70. package/lib/model/markdown-type-file.js.map +1 -0
  71. package/lib/service/apex-file-reader.d.ts +13 -0
  72. package/lib/service/apex-file-reader.js +39 -0
  73. package/lib/service/apex-file-reader.js.map +1 -0
  74. package/lib/service/file-system.d.ts +12 -0
  75. package/lib/service/file-system.js +21 -0
  76. package/lib/service/file-system.js.map +1 -0
  77. package/lib/service/file-writer.d.ts +4 -0
  78. package/lib/service/file-writer.js +25 -0
  79. package/lib/service/file-writer.js.map +1 -0
  80. package/lib/service/manifest-factory.d.ts +9 -0
  81. package/lib/service/manifest-factory.js +13 -0
  82. package/lib/service/manifest-factory.js.map +1 -0
  83. package/lib/service/parser.d.ts +9 -0
  84. package/lib/service/parser.js +17 -0
  85. package/lib/service/parser.js.map +1 -0
  86. package/lib/service/walkers/class-walker.d.ts +4 -0
  87. package/lib/service/walkers/class-walker.js +32 -0
  88. package/lib/service/walkers/class-walker.js.map +1 -0
  89. package/lib/service/walkers/enum-walker.d.ts +4 -0
  90. package/lib/service/walkers/enum-walker.js +10 -0
  91. package/lib/service/walkers/enum-walker.js.map +1 -0
  92. package/lib/service/walkers/interface-walker.d.ts +4 -0
  93. package/lib/service/walkers/interface-walker.js +14 -0
  94. package/lib/service/walkers/interface-walker.js.map +1 -0
  95. package/lib/service/walkers/walker-factory.d.ts +5 -0
  96. package/lib/service/walkers/walker-factory.js +20 -0
  97. package/lib/service/walkers/walker-factory.js.map +1 -0
  98. package/lib/service/walkers/walker.d.ts +16 -0
  99. package/lib/service/walkers/walker.js +9 -0
  100. package/lib/service/walkers/walker.js.map +1 -0
  101. package/lib/{Settings.d.ts → settings.d.ts} +0 -0
  102. package/lib/{Settings.js → settings.js} +0 -0
  103. package/lib/settings.js.map +1 -0
  104. package/lib/transpiler/file-container.d.ts +6 -0
  105. package/lib/transpiler/file-container.js +15 -0
  106. package/lib/transpiler/file-container.js.map +1 -0
  107. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +6 -0
  108. package/lib/transpiler/markdown/class-file-generatorHelper.js +17 -0
  109. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -0
  110. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +4 -0
  111. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +10 -0
  112. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +1 -0
  113. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +8 -0
  114. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +24 -0
  115. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -0
  116. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -0
  117. package/lib/transpiler/markdown/markdown-transpiler-base.js +23 -0
  118. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -0
  119. package/lib/transpiler/processor-type-transpiler.d.ts +8 -0
  120. package/lib/transpiler/processor-type-transpiler.js +6 -0
  121. package/lib/transpiler/processor-type-transpiler.js.map +1 -0
  122. package/lib/transpiler/transpiler.d.ts +5 -0
  123. package/lib/transpiler/transpiler.js +21 -0
  124. package/lib/transpiler/transpiler.js.map +1 -0
  125. package/lib/util/logger.d.ts +18 -0
  126. package/lib/util/logger.js +32 -0
  127. package/lib/util/logger.js.map +1 -0
  128. package/package.json +1 -1
  129. package/src/AsJsDocsProcessor.ts +1 -1
  130. package/src/ClassFileGeneratorHelper.test.ts +1 -1
  131. package/src/ClassFileGeneratorHelper.ts +1 -1
  132. package/src/Command/Generate.ts +2 -2
  133. package/src/Command/__test__/Generte.test.ts +2 -2
  134. package/src/DocsProcessor.ts +1 -1
  135. package/src/FileManager.ts +1 -1
  136. package/src/MarkdownDocsProcessor.ts +2 -2
  137. package/src/MarkdownHelper.ts +1 -1
  138. package/src/Parser/ClassParser.ts +1 -1
  139. package/src/Parser/EnumParser.ts +1 -1
  140. package/src/Parser/FileParser.ts +1 -1
  141. package/src/Parser/MethodParser.ts +1 -1
  142. package/src/Parser/PropertyParser.ts +1 -1
  143. package/src/Parser/__test__/MethodParser.test.ts +1 -1
  144. package/src/Parser/__test__/PropertyParser.test.ts +1 -1
  145. package/src/cli/generate.ts +1 -1
  146. package/src/index.ts +1 -1
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const class_walker_1 = require("./class-walker");
4
+ const enum_walker_1 = require("./enum-walker");
5
+ const interface_walker_1 = require("./interface-walker");
6
+ class WalkerFactory {
7
+ static get(type) {
8
+ switch (type.type_name) {
9
+ case 'class':
10
+ return new class_walker_1.ClassWalker(type);
11
+ case 'enum':
12
+ return new enum_walker_1.EnumWalker(type);
13
+ case 'interface':
14
+ return new interface_walker_1.InterfaceWalker(type);
15
+ }
16
+ throw Error('Walker not found for type.');
17
+ }
18
+ }
19
+ exports.WalkerFactory = WalkerFactory;
20
+ //# sourceMappingURL=walker-factory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"walker-factory.js","sourceRoot":"","sources":["../../../src/service/walkers/walker-factory.ts"],"names":[],"mappings":";;AAEA,iDAA6C;AAC7C,+CAA2C;AAC3C,yDAAqD;AAErD,MAAa,aAAa;IACxB,MAAM,CAAC,GAAG,CAAC,IAAU;QACnB,QAAQ,IAAI,CAAC,SAAS,EAAE;YACtB,KAAK,OAAO;gBACV,OAAO,IAAI,0BAAW,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,MAAM;gBACT,OAAO,IAAI,wBAAU,CAAC,IAAI,CAAC,CAAC;YAC9B,KAAK,WAAW;gBACd,OAAO,IAAI,kCAAe,CAAC,IAAI,CAAC,CAAC;SACpC;QACD,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC5C,CAAC;CACF;AAZD,sCAYC"}
@@ -0,0 +1,16 @@
1
+ import { ClassMirror, ConstructorMirror, EnumMirror, FieldMirror, InterfaceMirror, MethodMirror, PropertyMirror, Type } from '@cparra/apex-reflection';
2
+ export interface WalkerListener {
3
+ onTypeDeclaration(typeMirror: Type): void;
4
+ onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
5
+ onFieldsDeclaration(fields: FieldMirror[]): void;
6
+ onPropertiesDeclaration(properties: PropertyMirror[]): void;
7
+ onMethodsDeclaration(methods: MethodMirror[]): void;
8
+ onInnerEnumsDeclaration(enums: EnumMirror[]): void;
9
+ onInnerClassesDeclaration(classes: ClassMirror[]): void;
10
+ onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
11
+ }
12
+ export declare abstract class Walker {
13
+ type: Type;
14
+ constructor(type: Type);
15
+ abstract walk(listener: WalkerListener): void;
16
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class Walker {
4
+ constructor(type) {
5
+ this.type = type;
6
+ }
7
+ }
8
+ exports.Walker = Walker;
9
+ //# sourceMappingURL=walker.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"walker.js","sourceRoot":"","sources":["../../../src/service/walkers/walker.ts"],"names":[],"mappings":";;AA8BA,MAAsB,MAAM;IAC1B,YAAmB,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;CAGlC;AAJD,wBAIC"}
File without changes
File without changes
@@ -0,0 +1 @@
1
+ {"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;AACA,4FAAwF;AACxF,iGAAwF;AAYxF,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,cAAc;QAChB,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,OAAO,IAAI,0CAAmB,EAAE,CAAC;YACnC,KAAK,SAAS;gBACZ,OAAO,IAAI,gCAAoB,EAAE,CAAC;YACpC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;CACF;AA1CD,4BA0CC"}
@@ -0,0 +1,6 @@
1
+ import { File } from '../model/file';
2
+ export declare class FileContainer {
3
+ _files: File[];
4
+ files(): File[];
5
+ pushFile(file: File): void;
6
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class FileContainer {
4
+ constructor() {
5
+ this._files = [];
6
+ }
7
+ files() {
8
+ return this._files;
9
+ }
10
+ pushFile(file) {
11
+ this._files.push(file);
12
+ }
13
+ }
14
+ exports.FileContainer = FileContainer;
15
+ //# sourceMappingURL=file-container.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAW,EAAE,CAAC;IAStB,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAU;QACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}
@@ -0,0 +1,6 @@
1
+ import { Type } from '@cparra/apex-reflection';
2
+ export default class ClassFileGeneratorHelper {
3
+ static getSanitizedGroup(classModel: Type): string;
4
+ static getFileLink(classModel: Type): string;
5
+ private static getClassGroup;
6
+ }
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class ClassFileGeneratorHelper {
4
+ static getSanitizedGroup(classModel) {
5
+ return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
6
+ }
7
+ static getFileLink(classModel) {
8
+ return `[${classModel.name}](/${this.getSanitizedGroup(classModel)}/${classModel.name}.md)`;
9
+ }
10
+ static getClassGroup(classModel) {
11
+ var _a, _b;
12
+ const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group');
13
+ return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : 'Misc';
14
+ }
15
+ }
16
+ exports.default = ClassFileGeneratorHelper;
17
+ //# sourceMappingURL=class-file-generatorHelper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AAEA,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,MAAM,CAAC;IAC9F,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC7G,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC;IACzC,CAAC;CACF;AAbD,2CAaC"}
@@ -0,0 +1,4 @@
1
+ import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
+ export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
3
+ homeFileName(): string;
4
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
4
+ class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
5
+ homeFileName() {
6
+ return 'README';
7
+ }
8
+ }
9
+ exports.default = DocsifyDocsProcessor;
10
+ //# sourceMappingURL=docsify-docs-processor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAErE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAJD,uCAIC"}
@@ -0,0 +1,8 @@
1
+ import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
+ import { Type } from '@cparra/apex-reflection';
3
+ export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
4
+ homeFileName(): string;
5
+ onBeforeProcess: (types: Type[]) => void;
6
+ onProcess(type: Type): void;
7
+ get frontMatterHeader(): string;
8
+ }
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
4
+ const markdown_home_file_1 = require("../../../model/markdown-home-file");
5
+ const markdown_type_file_1 = require("../../../model/markdown-type-file");
6
+ class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
7
+ constructor() {
8
+ super(...arguments);
9
+ this.onBeforeProcess = (types) => {
10
+ this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterHeader));
11
+ };
12
+ }
13
+ homeFileName() {
14
+ return 'index';
15
+ }
16
+ onProcess(type) {
17
+ this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.frontMatterHeader));
18
+ }
19
+ get frontMatterHeader() {
20
+ return '---\nlayout: default\n---';
21
+ }
22
+ }
23
+ exports.JekyllDocsProcessor = JekyllDocsProcessor;
24
+ //# sourceMappingURL=jekyll-docsProcessor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC;IASJ,CAAC;IAfC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,2BAA2B,CAAC;IACrC,CAAC;CACF;AAhBD,kDAgBC"}
@@ -0,0 +1,11 @@
1
+ import ProcessorTypeTranspiler from '../processor-type-transpiler';
2
+ import { Type } from '@cparra/apex-reflection';
3
+ import { FileContainer } from '../file-container';
4
+ export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
5
+ protected readonly _fileContainer: FileContainer;
6
+ constructor();
7
+ abstract homeFileName(): string;
8
+ fileBuilder(): FileContainer;
9
+ onBeforeProcess: (types: Type[]) => void;
10
+ onProcess(type: Type): void;
11
+ }
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const processor_type_transpiler_1 = require("../processor-type-transpiler");
4
+ const file_container_1 = require("../file-container");
5
+ const markdown_home_file_1 = require("../../model/markdown-home-file");
6
+ const markdown_type_file_1 = require("../../model/markdown-type-file");
7
+ class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
8
+ constructor() {
9
+ super();
10
+ this.onBeforeProcess = (types) => {
11
+ this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
12
+ };
13
+ this._fileContainer = new file_container_1.FileContainer();
14
+ }
15
+ fileBuilder() {
16
+ return this._fileContainer;
17
+ }
18
+ onProcess(type) {
19
+ this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
20
+ }
21
+ }
22
+ exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
23
+ //# sourceMappingURL=markdown-transpiler-base.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;AAAA,4EAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}
@@ -0,0 +1,8 @@
1
+ import { Type } from '@cparra/apex-reflection';
2
+ import { FileContainer } from './file-container';
3
+ export default abstract class ProcessorTypeTranspiler {
4
+ onBeforeProcess: ((types: Type[]) => void) | undefined;
5
+ abstract onProcess(type: Type): void;
6
+ onAfterProcess: ((types: Type[]) => void) | undefined;
7
+ abstract fileBuilder(): FileContainer;
8
+ }
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class ProcessorTypeTranspiler {
4
+ }
5
+ exports.default = ProcessorTypeTranspiler;
6
+ //# sourceMappingURL=processor-type-transpiler.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAGA,MAA8B,uBAAuB;CAQpD;AARD,0CAQC"}
@@ -0,0 +1,5 @@
1
+ import { Type } from '@cparra/apex-reflection';
2
+ import ProcessorTypeTranspiler from './processor-type-transpiler';
3
+ export default class Transpiler {
4
+ static generate(types: Type[], processor: ProcessorTypeTranspiler): void;
5
+ }
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class Transpiler {
4
+ static generate(types, processor) {
5
+ var _a, _b;
6
+ const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
7
+ if (apexTypeA.name < apexTypeB.name)
8
+ return -1;
9
+ if (apexTypeA.name > apexTypeB.name)
10
+ return 1;
11
+ return 0;
12
+ });
13
+ (_a = processor.onBeforeProcess) === null || _a === void 0 ? void 0 : _a.call(processor, sortedTypes);
14
+ sortedTypes.forEach((currentType) => {
15
+ processor.onProcess(currentType);
16
+ });
17
+ (_b = processor.onAfterProcess) === null || _b === void 0 ? void 0 : _b.call(processor, sortedTypes);
18
+ }
19
+ }
20
+ exports.default = Transpiler;
21
+ //# sourceMappingURL=transpiler.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transpiler.js","sourceRoot":"","sources":["../../src/transpiler/transpiler.ts"],"names":[],"mappings":";;AAGA,MAAqB,UAAU;IAC7B,MAAM,CAAC,QAAQ,CAAC,KAAa,EAAE,SAAkC;;QAC/D,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,MAAA,SAAS,CAAC,eAAe,+CAAzB,SAAS,EAAmB,WAAW,EAAE;QACzC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAClC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAA,SAAS,CAAC,cAAc,+CAAxB,SAAS,EAAkB,WAAW,EAAE;IAC1C,CAAC;CACF;AAdD,6BAcC"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Logs messages to the console.
3
+ */
4
+ export declare class Logger {
5
+ /**
6
+ * Logs a message with optional arguments.
7
+ * @param message The message to log.
8
+ * @param args Optional arguments.
9
+ */
10
+ static log(message: string, ...args: string[]): void;
11
+ /**
12
+ * Logs an error message with optional arguments.
13
+ * @param message The error message to log.
14
+ * @param args Optional arguments.
15
+ */
16
+ static error(message: string, ...args: string[]): void;
17
+ private static logSingle;
18
+ }
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const chalk = require("chalk");
4
+ /**
5
+ * Logs messages to the console.
6
+ */
7
+ class Logger {
8
+ /**
9
+ * Logs a message with optional arguments.
10
+ * @param message The message to log.
11
+ * @param args Optional arguments.
12
+ */
13
+ static log(message, ...args) {
14
+ this.logSingle(message);
15
+ args.forEach((arg) => {
16
+ this.logSingle(arg);
17
+ });
18
+ }
19
+ /**
20
+ * Logs an error message with optional arguments.
21
+ * @param message The error message to log.
22
+ * @param args Optional arguments.
23
+ */
24
+ static error(message, ...args) {
25
+ this.log(`${chalk.red(message)}`, ...args);
26
+ }
27
+ static logSingle(message) {
28
+ process.stdout.write(`${chalk.green(new Date().toLocaleString() + ': ')}${message}\n`);
29
+ }
30
+ }
31
+ exports.Logger = Logger;
32
+ //# sourceMappingURL=logger.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;AAAA,+BAA+B;AAE/B;;GAEG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,OAAe;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;IACzF,CAAC;CACF;AAzBD,wBAyBC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cparra/apexdocs",
3
- "version": "1.13.7",
3
+ "version": "1.13.8",
4
4
  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
5
  "keywords": [
6
6
  "apex",
@@ -3,7 +3,7 @@ import * as path from 'path';
3
3
 
4
4
  import DocsProcessor from './DocsProcessor';
5
5
  import JsHelper from './JsHelper';
6
- import ClassModel from './model/ClassModel';
6
+ import ClassModel from './Model/ClassModel';
7
7
 
8
8
  export default class AsJsDocsProcessor extends DocsProcessor {
9
9
  process(classModel: ClassModel, outputDir: string) {
@@ -1,5 +1,5 @@
1
1
  import ClassFileGeneratorHelper from './ClassFileGeneratorHelper';
2
- import ClassModel from './model/ClassModel';
2
+ import ClassModel from './Model/ClassModel';
3
3
  import Settings from './Settings';
4
4
 
5
5
  test('that getSanitizedGroup returns the same string when there is nothing to sanitize', () => {
@@ -1,4 +1,4 @@
1
- import ClassModel from './model/ClassModel';
1
+ import ClassModel from './Model/ClassModel';
2
2
  import Settings from './Settings';
3
3
  import Configuration from './Configuration';
4
4
  import DocsProcessor from './DocsProcessor';
@@ -2,8 +2,8 @@ import * as fs from 'fs';
2
2
  import * as path from 'path';
3
3
 
4
4
  import Settings from '../Settings';
5
- import ClassModel from '../model/ClassModel';
6
- import FileParser from '../parser/FileParser';
5
+ import ClassModel from '../Model/ClassModel';
6
+ import FileParser from '../Parser/FileParser';
7
7
 
8
8
  import DocsifyDocsProcessor from '../DocsifyDocsProcessor';
9
9
  import JekyllDocsProcessor from '../JekyllDocsProcessor';
@@ -1,9 +1,9 @@
1
1
  import * as fs from 'fs';
2
2
  import { generate } from '../Generate';
3
- import FileParser from '../../parser/FileParser';
3
+ import FileParser from '../../Parser/FileParser';
4
4
 
5
5
  jest.mock('fs');
6
- jest.mock('../../parser/FileParser');
6
+ jest.mock('../../Parser/FileParser');
7
7
 
8
8
  beforeEach(() => {
9
9
  (FileParser as jest.Mock).mockClear();
@@ -1,4 +1,4 @@
1
- import ClassModel from './model/ClassModel';
1
+ import ClassModel from './Model/ClassModel';
2
2
 
3
3
  export default abstract class DocsProcessor {
4
4
  // tslint:disable-next-line:no-empty
@@ -1,5 +1,5 @@
1
1
  import Settings from './Settings';
2
- import ClassModel from './model/ClassModel';
2
+ import ClassModel from './Model/ClassModel';
3
3
 
4
4
  export default class FileManager {
5
5
  classModels: ClassModel[];
@@ -3,10 +3,10 @@ import * as path from 'path';
3
3
 
4
4
  import DocsProcessor from './DocsProcessor';
5
5
  import MarkdownHelper from './MarkdownHelper';
6
- import ClassModel from './model/ClassModel';
6
+ import ClassModel from './Model/ClassModel';
7
7
  import Settings from './Settings';
8
8
  import Configuration from './Configuration';
9
- import MethodModel from './model/MethodModel';
9
+ import MethodModel from './Model/MethodModel';
10
10
  import ClassFileGeneratorHelper from './ClassFileGeneratorHelper';
11
11
 
12
12
  export default abstract class MarkdownDocsProcessor extends DocsProcessor {
@@ -1,6 +1,6 @@
1
1
  import { encode } from 'html-entities';
2
2
 
3
- import ClassModel from './model/ClassModel';
3
+ import ClassModel from './Model/ClassModel';
4
4
  import ClassFileGeneratorHelper from './ClassFileGeneratorHelper';
5
5
  import Configuration from './Configuration';
6
6
 
@@ -1,4 +1,4 @@
1
- import ClassModel from '../model/ClassModel';
1
+ import ClassModel from '../Model/ClassModel';
2
2
  import * as sanitize from 'sanitize-filename-ts';
3
3
 
4
4
  export default class ClassParser {
@@ -1,4 +1,4 @@
1
- import EnumModel from '../model/EnumModel';
1
+ import EnumModel from '../Model/EnumModel';
2
2
 
3
3
  export default class EnumParser {
4
4
  getEnum(strLine: string, lstComments: string[], iLine: number) {
@@ -1,4 +1,4 @@
1
- import ClassModel from '../model/ClassModel';
1
+ import ClassModel from '../Model/ClassModel';
2
2
 
3
3
  import Settings from '../Settings';
4
4
 
@@ -1,4 +1,4 @@
1
- import MethodModel from '../model/MethodModel';
1
+ import MethodModel from '../Model/MethodModel';
2
2
 
3
3
  export default class MethodParser {
4
4
  getMethod(parentClassName: string, strLine: string, lstComments: string[], iLine: number) {
@@ -1,4 +1,4 @@
1
- import PropertyModel from '../model/PropertyModel';
1
+ import PropertyModel from '../Model/PropertyModel';
2
2
 
3
3
  export default class PropertyParser {
4
4
  getProperty(strLine: string, lstComments: string[], iLine: number) {
@@ -1,4 +1,4 @@
1
- import MethoModel from '../../model/MethodModel';
1
+ import MethoModel from '../../Model/MethodModel';
2
2
  import MethodParser from '../MethodParser';
3
3
 
4
4
  const nameLine = 'public static void testMethod() {';
@@ -1,4 +1,4 @@
1
- import MethoModel from '../../model/PropertyModel';
1
+ import MethoModel from '../../Model/PropertyModel';
2
2
  import PropertyParser from '../PropertyParser';
3
3
 
4
4
  const nameLine = 'public String TestPropery { get; set; }';
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env node
2
2
  import * as yargs from 'yargs';
3
3
 
4
- import { generate } from '../command/Generate';
4
+ import { generate } from '../Command/Generate';
5
5
  import FileManager from '../FileManager';
6
6
 
7
7
  const argv = yargs.options({
package/src/index.ts CHANGED
@@ -1 +1 @@
1
- export * from './command/Generate';
1
+ export * from './Command/Generate';