@cparra/apexdocs 2.19.0-alpha.3 → 2.19.0

package/README.md

@@ -25,14 +25,11 @@ There are some key differences between ApexDocs and the Java based ApexDoc tool:
   Markdown like Github Pages or Netlify, and use site generators like Jekyll or Gatsby. This gives you the freedom to
   decide how to style your site to match your needs.
 
-#### New features
-
-* All Apex annotations are now supported through the `--scope` CLI parameter, not just `namespaceaccessible`. This means
-  that scopes like `auraenabled`, `invocablemethod`, `invocablevariable`, `remoteaction`, and all other valid Apex
-  annotations are supported.
-* Just like Javadoc, both `@throws` and `@exception` are supported when referencing an exception thrown by a method or
-  constructor.
-* Any custom annotation defined in the Apexdoc is at the class level are supported, for example the following will be
+#### Features
+
+* Custom Annotations
+
+Any custom annotation defined in the Apexdoc is at the class level are supported, for example the following will be
   output to the resulting markdown file:
 
 ```apex
@@ -43,7 +40,7 @@ public class MyClass {
 }
 ```
 
-* Apex docs blocks can now all be in a single line
+* Single Line ApexDoc Blocks
 
 📒 Note: If you wish to have multiple `@` tags in a single line but don't want them to be treated as ApexDoc annotations, you can
 escape them by adding wrapping the annotation in ticks, for example
@@ -59,6 +56,7 @@ escape them by adding wrapping the annotation in ticks, for example
 * OpenApi REST specification generation
 * Support for ignoring files and members from being documented
 * Namespace support
+* Configuration file support
 * And much, much more!
 
 ### Demo
@@ -120,6 +118,44 @@ The CLI supports the following parameters:
 | --includeMetadata      | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                                                                                                                                                                                            | false           | No       |
 | --documentationRootDir | N/A   | The root directory where the documentation will be generated. This is useful when you want to generate the documentation in a subdirectory of your project.                                                                                                                                                                                                                 | N/A             | No       |
 
