@cparra/apexdocs 1.13.4 → 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 (174) hide show
  1. package/README.md +277 -277
  2. package/docs/Gemfile.lock +1 -1
  3. package/docs/Sample-Classes/SampleClass.md +115 -30
  4. package/docs/Sample-Classes/SampleClass2.md +115 -0
  5. package/docs/Sample-Interfaces/SampleInterface.md +32 -13
  6. package/docs/index.md +27 -20
  7. package/docs/single-file/Sample-Classes/SampleClass.md +115 -0
  8. package/examples/apex/SampleClass.cls +13 -5
  9. package/examples/apex/SampleClass2.cls +96 -0
  10. package/examples/apex/SampleInterface.cls +3 -1
  11. package/lib/AsJsDocsProcessor.d.ts +1 -1
  12. package/lib/ClassFileGeneratorHelper.d.ts +2 -2
  13. package/lib/ClassFileGeneratorHelper.js +8 -3
  14. package/lib/ClassFileGeneratorHelper.test.js +1 -1
  15. package/lib/{command → Command}/Generate.d.ts +1 -1
  16. package/lib/{command → Command}/Generate.js +1 -1
  17. package/lib/{command → Command}/__test__/Generte.test.d.ts +0 -0
  18. package/lib/{command → Command}/__test__/Generte.test.js +2 -2
  19. package/lib/DocsProcessor.d.ts +2 -1
  20. package/lib/DocsProcessor.js +3 -0
  21. package/lib/FileManager.d.ts +1 -1
  22. package/lib/JekyllDocsProcessor.d.ts +1 -0
  23. package/lib/JekyllDocsProcessor.js +3 -0
  24. package/lib/MarkdownDocsProcessor.d.ts +1 -1
  25. package/lib/MarkdownDocsProcessor.js +7 -5
  26. package/lib/MarkdownHelper.d.ts +1 -1
  27. package/lib/MarkdownHelper.js +2 -2
  28. package/lib/{parser → Parser}/ClassParser.d.ts +1 -1
  29. package/lib/{parser → Parser}/ClassParser.js +6 -2
  30. package/lib/{parser → Parser}/EnumParser.d.ts +1 -1
  31. package/lib/{parser → Parser}/EnumParser.js +1 -1
  32. package/lib/{parser → Parser}/FileParser.d.ts +1 -1
  33. package/lib/{parser → Parser}/FileParser.js +1 -0
  34. package/lib/{parser → Parser}/MethodParser.d.ts +1 -1
  35. package/lib/{parser → Parser}/MethodParser.js +1 -1
  36. package/lib/{parser → Parser}/PropertyParser.d.ts +1 -1
  37. package/lib/{parser → Parser}/PropertyParser.js +1 -1
  38. package/lib/{parser → Parser}/__test__/ClassParser.test.d.ts +0 -0
  39. package/lib/{parser → Parser}/__test__/ClassParser.test.js +0 -0
  40. package/lib/{parser → Parser}/__test__/FileParser.test.d.ts +0 -0
  41. package/lib/{parser → Parser}/__test__/FileParser.test.js +0 -0
  42. package/lib/{parser → Parser}/__test__/MethodParser.test.d.ts +0 -0
  43. package/lib/{parser → Parser}/__test__/MethodParser.test.js +0 -0
  44. package/lib/{parser → Parser}/__test__/PropertyParser.test.d.ts +0 -0
  45. package/lib/{parser → Parser}/__test__/PropertyParser.test.js +0 -0
  46. package/lib/{parser → Parser}/__test__/testFileContents.d.ts +0 -0
  47. package/lib/{parser → Parser}/__test__/testFileContents.js +0 -0
  48. package/lib/application/Apexdocs.d.ts +11 -0
  49. package/lib/application/Apexdocs.js +41 -0
  50. package/lib/application/Apexdocs.js.map +1 -0
  51. package/lib/cli/generate.js +1 -1
  52. package/lib/cli/generate.js.map +1 -0
  53. package/lib/index.d.ts +1 -1
  54. package/lib/index.js +1 -1
  55. package/lib/index.js.map +1 -0
  56. package/lib/model/file.d.ts +10 -0
  57. package/lib/model/file.js +23 -0
  58. package/lib/model/file.js.map +1 -0
  59. package/lib/model/manifest-diff.d.ts +5 -0
  60. package/lib/model/manifest-diff.js +10 -0
  61. package/lib/model/manifest-diff.js.map +1 -0
  62. package/lib/model/manifest.d.ts +22 -0
  63. package/lib/model/manifest.js +42 -0
  64. package/lib/model/manifest.js.map +1 -0
  65. package/lib/model/markdown-file.d.ts +10 -0
  66. package/lib/model/markdown-file.js +52 -0
  67. package/lib/model/markdown-file.js.map +1 -0
  68. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -0
  69. package/lib/model/markdown-generation-util/field-declaration-util.js +33 -0
  70. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -0
  71. package/lib/model/markdown-generation-util/index.d.ts +3 -0
  72. package/lib/model/markdown-generation-util/index.js +9 -0
  73. package/lib/model/markdown-generation-util/index.js.map +1 -0
  74. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +3 -0
  75. package/lib/model/markdown-generation-util/method-declaration-util.js +97 -0
  76. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -0
  77. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -0
  78. package/lib/model/markdown-generation-util/type-declaration-util.js +25 -0
  79. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -0
  80. package/lib/model/markdown-home-file.d.ts +11 -0
  81. package/lib/model/markdown-home-file.js +50 -0
  82. package/lib/model/markdown-home-file.js.map +1 -0
  83. package/lib/model/markdown-type-file.d.ts +17 -0
  84. package/lib/model/markdown-type-file.js +62 -0
  85. package/lib/model/markdown-type-file.js.map +1 -0
  86. package/lib/service/apex-file-reader.d.ts +13 -0
  87. package/lib/service/apex-file-reader.js +39 -0
  88. package/lib/service/apex-file-reader.js.map +1 -0
  89. package/lib/service/file-system.d.ts +12 -0
  90. package/lib/service/file-system.js +21 -0
  91. package/lib/service/file-system.js.map +1 -0
  92. package/lib/service/file-writer.d.ts +4 -0
  93. package/lib/service/file-writer.js +25 -0
  94. package/lib/service/file-writer.js.map +1 -0
  95. package/lib/service/manifest-factory.d.ts +9 -0
  96. package/lib/service/manifest-factory.js +13 -0
  97. package/lib/service/manifest-factory.js.map +1 -0
  98. package/lib/service/parser.d.ts +9 -0
  99. package/lib/service/parser.js +17 -0
  100. package/lib/service/parser.js.map +1 -0
  101. package/lib/service/walkers/class-walker.d.ts +4 -0
  102. package/lib/service/walkers/class-walker.js +32 -0
  103. package/lib/service/walkers/class-walker.js.map +1 -0
  104. package/lib/service/walkers/enum-walker.d.ts +4 -0
  105. package/lib/service/walkers/enum-walker.js +10 -0
  106. package/lib/service/walkers/enum-walker.js.map +1 -0
  107. package/lib/service/walkers/interface-walker.d.ts +4 -0
  108. package/lib/service/walkers/interface-walker.js +14 -0
  109. package/lib/service/walkers/interface-walker.js.map +1 -0
  110. package/lib/service/walkers/walker-factory.d.ts +5 -0
  111. package/lib/service/walkers/walker-factory.js +20 -0
  112. package/lib/service/walkers/walker-factory.js.map +1 -0
  113. package/lib/service/walkers/walker.d.ts +16 -0
  114. package/lib/service/walkers/walker.js +9 -0
  115. package/lib/service/walkers/walker.js.map +1 -0
  116. package/lib/{Settings.d.ts → settings.d.ts} +0 -0
  117. package/lib/{Settings.js → settings.js} +0 -0
  118. package/lib/settings.js.map +1 -0
  119. package/lib/transpiler/file-container.d.ts +6 -0
  120. package/lib/transpiler/file-container.js +15 -0
  121. package/lib/transpiler/file-container.js.map +1 -0
  122. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +6 -0
  123. package/lib/transpiler/markdown/class-file-generatorHelper.js +17 -0
  124. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -0
  125. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +4 -0
  126. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +10 -0
  127. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +1 -0
  128. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +8 -0
  129. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +24 -0
  130. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -0
  131. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -0
  132. package/lib/transpiler/markdown/markdown-transpiler-base.js +23 -0
  133. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -0
  134. package/lib/transpiler/processor-type-transpiler.d.ts +8 -0
  135. package/lib/transpiler/processor-type-transpiler.js +6 -0
  136. package/lib/transpiler/processor-type-transpiler.js.map +1 -0
  137. package/lib/transpiler/transpiler.d.ts +5 -0
  138. package/lib/transpiler/transpiler.js +21 -0
  139. package/lib/transpiler/transpiler.js.map +1 -0
  140. package/lib/util/logger.d.ts +18 -0
  141. package/lib/util/logger.js +32 -0
  142. package/lib/util/logger.js.map +1 -0
  143. package/package.json +70 -68
  144. package/src/AsJsDocsProcessor.ts +1 -1
  145. package/src/ClassFileGeneratorHelper.test.ts +1 -1
  146. package/src/ClassFileGeneratorHelper.ts +12 -3
  147. package/src/{command → Command}/Generate.ts +2 -2
  148. package/src/{command → Command}/__test__/Generte.test.ts +2 -2
  149. package/src/DocsProcessor.ts +7 -1
  150. package/src/DocsifyDocsProcessor.ts +7 -7
  151. package/src/FileManager.ts +1 -1
  152. package/src/JekyllDocsProcessor.ts +4 -0
  153. package/src/MarkdownDocsProcessor.ts +9 -7
  154. package/src/MarkdownHelper.ts +3 -3
  155. package/src/{model → Model}/ApexModel.ts +0 -0
  156. package/src/{model → Model}/ClassModel.ts +0 -0
  157. package/src/{model → Model}/EnumModel.ts +0 -0
  158. package/src/{model → Model}/MethodModel.ts +0 -0
  159. package/src/{model → Model}/PropertyModel.ts +0 -0
  160. package/src/{model → Model}/__test__/ClassModel.test.ts +0 -0
  161. package/src/{model → Model}/__test__/MethodModel.test.ts +0 -0
  162. package/src/{model → Model}/__test__/PropertyModel.test.ts +0 -0
  163. package/src/{parser → Parser}/ClassParser.ts +7 -2
  164. package/src/{parser → Parser}/EnumParser.ts +1 -1
  165. package/src/{parser → Parser}/FileParser.ts +2 -1
  166. package/src/{parser → Parser}/MethodParser.ts +1 -1
  167. package/src/{parser → Parser}/PropertyParser.ts +1 -1
  168. package/src/{parser → Parser}/__test__/ClassParser.test.ts +0 -0
  169. package/src/{parser → Parser}/__test__/FileParser.test.ts +0 -0
  170. package/src/{parser → Parser}/__test__/MethodParser.test.ts +1 -1
  171. package/src/{parser → Parser}/__test__/PropertyParser.test.ts +1 -1
  172. package/src/{parser → Parser}/__test__/testFileContents.ts +0 -0
  173. package/src/cli/generate.ts +1 -1
  174. package/src/index.ts +1 -1
