Merge pull request #75 from cesarParra/2.14_rc

2.14 rc

Author: cesarParra

README.md

@@ -129,8 +129,10 @@ The CLI supports the following parameters:
 | --defaultGroupName | N/A   | Defines the `@group` name to be used when a file does not specify it.                                                                                                                                                                                                                                                                                                       | `Miscellaneous` | No       |
 | --sanitizeHtml     | N/A   | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | `Apex REST Api` | No       |
 | --openApiTitle     | N/A   | If using "openapi" as the target generator, this allows you to specify the OpenApi title value.                                                                                                                                                                                                                                                                             | true            | No       |
+| --title            | N/A   | Allows you to specify the home page main title. If using "openapi" this acts as an alias to the openApiTitle parameter                                                                                                                                                                                                                                                      | `Classes`       | No       |
 | --namespace        | N/A   | The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url.                                                                                                                                                                | N/A             | No       |
 | --openApiFileName  | N/A   | If using "openapi" as the target generator, this allows you to specify the name of the output file.                                                                                                                                                                                                                                                                         | `openapi`       | No       |
+| --includeMetadata  | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                                                                                                                                                                                            | false           | No       |
 
 ### Importing to your project
 

docs/Main/nspc.SampleClass.md

@@ -2,10 +2,6 @@
 
 `NAMESPACEACCESSIBLE`
 
-`APIVERSION: 54`
-
-`STATUS: ACTIVE`
-
 This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
              But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
              You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)

package.json

@@ -24,7 +24,7 @@
     "postversion": "git push && git push --tags",
     "docs:init": "docsify init docs",
     "docs:serve": "docsify serve docs",
-    "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc",
+    "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\"",
     "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
     "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
   },

src/cli/generate.ts