+### Using a configuration file
+
+You can also use a configuration file to define the parameters that will be used when generating the documentation. Apexdocs
+uses [cosmiconfig](https://www.npmjs.com/package/cosmiconfig) to load the configuration file, which means it supports
+the following formats:
+
+- A `package.json` property, e.g. `{ "apexdocs": { "sourceDir": "src", "targetDir": "docs" } }`
+- A `.apexdocsrc` file, written in YAML or JSON, with optional extensions: `.yaml/.yml/.json/.js`
+- An `apexdocs.config.js` file that exports an object
+- A `apexdocs.config.ts` file that exports an object
+
+The configuration file should be placed in the root directory of your project.
+
+**Note that when using a configuration file, you can still override any of the parameters by passing them through the CLI.**
+
+When defining a `.js` or `.ts` configuration file, your object export can also contain the following functions that will
+allow you to override some of the default behavior:
+
+- `onBeforeFileWrite` - A function that will be called before a file is written to disk. It receives a `TargetFile` object
+  that contains the file's content, path, and name, etc. It should return a `TargetFile` object with the updated content.
+  The full object definition can be imported from `@cparra/apexdocs/lib/settings`
+- `onAfterProcess` - A function that will be called after all files have been processed. It receives a `TargetFile[]` array
+  with all of the files that were processed and does not return anything.
+
+```typescript
+import {TargetFile} from "@cparra/apexdocs/lib/settings";
+export default {
+  onBeforeFileWrite: (file: TargetFile): TargetFile => {
+    console.log('onBefore writing', file);
+    return file;
+  },
+  onAfterProcess: (files: TargetFile[]) => {
+    console.log('onAfterProcess files', files);
+  },
+};
+
+```
+
 ### Importing to your project
 
 If you are just interested in the Apex parsing capabilities, you can use the

package/apexdocs.config.ts

@@ -1,17 +1,11 @@
-import * as path from 'path';
-
-type OutputDir = {
-  baseDir: string;
-  fileDir: string;
-};
+import { TargetFile } from './src/settings';
 
 export default {
-  onBeforeFileWrite: (dir: OutputDir, fileName: string) => {
-    console.log('onBefore writing', dir, fileName);
-    const defaultDir = path.join(dir.baseDir, dir.fileDir);
-    return { dir: defaultDir, fileName };
+  onBeforeFileWrite: (file: TargetFile): TargetFile => {
+    console.log('onBefore writing', file);
+    return file;
   },
-  onAfterProcess: (files: { dir: string; fileName: string }[]) => {
+  onAfterProcess: (files: TargetFile[]) => {
     console.log('onAfterProcess files', files);
   },
 };

package/lib/application/Apexdocs.js

@@ -30,12 +30,12 @@ class Apexdocs {
         const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
         transpiler_1.default.generate(filteredTypes, processor);
         const generatedFiles = processor.fileBuilder().files();
-        const generatedFilePaths = [];
+        const files = [];
         file_writer_1.FileWriter.write(generatedFiles, (file) => {
-            logger_1.Logger.logSingle(`${file.fileName} processed.`, false, 'green', false);
-            generatedFilePaths.push(file);
+            logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
+            files.push(file);
         });
-        settings_1.Settings.getInstance().onAfterProcess(generatedFilePaths);
+        settings_1.Settings.getInstance().onAfterProcess(files);
         // Error logging
         error_logger_1.default.logErrors(filteredTypes);
     }

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,kBAAkB,GAAwC,EAAE,CAAC;QACnE,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAuC,EAAE,EAAE;YAC3E,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACvE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAE1D,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/service/file-writer.d.ts

@@ -1,6 +1,6 @@
 import { OutputFile } from '../model/outputFile';
-import { TargetLocation } from '../settings';
+import { TargetFile } from '../settings';
 export declare class FileWriter {
-    static write(files: OutputFile[], onWriteCallback: (file: TargetLocation) => void): void;
+    static write(files: OutputFile[], onWriteCallback: (file: TargetFile) => void): void;
     private static getTargetLocation;
 }

package/lib/service/file-writer.js

@@ -6,23 +6,28 @@ const path = require("path");
 const settings_1 = require("../settings");
 class FileWriter {
     static write(files, onWriteCallback) {
-        const onBeforeFileWrite = (outputDir, fileName) => settings_1.Settings.getInstance().onBeforeFileWrite(outputDir, fileName);
+        const onBeforeFileWrite = (file) => settings_1.Settings.getInstance().onBeforeFileWrite(file);
         files.forEach((file) => {
-            const { dir: dirPath, fileName } = this.getTargetLocation(file, onBeforeFileWrite);
-            if (!fs.existsSync(dirPath)) {
-                fs.mkdirSync(dirPath, { recursive: true });
+            const resolvedFile = this.getTargetLocation(file, onBeforeFileWrite);
+            const fullDir = path.join(resolvedFile.dir.baseDir, resolvedFile.dir.fileDir);
+            if (!fs.existsSync(fullDir)) {
+                fs.mkdirSync(fullDir, { recursive: true });
             }
-            const filePath = path.join(dirPath, fileName);
+            const filePath = path.join(fullDir, `${resolvedFile.name}${resolvedFile.extension}`);
             fs.writeFileSync(filePath, file.body, 'utf8');
-            onWriteCallback({ dir: dirPath, fileName });
+            onWriteCallback(resolvedFile);
         });
     }
     static getTargetLocation(file, onBeforeFileWrite) {
-        const fileName = `${file.fileName}${file.fileExtension()}`;
-        return onBeforeFileWrite({
-            baseDir: settings_1.Settings.getInstance().outputDir,
-            fileDir: file.dir,
-        }, fileName);
+        const targetFile = {
+            name: file.fileName,
+            extension: file.fileExtension(),
+            dir: {
+                baseDir: settings_1.Settings.getInstance().outputDir,
+                fileDir: file.dir,
+            },
+        };
+        return onBeforeFileWrite(targetFile);
     }
 }
 exports.FileWriter = FileWriter;

package/lib/service/file-writer.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAqF;AAErF,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAmB,EAAE,eAA+C;QAC/E,MAAM,iBAAiB,GAAG,CAAC,SAAoB,EAAE,QAAgB,EAAE,EAAE,CACnE,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAChE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACnF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;aAC5C;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9C,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,eAAe,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAgB,EAAE,iBAAoC;QACrF,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QAC3D,OAAO,iBAAiB,CACtB;YACE,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS;YACzC,OAAO,EAAE,IAAI,CAAC,GAAG;SAClB,EACD,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AA1BD,gCA0BC"}
+{"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAsE;AAEtE,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAmB,EAAE,eAA2C;QAC3E,MAAM,iBAAiB,GAAsB,CAAC,IAAgB,EAAE,EAAE,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAClH,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACrE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;aAC5C;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC,IAAI,GAAG,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;YACrF,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,eAAe,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAgB,EAAE,iBAAoC;QACrF,MAAM,UAAU,GAAe;YAC7B,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,SAAS,EAAE,IAAI,CAAC,aAAa,EAAE;YAC/B,GAAG,EAAE;gBACH,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS;gBACzC,OAAO,EAAE,IAAI,CAAC,GAAG;aAClB;SACF,CAAC;QAEF,OAAO,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;CACF;AA5BD,gCA4BC"}

package/lib/settings.d.ts

@@ -1,8 +1,9 @@
 import { GeneratorChoices } from './transpiler/generator-choices';
-export type OnBeforeFileWrite = (outputDir: OutputDir, fileName: string) => TargetLocation;
-export type TargetLocation = {
-    dir: string;
-    fileName: string;
+export type OnBeforeFileWrite = (file: TargetFile) => TargetFile;
+export type TargetFile = {
+    name: string;
+    extension: string;
+    dir: OutputDir;
 };
 export type OutputDir = {
     baseDir: string;
@@ -23,14 +24,8 @@ export interface SettingsConfig {
     openApiFileName: string;
     includeMetadata: boolean;
     rootDir?: string;
-    onAfterProcess?: (files: {
-        dir: string;
-        fileName: string;
-    }[]) => void;
-    onBeforeFileWrite?: (outputDir: OutputDir, fileName: string) => {
-        dir: string;
-        fileName: string;
-    };
+    onAfterProcess?: (files: TargetFile[]) => void;
+    onBeforeFileWrite?: (file: TargetFile) => TargetFile;
 }
 export declare class Settings {
     config: SettingsConfig;
@@ -53,12 +48,6 @@ export declare class Settings {
     openApiFileName(): string;
     includeMetadata(): boolean;
     getRootDir(): string | undefined;
-    onAfterProcess(files: {
-        dir: string;
-        fileName: string;
-    }[]): void;
-    onBeforeFileWrite(outputDir: OutputDir, fileName: string): {
-        dir: string;
-        fileName: string;
-    };
+    onAfterProcess(files: TargetFile[]): void;
+    onBeforeFileWrite(file: TargetFile): TargetFile;
 }

package/lib/settings.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Settings = void 0;
-const path = require("path");
 class Settings {
     constructor(config) {
         this.config = config;
@@ -69,12 +68,11 @@ class Settings {
             this.config.onAfterProcess(files);
         }
     }
-    onBeforeFileWrite(outputDir, fileName) {
+    onBeforeFileWrite(file) {
         if (this.config.onBeforeFileWrite) {
-            return this.config.onBeforeFileWrite(outputDir, fileName);
+            return this.config.onBeforeFileWrite(file);
         }
-        const defaultDir = path.join(outputDir.baseDir, outputDir.fileDir);
-        return { dir: defaultDir, fileName };
+        return file;
     }
 }
 exports.Settings = Settings;

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,6BAA6B;AAiC7B,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,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,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAA0C;QAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,SAAoB,EAAE,QAAgB;QAC7D,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;SAC3D;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACnE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvC,CAAC;CACF;AA5FD,4BA4FC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAkCA,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,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,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA3FD,4BA2FC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.19.0-alpha.3",
+  "version": "2.19.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",

package/src/application/Apexdocs.ts

@@ -4,7 +4,7 @@ import { ReflectionResult, reflect, Type } from '@cparra/apex-reflection';
 import { Logger } from '../util/logger';
 import { createManifest } from '../service/manifest-factory';
 import { RawBodyParser } from '../service/parser';
-import { Settings } from '../settings';
+import { Settings, TargetFile } from '../settings';
 import Transpiler from '../transpiler/transpiler';
 import { FileWriter } from '../service/file-writer';
 import ErrorLogger from '../util/error-logger';
@@ -31,13 +31,13 @@ export class Apexdocs {
     Transpiler.generate(filteredTypes, processor);
     const generatedFiles = processor.fileBuilder().files();
 
-    const generatedFilePaths: { dir: string; fileName: string }[] = [];
-    FileWriter.write(generatedFiles, (file: { dir: string; fileName: string }) => {
-      Logger.logSingle(`${file.fileName} processed.`, false, 'green', false);
-      generatedFilePaths.push(file);
+    const files: TargetFile[] = [];
+    FileWriter.write(generatedFiles, (file: TargetFile) => {
+      Logger.logSingle(`${file.name} processed.`, false, 'green', false);
+      files.push(file);
     });
 
-    Settings.getInstance().onAfterProcess(generatedFilePaths);
+    Settings.getInstance().onAfterProcess(files);
 
     // Error logging
     ErrorLogger.logErrors(filteredTypes);

package/src/service/file-writer.ts

@@ -1,32 +1,34 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { OutputFile } from '../model/outputFile';
-import { OnBeforeFileWrite, OutputDir, Settings, TargetLocation } from '../settings';
+import { OnBeforeFileWrite, Settings, TargetFile } from '../settings';
 
 export class FileWriter {
-  static write(files: OutputFile[], onWriteCallback: (file: TargetLocation) => void) {
-    const onBeforeFileWrite = (outputDir: OutputDir, fileName: string) =>
-      Settings.getInstance().onBeforeFileWrite(outputDir, fileName);
+  static write(files: OutputFile[], onWriteCallback: (file: TargetFile) => void) {
+    const onBeforeFileWrite: OnBeforeFileWrite = (file: TargetFile) => Settings.getInstance().onBeforeFileWrite(file);
     files.forEach((file) => {
-      const { dir: dirPath, fileName } = this.getTargetLocation(file, onBeforeFileWrite);
-      if (!fs.existsSync(dirPath)) {
-        fs.mkdirSync(dirPath, { recursive: true });
+      const resolvedFile = this.getTargetLocation(file, onBeforeFileWrite);
+      const fullDir = path.join(resolvedFile.dir.baseDir, resolvedFile.dir.fileDir);
+      if (!fs.existsSync(fullDir)) {
+        fs.mkdirSync(fullDir, { recursive: true });
       }
 
-      const filePath = path.join(dirPath, fileName);
+      const filePath = path.join(fullDir, `${resolvedFile.name}${resolvedFile.extension}`);
       fs.writeFileSync(filePath, file.body, 'utf8');
-      onWriteCallback({ dir: dirPath, fileName });
+      onWriteCallback(resolvedFile);
     });
   }
 
-  private static getTargetLocation(file: OutputFile, onBeforeFileWrite: OnBeforeFileWrite): TargetLocation {
-    const fileName = `${file.fileName}${file.fileExtension()}`;
-    return onBeforeFileWrite(
-      {
+  private static getTargetLocation(file: OutputFile, onBeforeFileWrite: OnBeforeFileWrite): TargetFile {
+    const targetFile: TargetFile = {
+      name: file.fileName,
+      extension: file.fileExtension(),
+      dir: {
         baseDir: Settings.getInstance().outputDir,
         fileDir: file.dir,
       },
-      fileName,
-    );
+    };
+
+    return onBeforeFileWrite(targetFile);
   }
 }

package/src/settings.ts

@@ -1,11 +1,11 @@
 import { GeneratorChoices } from './transpiler/generator-choices';
-import * as path from 'path';
 
-export type OnBeforeFileWrite = (outputDir: OutputDir, fileName: string) => TargetLocation;
+export type OnBeforeFileWrite = (file: TargetFile) => TargetFile;
 
-export type TargetLocation = {
-  dir: string;
-  fileName: string;
+export type TargetFile = {
+  name: string;
+  extension: string;
+  dir: OutputDir;
 };
 
 export type OutputDir = {
@@ -28,8 +28,8 @@ export interface SettingsConfig {
   openApiFileName: string;
   includeMetadata: boolean;
   rootDir?: string;
-  onAfterProcess?: (files: { dir: string; fileName: string }[]) => void;
-  onBeforeFileWrite?: (outputDir: OutputDir, fileName: string) => { dir: string; fileName: string };
+  onAfterProcess?: (files: TargetFile[]) => void;
+  onBeforeFileWrite?: (file: TargetFile) => TargetFile;
 }
 
 export class Settings {
@@ -111,17 +111,16 @@ export class Settings {
     return this.config.rootDir;
   }
 
-  public onAfterProcess(files: { dir: string; fileName: string }[]) {
+  public onAfterProcess(files: TargetFile[]): void {
     if (this.config.onAfterProcess) {
       this.config.onAfterProcess(files);
     }
   }
 
-  public onBeforeFileWrite(outputDir: OutputDir, fileName: string): { dir: string; fileName: string } {
+  public onBeforeFileWrite(file: TargetFile): TargetFile {
     if (this.config.onBeforeFileWrite) {
-      return this.config.onBeforeFileWrite(outputDir, fileName);
+      return this.config.onBeforeFileWrite(file);
     }
-    const defaultDir = path.join(outputDir.baseDir, outputDir.fileDir);
-    return { dir: defaultDir, fileName };
+    return file;
   }
 }