@@ -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
 
@@ -35,7 +35,7 @@ export default class MarkdownHelper {
35
35
  const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
36
36
  this.classes.forEach(classModel => {
37
37
  if (classModel.getClassName() === classNameForMatch) {
38
- text = text.replace(currentMatch, ClassFileGeneratorHelper.getFileLink(classModel));
38
+ text = text.replace(currentMatch, ClassFileGeneratorHelper.getFileLink(classModel, true));
39
39
  }
40
40
  });
41
41
  });
@@ -56,7 +56,7 @@ export default class MarkdownHelper {
56
56
  for (const currentMatch of matches) {
57
57
  this.classes.forEach(classModel => {
58
58
  if (classModel.getClassName() === currentMatch[1]) {
59
- text = text.replace(currentMatch[0], ClassFileGeneratorHelper.getFileLink(classModel));
59
+ text = text.replace(currentMatch[0], ClassFileGeneratorHelper.getFileLink(classModel, true));
60
60
  }
61
61
  });
62
62
  }
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -1,4 +1,5 @@
1
- import ClassModel from '../model/ClassModel';
1
+ import ClassModel from '../Model/ClassModel';
2
+ import * as sanitize from 'sanitize-filename-ts';
2
3
 
3
4
  export default class ClassParser {
4
5
  getClass(strLine: string, lstComments: string[], iLine: number, parent?: ClassModel) {
@@ -40,7 +41,11 @@ export default class ClassParser {
40
41
 
41
42
  idxStart = comment.toLowerCase().indexOf('@group '); // needed to include space to not match group-content.
42
43
  if (idxStart !== -1) {
43
- cModel.setClassGroup(comment.substring(idxStart + 6).trim());
44
+ const group = sanitize.sanitize(comment.substring(idxStart + 6).trim());
45
+ if (group) {
46
+ cModel.setClassGroup(group);
47
+ }
48
+
44
49
  inDescription = false;
45
50
  continue;
46
51
  }
@@ -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
 
@@ -207,6 +207,7 @@ export default class FileParser {
207
207
  }
208
208
 
209
209
  lstComments.splice(0, lstComments.length);
210
+ continue;
210
211
  }
211
212
 
212
213
  return cModelParent ? cModelParent : null;
@@ -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';