@@ -66,6 +66,11 @@ const argv = yargs.options({
     default: 'Apex REST Api',
     describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
   },
+  title: {
+    type: 'string',
+    describe: "If this allows you to specify the title of the generated documentation's home file.",
+    default: 'Classes',
+  },
   namespace: {
     type: 'string',
     describe:
@@ -77,6 +82,11 @@ const argv = yargs.options({
     describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
     default: 'openapi',
   },
+  includeMetadata: {
+    type: 'boolean',
+    describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
+    default: false,
+  },
 }).argv;
 
 Settings.build({
@@ -89,8 +99,10 @@ Settings.build({
   defaultGroupName: argv.defaultGroupName,
   sanitizeHtml: argv.sanitizeHtml,
   openApiTitle: argv.openApiTitle,
+  title: argv.title,
   namespace: argv.namespace,
   openApiFileName: argv.openApiFileName,
+  includeMetadata: argv.includeMetadata,
 });
 
 try {

src/model/markdown-home-file.ts

@@ -10,7 +10,7 @@ export class MarkdownHomeFile extends MarkdownFile {
     if (headerContent) {
       this.addText(headerContent);
     }
-    this.addTitle('Classes');
+    this.addTitle(Settings.getInstance().getTitle());
     this.addTypeEntries(types);
   }
 

src/service/__tests__/apex-file-reader.spec.ts

@@ -13,6 +13,8 @@ describe('File Reader', () => {
       defaultGroupName: 'Misc',
       sanitizeHtml: true,
       openApiFileName: 'openapi',
+      title: 'Classes',
+      includeMetadata: false,
     } as SettingsConfig);
   });
 

src/service/apex-file-reader.ts

@@ -27,7 +27,11 @@ export class ApexFileReader {
 
       const rawApexFile = fileSystem.readFile(currentPath);
       const metadataPath = fileSystem.joinPath(rootPath, `${currentFilePath}-meta.xml`);
-      const rawMetadataFile = fileSystem.exists(metadataPath) ? fileSystem.readFile(metadataPath) : null;
+      let rawMetadataFile = null;
+      if (Settings.getInstance().includeMetadata()) {
+        rawMetadataFile = fileSystem.exists(metadataPath) ? fileSystem.readFile(metadataPath) : null;
+      }
+
       bundles.push(new ApexBundle(currentFilePath, rawApexFile, rawMetadataFile));
     });
     return bundles;

src/service/parser.ts

@@ -1,12 +1,4 @@
-import {
-  Type,
-  ReflectionResult,
-  ClassMirror,
-  FieldMirror,
-  PropertyMirror,
-  MethodMirror,
-  InterfaceMirror,
-} from '@cparra/apex-reflection';
+import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
 import ApexBundle from '../model/apex-bundle';
 import MetadataProcessor from './metadata-processor';
 import { Logger } from '../util/logger';
@@ -30,7 +22,7 @@ export class RawBodyParser implements TypeParser {
           const metadataParams = MetadataProcessor.process(currentBundle.rawMetadataContent);
           metadataParams.forEach((value, key) => {
             const declaration = `${key}: ${value}`;
-            result.typeMirror!.annotations.push({
+            result.typeMirror?.annotations.push({
               rawDeclaration: declaration,
               name: declaration,
               type: declaration,
@@ -42,6 +34,7 @@ export class RawBodyParser implements TypeParser {
       .filter((reflectionResult) => {
         return reflectionResult.typeMirror;
       })
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       .map((reflectionResult) => reflectionResult.typeMirror!);
 
     return this.addFieldsFromParent(types);
@@ -76,7 +69,6 @@ export class RawBodyParser implements TypeParser {
 
       typeAsInterface = this.addMethodsFromParent(typeAsInterface, types);
       typesWithFields.push(typeAsInterface);
-      continue;
     }
 
     return typesWithFields;
@@ -131,45 +123,48 @@ export class RawBodyParser implements TypeParser {
   }
 
   private getInheritedFields(parentAsClass: ClassMirror, currentClass: ClassMirror) {
-    const parentFields = parentAsClass.fields
-      // Filter out private fields
-      .filter((currentField) => currentField.access_modifier.toLowerCase() !== 'private')
-      // Filter out fields that also exist on the child
-      .filter((currentField) => !this.memberExists(currentClass.fields, currentField.name))
-      .map((currentField) => ({
-        ...currentField,
-        inherited: true,
-      }));
-    return parentFields;
+    return (
+      parentAsClass.fields
+        // Filter out private fields
+        .filter((currentField) => currentField.access_modifier.toLowerCase() !== 'private')
+        // Filter out fields that also exist on the child
+        .filter((currentField) => !this.memberExists(currentClass.fields, currentField.name))
+        .map((currentField) => ({
+          ...currentField,
+          inherited: true,
+        }))
+    );
   }
 
   private getInheritedProperties(parentAsClass: ClassMirror, currentClass: ClassMirror) {
-    const parentProperties = parentAsClass.properties
-      // Filter out private properties
-      .filter((currentProperty) => currentProperty.access_modifier.toLowerCase() !== 'private')
-      // Filter out properties that also exist on the child
-      .filter((currentProperty) => !this.memberExists(currentClass.properties, currentProperty.name))
-      .map((currentProperty) => ({
-        ...currentProperty,
-        inherited: true,
-      }));
-    return parentProperties;
+    return (
+      parentAsClass.properties
+        // Filter out private properties
+        .filter((currentProperty) => currentProperty.access_modifier.toLowerCase() !== 'private')
+        // Filter out properties that also exist on the child
+        .filter((currentProperty) => !this.memberExists(currentClass.properties, currentProperty.name))
+        .map((currentProperty) => ({
+          ...currentProperty,
+          inherited: true,
+        }))
+    );
   }
 
   private getInheritedMethods(
     parentAsClass: ClassMirror | InterfaceMirror,
     currentClass: ClassMirror | InterfaceMirror,
   ) {
-    const parentMethods = parentAsClass.methods
-      // Filter out private methods
-      .filter((currentMethod) => currentMethod.access_modifier.toLowerCase() !== 'private')
-      // Filter out methods that also exist on the child
-      .filter((currentMethod) => !this.memberExists(currentClass.methods, currentMethod.name))
-      .map((currentMethod) => ({
-        ...currentMethod,
-        inherited: true,
-      }));
-    return parentMethods;
+    return (
+      parentAsClass.methods
+        // Filter out private methods
+        .filter((currentMethod) => currentMethod.access_modifier.toLowerCase() !== 'private')
+        // Filter out methods that also exist on the child
+        .filter((currentMethod) => !this.memberExists(currentClass.methods, currentMethod.name))
+        .map((currentMethod) => ({
+          ...currentMethod,
+          inherited: true,
+        }))
+    );
   }
 
   memberExists(members: NameAware[], fieldName: string): boolean {

src/settings.ts

@@ -10,8 +10,10 @@ export interface SettingsConfig {
   defaultGroupName: string;
   sanitizeHtml: boolean;
   openApiTitle?: string;
+  title: string;
   namespace?: string;
   openApiFileName: string;
+  includeMetadata: boolean;
 }
 
 export class Settings {
@@ -63,7 +65,11 @@ export class Settings {
   }
 
   public getOpenApiTitle(): string | undefined {
-    return this.config.openApiTitle;
+    return this.config.openApiTitle ?? this.config.title;
+  }
+
+  public getTitle(): string {
+    return this.config.title;
   }
 
   public getNamespace(): string | undefined {
@@ -80,4 +86,8 @@ export class Settings {
   public openApiFileName(): string {
     return this.config.openApiFileName;
   }
+
+  public includeMetadata(): boolean {
+    return this.config.includeMetadata;
+  }
 }

src/test-helpers/SettingsBuilder.ts

@@ -17,6 +17,8 @@ export class SettingsBuilder {
       sanitizeHtml: true,
       openApiTitle: 'Apex API',
       openApiFileName: 'openapi',
+      title: 'Classes',
+      includeMetadata: false,
     };
   }
 }